Name | Description | |
---|---|---|
![]() | Add(WritePolicy, Key, Bin ) |
Add integer bin values to existing record bin values.
The policy specifies the transaction timeout, record expiration and how the transaction is
handled when the record already exists.
This call only works for integer values.
(Inherited from AerospikeClient.) |
![]() | Add(WritePolicy, WriteListener, Key, Bin ) |
Asynchronously add integer bin values to existing record bin values.
Schedule the add command with a channel selector and return.
Another thread will process the command and send the results to the listener.
The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. This call only works for integer values. |
![]() | Add(WritePolicy, CancellationToken, Key, Bin ) |
Asynchronously add integer bin values to existing record bin values.
Create listener, call asynchronous add and return task monitor.
The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. This call only works for integer values. |
![]() | Append(WritePolicy, Key, Bin ) |
Append bin string values to existing record bin values.
The policy specifies the transaction timeout, record expiration and how the transaction is
handled when the record already exists.
This call only works for string values.
(Inherited from AerospikeClient.) |
![]() | Append(WritePolicy, WriteListener, Key, Bin ) |
Asynchronously append bin string values to existing record bin values.
Schedule the append command with a channel selector and return.
Another thread will process the command and send the results to the listener.
The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. This call only works for string values. |
![]() | Append(WritePolicy, CancellationToken, Key, Bin ) |
Asynchronously append bin string values to existing record bin values.
Create listener, call asynchronous append and return task monitor.
The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. This call only works for string values. |
![]() | ChangePassword |
Change user's password. Clear-text password will be hashed using bcrypt
before sending to server.
(Inherited from AerospikeClient.) |
![]() | Close |
Close all client connections to database server nodes.
(Inherited from AerospikeClient.) |
![]() | CreateIndex(Policy, String, String, String, String, IndexType) |
Create scalar secondary index.
This asynchronous server call will return before command is complete.
The user can optionally wait for command completion by using the returned
IndexTask instance.
(Inherited from AerospikeClient.) |
![]() | CreateIndex(Policy, String, String, String, String, IndexType, IndexCollectionType) |
Create complex secondary index on bins containing collections.
This asynchronous server call will return before command is complete.
The user can optionally wait for command completion by using the returned
IndexTask instance.
(Inherited from AerospikeClient.) |
![]() | CreateRole |
Create user defined role.
(Inherited from AerospikeClient.) |
![]() | CreateUser |
Create user with password and roles. Clear-text password will be hashed using bcrypt
before sending to server.
(Inherited from AerospikeClient.) |
![]() | Delete(WritePolicy, Key) |
Delete record for specified key.
Return whether record existed on server before deletion.
The policy specifies the transaction timeout.
(Inherited from AerospikeClient.) |
![]() | Delete(WritePolicy, DeleteListener, Key) |
Asynchronously delete record for specified key.
Schedule the delete command with a channel selector and return.
Another thread will process the command and send the results to the listener.
The policy specifies the transaction timeout. |
![]() | Delete(WritePolicy, CancellationToken, Key) |
Asynchronously delete record for specified key.
Create listener, call asynchronous delete and return task monitor.
The policy specifies the transaction timeout. |
![]() | Dispose |
Close all client connections to database server nodes.
(Inherited from AerospikeClient.) |
![]() | DropIndex |
Delete secondary index.
(Inherited from AerospikeClient.) |
![]() | DropRole |
Drop user defined role.
(Inherited from AerospikeClient.) |
![]() | DropUser |
Remove user from cluster.
(Inherited from AerospikeClient.) |
![]() | Execute(WritePolicy, Key, String, String, Value ) |
Execute user defined function on server and return results.
The function operates on a single record.
The package name is used to locate the udf file location:
(Inherited from AerospikeClient.)udf file = <server udf dir>/<package name>.lua |
![]() | Execute(WritePolicy, Statement, String, String, Value ) |
Apply user defined function on records that match the statement filter.
Records are not returned to the client.
This asynchronous server call will return before command is complete.
The user can optionally wait for command completion by using the returned
ExecuteTask instance.
(Inherited from AerospikeClient.) |
![]() | Execute(WritePolicy, ExecuteListener, Key, String, String, Value ) |
Asynchronously execute user defined function on server and return result.
The function operates on a single record.
The package name is used to locate the udf file location on the server:
udf file = <server udf dir>/<package name>.lua This method schedules the execute command with a channel selector and returns. Another thread will process the command and send the results to the listener. |
![]() | Execute(WritePolicy, CancellationToken, Key, String, String, Value ) |
Asynchronously execute user defined function on server for a single record and return result.
Create listener, call asynchronous execute and return task monitor.
|
![]() | Exists(BatchPolicy, Key ) |
Check if multiple record keys exist in one batch call.
The returned boolean array is in positional order with the original key array order.
The policy can be used to specify timeouts and maximum concurrent threads.
(Inherited from AerospikeClient.) |
![]() | Exists(Policy, Key) |
Determine if a record key exists.
Return whether record exists or not.
The policy can be used to specify timeouts.
(Inherited from AerospikeClient.) |
![]() | Exists(BatchPolicy, ExistsArrayListener, Key ) |
Asynchronously check if multiple record keys exist in one batch call.
Schedule the array exists command with a channel selector and return.
Another thread will process the command and send the results to the listener in a single call.
The policy can be used to specify timeouts. |
![]() | Exists(BatchPolicy, ExistsSequenceListener, Key ) |
Asynchronously check if multiple record keys exist in one batch call.
Schedule the exists command with a channel selector and return.
Another thread will process the command and send the results to the listener in multiple unordered calls.
The policy can be used to specify timeouts. |
![]() | Exists(BatchPolicy, CancellationToken, Key ) |
Asynchronously check if multiple record keys exist in one batch call.
Create listener, call asynchronous array exists and return task monitor.
The policy can be used to specify timeouts. |
![]() | Exists(Policy, ExistsListener, Key) |
Asynchronously determine if a record key exists.
Schedule the exists command with a channel selector and return.
Another thread will process the command and send the results to the listener.
The policy can be used to specify timeouts. |
![]() | Exists(Policy, CancellationToken, Key) |
Asynchronously determine if a record key exists.
Create listener, call asynchronous exists and return task monitor.
The policy can be used to specify timeouts. |
![]() | Get(BatchPolicy, Key ) |
Read multiple records for specified keys in one batch call.
The returned records are in positional order with the original key array order.
If a key is not found, the positional record will be null.
The policy can be used to specify timeouts and maximum concurrent threads.
(Inherited from AerospikeClient.) |
![]() | Get(BatchPolicy, List BatchRead ) |
Read multiple records for specified batch keys in one batch call.
This method allows different namespaces/bins to be requested for each key in the batch.
The returned records are located in the same list.
If the BatchRecord key field is not found, the corresponding record field will be null.
The policy can be used to specify timeouts and maximum concurrent threads.
This method requires Aerospike Server version >= 3.6.0.
(Inherited from AerospikeClient.) |
![]() | Get(Policy, Key) |
Read entire record for specified key.
If found, return record instance. If not found, return null.
The policy can be used to specify timeouts.
(Inherited from AerospikeClient.) |
![]() | Get(BatchPolicy, Key , String ) |
Read multiple record headers and bins for specified keys in one batch call.
The returned records are in positional order with the original key array order.
If a key is not found, the positional record will be null.
The policy can be used to specify timeouts and maximum concurrent threads.
(Inherited from AerospikeClient.) |
![]() | Get(BatchPolicy, BatchListListener, List BatchRead ) |
Asynchronously read multiple records for specified batch keys in one batch call.
This method allows different namespaces/bins to be requested for each key in the batch.
The returned records are located in the same list.
If the BatchRecord key field is not found, the corresponding record field will be null.
This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in a single call. This method requires Aerospike Server version >= 3.6.0. |
![]() | Get(BatchPolicy, BatchSequenceListener, List BatchRead ) |
Asynchronously read multiple records for specified batch keys in one batch call.
This method allows different namespaces/bins to be requested for each key in the batch.
The returned records are located in the same list.
If the BatchRecord key field is not found, the corresponding record field will be null.
This method schedules the get command with a channel selector and returns. Another thread will process the command and send the results to the listener in a single call. This method requires Aerospike Server version >= 3.6.0. |
![]() | Get(BatchPolicy, RecordArrayListener, Key ) |
Asynchronously read multiple records for specified keys in one batch call.
Schedule the batch get command with a channel selector and return.
Another thread will process the command and send the results to the listener in a single call.
If a key is not found, the record will be null. The policy can be used to specify timeouts. |
![]() | Get(BatchPolicy, RecordSequenceListener, Key ) |
Asynchronously read multiple records for specified keys in one batch call.
Schedule the get command with a channel selector and return.
Another thread will process the command and send the results to the listener in multiple unordered calls.
If a key is not found, the record will be null. The policy can be used to specify timeouts. |
![]() | Get(BatchPolicy, CancellationToken, Key ) |
Asynchronously read multiple records for specified keys in one batch call.
Create listener, call asynchronous batch get and return task monitor.
If a key is not found, the record will be null. The policy can be used to specify timeouts. |
![]() | Get(BatchPolicy, CancellationToken, List BatchRead ) |
Asynchronously read multiple records for specified batch keys in one batch call.
This method allows different namespaces/bins to be requested for each key in the batch.
The returned records are located in the same list.
Create listener, call asynchronous batch get and return task monitor. This method requires Aerospike Server version >= 3.6.0. |
![]() | Get(Policy, Key, String ) |
Read record header and bins for specified key.
If found, return record instance. If not found, return null.
The policy can be used to specify timeouts.
(Inherited from AerospikeClient.) |
![]() | Get(Policy, RecordListener, Key) |
Asynchronously read entire record for specified key.
Schedule the get command with a channel selector and return.
Another thread will process the command and send the results to the listener.
The policy can be used to specify timeouts. |
![]() | Get(Policy, CancellationToken, Key) |
Asynchronously read entire record for specified key.
Create listener, call asynchronous get and return task monitor.
The policy can be used to specify timeouts. |
![]() | Get(BatchPolicy, RecordArrayListener, Key , String ) |
Asynchronously read multiple record headers and bins for specified keys in one batch call.
Schedule the batch get command with a channel selector and return.
Another thread will process the command and send the results to the listener in a single call.
If a key is not found, the record will be null. The policy can be used to specify timeouts. |
![]() | Get(BatchPolicy, RecordSequenceListener, Key , String ) |
Asynchronously read multiple record headers and bins for specified keys in one batch call.
Schedule the batch get command with a channel selector and return.
Another thread will process the command and send the results to the listener in multiple unordered calls.
If a key is not found, the record will be null. The policy can be used to specify timeouts. |
![]() | Get(BatchPolicy, CancellationToken, Key , String ) |
Asynchronously read multiple record headers and bins for specified keys in one batch call.
Create listener, call asynchronous batch get and return task monitor.
If a key is not found, the record will be null. The policy can be used to specify timeouts. |
![]() | Get(Policy, RecordListener, Key, String ) |
Asynchronously read record header and bins for specified key.
Schedule the get command with a channel selector and return.
Another thread will process the command and send the results to the listener.
The policy can be used to specify timeouts. |
![]() | Get(Policy, CancellationToken, Key, String ) |
Asynchronously read record header and bins for specified key.
Create listener, call asynchronous get and return task monitor.
The policy can be used to specify timeouts. |
![]() | GetHeader(BatchPolicy, Key ) |
Read multiple record header data for specified keys in one batch call.
The returned records are in positional order with the original key array order.
If a key is not found, the positional record will be null.
The policy can be used to specify timeouts and maximum concurrent threads.
(Inherited from AerospikeClient.) |
![]() | GetHeader(Policy, Key) |
Read record generation and expiration only for specified key. Bins are not read.
If found, return record instance. If not found, return null.
The policy can be used to specify timeouts.
(Inherited from AerospikeClient.) |
![]() | GetHeader(BatchPolicy, RecordArrayListener, Key ) |
Asynchronously read multiple record header data for specified keys in one batch call.
Schedule the batch get header command with a channel selector and return.
Another thread will process the command and send the results to the listener in a single call.
If a key is not found, the record will be null. The policy can be used to specify timeouts. |
![]() | GetHeader(BatchPolicy, RecordSequenceListener, Key ) |
Asynchronously read multiple record header data for specified keys in one batch call.
Schedule the batch get header command with a channel selector and return.
Another thread will process the command and send the results to the listener in multiple unordered calls.
If a key is not found, the record will be null. The policy can be used to specify timeouts. |
![]() | GetHeader(BatchPolicy, CancellationToken, Key ) |
Asynchronously read multiple record header data for specified keys in one batch call.
Create listener, call asynchronous batch header get and return task monitor.
If a key is not found, the record will be null. The policy can be used to specify timeouts. |
![]() | GetHeader(Policy, RecordListener, Key) |
Asynchronously read record generation and expiration only for specified key. Bins are not read.
Schedule the get command with a channel selector and return.
Another thread will process the command and send the results to the listener.
The policy can be used to specify timeouts. |
![]() | GetHeader(Policy, CancellationToken, Key) |
Asynchronously read record generation and expiration only for specified key. Bins are not read.
Create listener, call asynchronous get header and return task monitor.
The policy can be used to specify timeouts. |
![]() | GetLargeList |
Initialize large list operator. This operator can be used to create and manage a list
within a single bin.
(Inherited from AerospikeClient.) |
![]() | GetLargeMap |
Initialize large map operator. This operator can be used to create and manage a map
within a single bin.
(Inherited from AerospikeClient.) |
![]() | GetLargeSet |
Initialize large set operator. This operator can be used to create and manage a set
within a single bin.
(Inherited from AerospikeClient.) |
![]() | GetLargeStack |
Initialize large stack operator. This operator can be used to create and manage a stack
within a single bin.
(Inherited from AerospikeClient.) |
![]() | GrantPrivileges |
Grant privileges to an user defined role.
(Inherited from AerospikeClient.) |
![]() | GrantRoles |
Add roles to user's list of roles.
(Inherited from AerospikeClient.) |
![]() | Join(BatchPolicy, Key, Join ) |
Read all bins in left record and then join with right records. Each join bin name
(Join.binNameKeys) must exist in the left record. The join bin must contain a list of
keys. Those key are used to retrieve other records using a separate batch get.
(Inherited from AerospikeClient.) |
![]() | Join(BatchPolicy, Key, String , Join ) |
Read specified bins in left record and then join with right records. Each join bin name
(Join.leftKeysBinName) must exist in the left record. The join bin must contain a list of
keys. Those key are used to retrieve other records using a separate batch get.
(Inherited from AerospikeClient.) |
![]() | Operate(WritePolicy, Key, Operation ) |
Perform multiple read/write operations on a single key in one batch call.
A record will be returned if there is a read in the operations list.
An example would be to add an integer value to an existing record and then
read the result, all in one database call.
(Inherited from AerospikeClient.)Write operations are always performed first, regardless of operation order relative to read operations. Both scalar bin operations (Operation) and list bin operations (ListOperation) can be performed in same call. |
![]() | Operate(WritePolicy, RecordListener, Key, Operation ) |
Asynchronously perform multiple read/write operations on a single key in one batch call.
Schedule the operate command with a channel selector and return.
Another thread will process the command and send the results to the listener.
An example would be to add an integer value to an existing record and then read the result, all in one database call. |
![]() | Operate(WritePolicy, CancellationToken, Key, Operation ) |
Asynchronously perform multiple read/write operations on a single key in one batch call.
Create listener, call asynchronous operate and return task monitor.
An example would be to add an integer value to an existing record and then read the result, all in one database call. Both scalar bin operations (Operation) and list bin operations (ListOperation) can be performed in same call. |
![]() | Prepend(WritePolicy, Key, Bin ) |
Prepend bin string values to existing record bin values.
The policy specifies the transaction timeout, record expiration and how the transaction is
handled when the record already exists.
This call works only for string values.
(Inherited from AerospikeClient.) |
![]() | Prepend(WritePolicy, WriteListener, Key, Bin ) |
Asynchronously prepend bin string values to existing record bin values.
Schedule the prepend command with a channel selector and return.
Another thread will process the command and send the results to the listener.
The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. This call works only for string values. |
![]() | Prepend(WritePolicy, CancellationToken, Key, Bin ) |
Asynchronously prepend bin string values to existing record bin values.
Create listener, call asynchronous prepend and return task monitor.
The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. This call works only for string values. |
![]() | Put(WritePolicy, Key, Bin ) |
Write record bin(s).
The policy specifies the transaction timeout, record expiration and how the transaction is
handled when the record already exists.
(Inherited from AerospikeClient.) |
![]() | Put(WritePolicy, WriteListener, Key, Bin ) |
Asynchronously write record bin(s).
Schedules the put command with a channel selector and return.
Another thread will process the command and send the results to the listener.
The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. |
![]() | Put(WritePolicy, CancellationToken, Key, Bin ) |
Asynchronously write record bin(s).
Create listener, call asynchronous put and return task monitor.
The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists. |
![]() | Query(QueryPolicy, Statement) |
Execute query and return record iterator. The query executor puts records on a queue in
separate threads. The calling thread concurrently pops records off the queue through the
record iterator.
(Inherited from AerospikeClient.) |
![]() | Query(QueryPolicy, Statement, Action Key, Record ) |
Execute query and call action for each record returned from server.
(Inherited from AerospikeClient.) |
![]() | Query(QueryPolicy, RecordSequenceListener, Statement) |
Asynchronously execute query on all server nodes. The query policy's
maxConcurrentNodes This method schedules the node's query commands with channel selectors and returns. Selector threads will process the commands and send the results to the listener. |
![]() | QueryAggregate(QueryPolicy, Statement) |
Execute query, apply statement's aggregation function, and return result iterator.
The aggregation function should be initialized via the statement's SetAggregateFunction()
and should be located in a Lua resource file located in an assembly.
(Inherited from AerospikeClient.)The query executor puts results on a queue in separate threads. The calling thread concurrently pops results off the queue through the ResultSet iterator. The aggregation function is called on both server and client (final reduce). Therefore, the Lua script file must also reside on both server and client. |
![]() | QueryAggregate(QueryPolicy, Statement, Action Object ) |
Execute query, apply statement's aggregation function, call action for each aggregation
object returned from server.
(Inherited from AerospikeClient.) |
![]() | QueryAggregate(QueryPolicy, Statement, String, String, Value ) |
Execute query, apply statement's aggregation function, and return result iterator.
The aggregation function should be located in a Lua script file that can be found from the
"LuaConfig.PackagePath" paths static variable. The default package path is "udf/?.lua"
where "?" is the packageName.
(Inherited from AerospikeClient.)The query executor puts results on a queue in separate threads. The calling thread concurrently pops results off the queue through the ResultSet iterator. The aggregation function is called on both server and client (final reduce). Therefore, the Lua script file must also reside on both server and client. |
![]() | QueryRole |
Retrieve role definition.
(Inherited from AerospikeClient.) |
![]() | QueryRoles |
Retrieve all roles.
(Inherited from AerospikeClient.) |
![]() | QueryUser |
Retrieve roles for a given user.
(Inherited from AerospikeClient.) |
![]() | QueryUsers |
Retrieve all users and their roles.
(Inherited from AerospikeClient.) |
![]() | Register(Policy, String, String, Language) |
Register package located in a file containing user defined functions with server.
This asynchronous server call will return before command is complete.
The user can optionally wait for command completion by using the returned
RegisterTask instance.
(Inherited from AerospikeClient.) |
![]() | Register(Policy, Assembly, String, String, Language) |
Register package located in a resource containing user defined functions with server.
This asynchronous server call will return before command is complete.
The user can optionally wait for command completion by using the returned
RegisterTask instance.
(Inherited from AerospikeClient.) |
![]() | RegisterUdfString |
Register UDF functions located in a code string with server. Example:
(Inherited from AerospikeClient.)String code = @" local function reducer(val1,val2) return val1 + val2 end function sum_single_bin(stream,name) local function mapper(rec) return rec[name] end return stream : map(mapper) : reduce(reducer) end "; client.RegisterUdfString(null, code, "mysum.lua", Language.LUA); This asynchronous server call will return before command is complete. The user can optionally wait for command completion by using the returned RegisterTask instance. |
![]() | RemoveUdf |
Remove user defined function from server nodes.
(Inherited from AerospikeClient.) |
![]() | RevokePrivileges |
Revoke privileges from an user defined role.
(Inherited from AerospikeClient.) |
![]() | RevokeRoles |
Remove roles from user's list of roles.
(Inherited from AerospikeClient.) |
![]() | ScanAll(ScanPolicy, String, String, ScanCallback, String ) |
Read all records in specified namespace and set. If the policy's
concurrentNodes is specified, each server node will be read in
parallel. Otherwise, server nodes are read in series.
(Inherited from AerospikeClient.)This call will block until the scan is complete - callbacks are made within the scope of this call. |
![]() | ScanAll(ScanPolicy, RecordSequenceListener, String, String, String ) |
Asynchronously read all records in specified namespace and set. If the policy's
concurrentNodes is specified, each server node will be read in
parallel. Otherwise, server nodes are read in series.
This method schedules the scan command with a channel selector and returns. Another thread will process the command and send the results to the listener. |
![]() | ScanNode(ScanPolicy, Node, String, String, ScanCallback, String ) |
Read all records in specified namespace and set for one node only.
(Inherited from AerospikeClient.)This call will block until the scan is complete - callbacks are made within the scope of this call. |
![]() | ScanNode(ScanPolicy, String, String, String, ScanCallback, String ) |
Read all records in specified namespace and set for one node only.
The node is specified by name.
(Inherited from AerospikeClient.)This call will block until the scan is complete - callbacks are made within the scope of this call. |
![]() | Touch(WritePolicy, Key) |
Reset record's time to expiration using the policy's expiration.
Fail if the record does not exist.
(Inherited from AerospikeClient.) |
![]() | Touch(WritePolicy, WriteListener, Key) |
Asynchronously create record if it does not already exist.
Schedule the touch command with a channel selector and return.
Another thread will process the command and send the results to the listener.
If the record exists, the record's time to expiration will be reset to the policy's
expiration.
|
![]() | Touch(WritePolicy, CancellationToken, Key) |
Asynchronously create record if it does not already exist.
Create listener, call asynchronous touch and return task monitor.
If the record exists, the record's time to expiration will be reset to the policy's
expiration.
|