| Operation |
Public
Bound (key: byte[],
value: byte[],
entity: object?,
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
BeforeGet (key: byte[],
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
AfterGet (key: byte[],
value: byte[],
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
BeforeFind (begin: byte[],
end: byte[],
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
AfterFind (begin: byte[],
end: byte[],
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
OnBind () : Bound?
|
Details:
|
Notes:
|
Event to capture Bind Events<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
OnBeforeGet () : BeforeGet?
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
OnAfterGet () : AfterGet?
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
OnBeforeFind () : BeforeFind?
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
OnAfterFind () : AfterFind?
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Protected
RaiseOnBind (key: byte[],
value: byte[],
entity: object?,
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Protected
RaiseOnBeforeGet (key: byte[],
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Protected
RaiseOnAfterGet (key: byte[],
value: byte[],
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Protected
RaiseOnBeforeFind (key: byte[],
value: byte[],
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Protected
RaiseOnAfterFind (key: byte[],
value: byte[],
) : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
HiperSpace () :
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Bind (key: byte[],
value: byte[],
source: object?,
) : Result<byte[]>
|
Details:
|
Notes:
|
Bind a key/value pair to the space, passing in the source object, if the driver can use additional metadata (e.g. EFCore)<br/><br/>@returns a result struct that indicates success, ignore, or fail<br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
Bind (key: byte[],
value: byte[],
version: DateTime,
source: object?,
) : Result<byte[]>
|
Details:
|
Notes:
|
Bind a key/value pair to the space, passing in the source object, if the driver can use additional metadata (e.g. EFCore)<br/><br/>@returns a result struct that indicates success, ignore, or fail<br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
BindAsync (key: byte[],
value: byte[],
source: object?,
) : Task<Result<byte[]>>
|
Details:
|
Notes:
|
Bind a key/value pair to the space asyncronously, passing in the source object, if the driver can use additional metadata (e.g. EFCore)<br/><br/>@returns a result struct that indicates success, ignore, or fail<br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
BindAsync (key: byte[],
value: byte[],
version: DateTime,
source: object?,
) : Task<Result<byte[]>>
|
Details:
|
Notes:
|
Bind a key/value pair to the space asyncronously, passing in the source object, if the driver can use additional metadata (e.g. EFCore)<br/><br/>@returns a result struct that indicates success, ignore, or fail<br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
BatchBind (batch: (byte[] key, byte[] value, object? source)[],
) : Result<(byte[] Key, byte[] Value)>
|
Details:
|
Notes:
|
Bind a batch of values for server single trip<br/><br/>@returns array of results<br/>
|
[ Is static False. Is abstract False. Is return array True. Is query False. Is synchronized False. ]
|
Public
BatchBind (batch: (byte[] key, byte[] value, DateTime version, object? source)[],
) : Result<(byte[] Key, byte[] Value)>
|
Details:
|
Notes:
|
Bind a batch of values for server single trip<br/><br/>@returns array of results<br/>
|
[ Is static False. Is abstract False. Is return array True. Is query False. Is synchronized False. ]
|
Public
BatchBindAsync (batch: (byte[] key, byte[] value, object? source)[],
) : Task<Result<(byte[] Key, byte[] Value)>[]>
|
Details:
|
Notes:
|
Bind a batch of values for server single trip async<br/><br/>@returns array of results<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
BatchBindAsync (batch: (byte[] key, byte[] value, DateTime version, object? source)[],
) : Task<Result<(byte[] Key, byte[] Value)>[]>
|
Details:
|
Notes:
|
Bind a batch of values for server single trip async<br/><br/>@returns array of results<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Space () : IEnumerable<(byte[] Key, byte[] Value)>
|
Details:
|
Notes:
|
Enumeration of raw values for transfer<br/><br/>@returns content of space<br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
SpaceAsync () : Task<IEnumerable<(byte[] Key, byte[] Value)>>
|
Details:
|
Notes:
|
Async Enumeration of raw values for transfer<br/><br/>@returns content of space<br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
Find (begin: byte[],
end: byte[],
) : IEnumerable<(byte[] Key, byte[] Value)>
|
Details:
|
Notes:
|
Find all values of space between the key values<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
Find (begin: byte[],
end: byte[],
version: DateTime?,
) : IEnumerable<(byte[] Key, DateTime AsAt, byte[] Value)>
|
Details:
|
Notes:
|
Find all values of space between the key values<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
FindAsync (begin: byte[],
end: byte[],
) : Task<IEnumerable<(byte[] Key, byte[] Value)>>
|
Details:
|
Notes:
|
Find all values of space between the key values asyncronously<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
FindAsync (begin: byte[],
end: byte[],
version: DateTime?,
) : Task<IEnumerable<(byte[] Key, DateTime AsAt, byte[] Value)>>
|
Details:
|
Notes:
|
Find all values of space between the key values asyncronously<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
Delta (key: byte[],
version: DateTime?,
) : IEnumerable<(byte[] Key, DateTime AsAt, byte[] Value)>
|
Details:
|
Notes:
|
Find keys in a delta index that are greater than the value provided<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
DeltaAsync (begin: byte[],
version: DateTime?,
) : Task<IEnumerable<(byte[] Key, DateTime AsAt, byte[] Value)>>
|
Details:
|
Notes:
|
Find keys in a delta index that are greater than the value provided asyncronously<br/><br/>@param ="key" the start value for delta search<br/>@param ="end" <br/>@returns <br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
FindIndex (begin: byte[],
end: byte[],
) : IEnumerable<(byte[] Key, byte[] Value)>
|
Details:
|
Notes:
|
Find all values of space for index values between the index values<br/><br/>@param ="entityId" the proto id of key field<br/>@returns <br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
FindIndex (begin: byte[],
end: byte[],
version: DateTime?,
) : IEnumerable<(byte[] Key, DateTime AsAt, byte[] Value)>
|
Details:
|
Notes:
|
Find all values of space for index values between the index values<br/><br/>@returns <br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
FindDelta (begin: byte[],
version: DateTime?,
DeltaFrom: DateTime?,
) : IEnumerable<(byte[] Key, DateTime AsAt, byte[] Value)>
|
Details:
|
Notes:
|
Find all values of space for index values between the index values<br/><br/>@param ="end" <br/>@returns <br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
FindIndexAsync (begin: byte[],
end: byte[],
) : Task<IEnumerable<(byte[] Key, byte[] Value)>>
|
Details:
|
Notes:
|
Find all values of space for index values between the index values asyncronously<br/><br/>@returns <br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
FindIndexAsync (begin: byte[],
end: byte[],
version: DateTime?,
) : Task<IEnumerable<(byte[] Key, DateTime AsAt, byte[] Value)>>
|
Details:
|
Notes:
|
Find all values of space for index values between the index values asyncronously<br/><br/>@returns <br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Nearest (begin: byte[],
end: byte[],
version: DateTime?,
space: Vector,
method: Vector.Method,
limit: int,
) : IEnumerable<(byte[] Key, DateTime AsAt, byte[] Value, double Distance)>
|
Details:
|
Notes:
|
Find all values of space for similarity match for AI queries<br/><br/>@param ="key" <br/>@param ="vector" <br/>@returns <br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
NearestAsync (begin: byte[],
end: byte[],
version: DateTime?,
space: Vector,
method: Vector.Method,
limit: int,
) : Task<IEnumerable<(byte[] Key, DateTime AsAt, byte[] Value, double Distance)>>
|
Details:
|
Notes:
|
Find all values of space for index values between the index values asyncronously<br/><br/>@param ="key" <br/>@param ="vector" <br/>@returns <br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Get (key: byte[],
) : byte
|
Details:
|
Notes:
|
Get a single unique value from space<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array True. Is query False. Is synchronized False. ]
|
Public
Get (key: byte[],
version: DateTime?,
) : (byte[] Value, DateTime version)
|
Details:
|
Notes:
|
Get a single unique value from space<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
GetAsync (key: byte[],
) : Task<byte[]>
|
Details:
|
Notes:
|
Get a single unique value from space<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
GetAsync (key: byte[],
version: DateTime?,
) : Task<(byte[] Value, DateTime version)>
|
Details:
|
Notes:
|
Get a single unique value from space<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
GetVersions (key: byte[],
) : IEnumerable<(byte[] value, DateTime version)>
|
Details:
|
Notes:
|
Get the version history for a key item<br/><br/>@param ="version" version stamp or null for latest<br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
GetVersionsAsync (key: byte[],
) : Task<IEnumerable<(byte[] value, DateTime version)>>
|
Details:
|
Notes:
|
Get the version history for a key item async<br/><br/>@returns <br/>
|
[ Is static False. Is abstract True. Is return array False. Is query False. Is synchronized False. ]
|
Public
Zip (stream: Stream,
level: CompressionLevel,
) : void
|
Details:
|
Notes:
|
Transfer the entire content of the space to a zip stream<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
ZipAsync (stream: Stream,
level: CompressionLevel,
) : Task
|
Details:
|
Notes:
|
Transfer the entire content of the space to a zip stream async<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Unzip (stream: Stream,
) : void
|
Details:
|
Notes:
|
populate the space with the content of zip stream<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
UnzipAsync (stream: Stream,
) : Task
|
Details:
|
Notes:
|
populate the space with the content of zip stream async<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Protected
Dispose (disposing: bool,
) : void
|
Details:
|
Notes:
|
release all resources<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Private
~HiperSpace () :
|
Details:
|
Notes:
|
TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources<br/>
|
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
Public
Dispose () : void
|
Details:
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
|
