AsyncClient MembersAerospike

The AsyncClient type exposes the following members.
Constructors

  NameDescription
Public methodAsyncClient(String, Int32)
Initialize asynchronous client. If the host connection succeeds, the client will:
  • Add host to the cluster map
  • Request host's list of other nodes in cluster
  • Add these nodes to cluster map

If the connection succeeds, the client is ready to process database requests. If the connection fails, the cluster will remain in a disconnected state until the server is activated.

Public methodAsyncClient(AsyncClientPolicy,  Host )
Initialize asynchronous client with suitable hosts to seed the cluster map. The client policy is used to set defaults and size internal data structures. For each host connection that succeeds, the client will:
  • Add host to the cluster map
  • Request host's list of other nodes in cluster
  • Add these nodes to cluster map

In most cases, only one host is necessary to seed the cluster. The remaining hosts are added as future seeds in case of a complete network failure.

If one connection succeeds, the client is ready to process database requests. If all connections fail and the policy's failIfNotConnected is true, a connection exception will be thrown. Otherwise, the cluster will remain in a disconnected state until the server is activated.

Public methodAsyncClient(AsyncClientPolicy, String, Int32)
Initialize asynchronous client. The client policy is used to set defaults and size internal data structures. If the host connection succeeds, the client will:
  • Add host to the cluster map
  • Request host's list of other nodes in cluster
  • Add these nodes to cluster map

If the connection succeeds, the client is ready to process database requests. If the connection fails and the policy's failOnInvalidHosts is true, a connection exception will be thrown. Otherwise, the cluster will remain in a disconnected state until the server is activated.

Back to Top
Methods

  NameDescription
Public methodAdd(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.)
Public methodAdd(WritePolicy, WriteListener, Key,  Bin )
Asynchronously add integer bin values to existing record bin values. This method schedules the add command with a channel selector and returns. 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.

Public methodAppend(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.)
Public methodAppend(WritePolicy, WriteListener, Key,  Bin )
Asynchronously append bin string values to existing record bin values. This method schedules the append command with a channel selector and returns. 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.

Public methodChangePassword
Change user's password. Clear-text password will be hashed using bcrypt before sending to server.
(Inherited from AerospikeClient.)
Public methodClose
Close all client connections to database server nodes.
(Inherited from AerospikeClient.)
Public methodCreateIndex(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.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodCreateIndex(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.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodCreateRole
Create user defined role.
(Inherited from AerospikeClient.)
Public methodCreateUser
Create user with password and roles. Clear-text password will be hashed using bcrypt before sending to server.
(Inherited from AerospikeClient.)
Public methodDelete(WritePolicy, Key)
Delete record for specified key. Return whether record existed on server before deletion. The policy specifies the transaction timeout.
(Inherited from AerospikeClient.)
Public methodDelete(WritePolicy, DeleteListener, Key)
Asynchronously delete record for specified key. This method schedules the delete command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy specifies the transaction timeout.

Public methodDispose
Close all client connections to database server nodes.
(Inherited from AerospikeClient.)
Public methodDropIndex
Delete secondary index.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodDropRole
Drop user defined role.
(Inherited from AerospikeClient.)
Public methodDropUser
Remove user from cluster.
(Inherited from AerospikeClient.)
Public methodExecute(Policy, Key, String, String,  Value )Obsolete.
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:

udf file = <server udf dir>/<package name>.lua

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodExecute(Policy, Statement, String, String,  Value )Obsolete.
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.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodExecute(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:

udf file = <server udf dir>/<package name>.lua

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodExecute(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.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodExists(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.)
Public methodExists(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.)
Public methodExists(Policy,  Key )Obsolete.
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.
(Inherited from AerospikeClient.)
Public methodExists(Policy, ExistsArrayListener,  Key )
Asynchronously check if multiple record keys exist in one batch call. This method schedules the exists command with a channel selector and returns. 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.

Public methodExists(Policy, ExistsListener, Key)
Asynchronously determine if a record key exists. This method schedules the exists command with a channel selector and returns. Another thread will process the command and send the results to the listener.

The policy can be used to specify timeouts.

Public methodExists(Policy, ExistsSequenceListener,  Key )
Asynchronously check if multiple record keys exist in one batch call. This method schedules the exists command with a channel selector and returns. 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.

Public methodGet(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.)
Public methodGet(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.)
Public methodGet(Policy,  Key )Obsolete.
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.
(Inherited from AerospikeClient.)
Public methodGet(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.)
Public methodGet(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.)
Public methodGet(Policy,  Key ,  String )Obsolete.
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.
(Inherited from AerospikeClient.)
Public methodGet(Policy, RecordArrayListener,  Key )
Asynchronously read multiple records for specified keys in one batch call. 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.

If a key is not found, the record will be null. The policy can be used to specify timeouts.

Public methodGet(Policy, RecordListener, Key)
Asynchronously read entire record for specified key. 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.

The policy can be used to specify timeouts.

Public methodGet(Policy, RecordSequenceListener,  Key )
Asynchronously read multiple records for specified keys in one batch call. 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 multiple unordered calls.

If a key is not found, the record will be null. The policy can be used to specify timeouts.

Public methodGet(Policy, RecordArrayListener,  Key ,  String )
Asynchronously read multiple record headers and bins for specified keys in one batch call. 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.

If a key is not found, the record will be null. The policy can be used to specify timeouts.

Public methodGet(Policy, RecordListener, Key,  String )
Asynchronously read record header and bins for specified key. 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.

The policy can be used to specify timeouts.

Public methodGet(Policy, RecordSequenceListener,  Key ,  String )
Asynchronously read multiple record headers and bins for specified keys in one batch call. 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 multiple unordered calls.

If a key is not found, the record will be null. The policy can be used to specify timeouts.

Public methodGetHeader(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.)
Public methodGetHeader(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.)
Public methodGetHeader(Policy,  Key )Obsolete.
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.
(Inherited from AerospikeClient.)
Public methodGetHeader(Policy, RecordArrayListener,  Key )
Asynchronously read multiple record header data for specified keys in one batch call. 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.

If a key is not found, the record will be null. The policy can be used to specify timeouts.

Public methodGetHeader(Policy, RecordListener, Key)
Asynchronously read record generation and expiration only for specified key. Bins are not read. 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.

The policy can be used to specify timeouts.

Public methodGetHeader(Policy, RecordSequenceListener,  Key )
Asynchronously read multiple record header data for specified keys in one batch call. 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 multiple unordered calls.

If a key is not found, the record will be null. The policy can be used to specify timeouts.

Public methodGetLargeList(Policy, Key, String, String)Obsolete.
Initialize large list operator. This operator can be used to create and manage a list within a single bin.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodGetLargeList(WritePolicy, Key, String, String)
Initialize large list operator. This operator can be used to create and manage a list within a single bin.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodGetLargeMap(Policy, Key, String, String)Obsolete.
Initialize large map operator. This operator can be used to create and manage a map within a single bin.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodGetLargeMap(WritePolicy, Key, String, String)
Initialize large map operator. This operator can be used to create and manage a map within a single bin.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodGetLargeSet(Policy, Key, String, String)Obsolete.
Initialize large set operator. This operator can be used to create and manage a set within a single bin.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodGetLargeSet(WritePolicy, Key, String, String)
Initialize large set operator. This operator can be used to create and manage a set within a single bin.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodGetLargeStack(Policy, Key, String, String)Obsolete.
Initialize large stack operator. This operator can be used to create and manage a stack within a single bin.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodGetLargeStack(WritePolicy, Key, String, String)
Initialize large stack operator. This operator can be used to create and manage a stack within a single bin.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodGrantPrivileges
Grant privileges to an user defined role.
(Inherited from AerospikeClient.)
Public methodGrantRoles
Add roles to user's list of roles.
(Inherited from AerospikeClient.)
Public methodJoin(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.)
Public methodJoin(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.)
Public methodOperate(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.

Write operations are always performed first, regardless of operation order relative to read operations.

(Inherited from AerospikeClient.)
Public methodOperate(WritePolicy, RecordListener, Key,  Operation )
Asynchronously perform multiple read/write operations on a single key in one batch call. An example would be to add an integer value to an existing record and then read the result, all in one database call.

This method schedules the operate command with a channel selector and returns. Another thread will process the command and send the results to the listener.

Public methodPrepend(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.)
Public methodPrepend(WritePolicy, WriteListener, Key,  Bin )
Asynchronously prepend bin string values to existing record bin values. This method schedules the prepend command with a channel selector and returns. 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.

Public methodPut(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.)
Public methodPut(WritePolicy, WriteListener, Key,  Bin )
Asynchronously write record bin(s). This method schedules the put command with a channel selector and returns. 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.

Public methodQuery(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.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodQuery(QueryPolicy, Statement, Action Key, Record )
Execute query and call action for each record returned from server.
(Inherited from AerospikeClient.)
Public methodQueryAggregate(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.

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.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodQueryAggregate(QueryPolicy, Statement, Action Object )
Execute query, apply statement's aggregation function, call action for each aggregation object returned from server.
(Inherited from AerospikeClient.)
Public methodQueryAggregate(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.

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.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodQueryRole
Retrieve role definition.
(Inherited from AerospikeClient.)
Public methodQueryRoles
Retrieve all roles.
(Inherited from AerospikeClient.)
Public methodQueryUser
Retrieve roles for a given user.
(Inherited from AerospikeClient.)
Public methodQueryUsers
Retrieve all users and their roles.
(Inherited from AerospikeClient.)
Public methodRegister(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.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodRegister(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.

This method is only supported by Aerospike 3 servers.

(Inherited from AerospikeClient.)
Public methodRevokePrivileges
Revoke privileges from an user defined role.
(Inherited from AerospikeClient.)
Public methodRevokeRoles
Remove roles from user's list of roles.
(Inherited from AerospikeClient.)
Public methodScanAll(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.

This call will block until the scan is complete - callbacks are made within the scope of this call.

(Inherited from AerospikeClient.)
Public methodScanAll(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.

Public methodScanNode(ScanPolicy, Node, String, String, ScanCallback,  String )
Read all records in specified namespace and set for one node only.

This call will block until the scan is complete - callbacks are made within the scope of this call.

(Inherited from AerospikeClient.)
Public methodScanNode(ScanPolicy, String, String, String, ScanCallback,  String )
Read all records in specified namespace and set for one node only. The node is specified by name.

This call will block until the scan is complete - callbacks are made within the scope of this call.

(Inherited from AerospikeClient.)
Public methodTouch(WritePolicy, Key)
Reset record's time to expiration using the policy's expiration. Fail if the record does not exist.
(Inherited from AerospikeClient.)
Public methodTouch(WritePolicy, WriteListener, Key)
Asynchronously create record if it does not already exist. If the record exists, the record's time to expiration will be reset to the policy's expiration.

This method schedules the touch command with a channel selector and returns. Another thread will process the command and send the results to the listener.

Back to Top
Fields

  NameDescription
Public fieldbatchPolicyDefault
Default batch policy that is used when batch command policy is null.
(Inherited from AerospikeClient.)
Public fieldqueryPolicyDefault
Default query policy that is used when query command policy is null.
(Inherited from AerospikeClient.)
Public fieldreadPolicyDefault
Default read policy that is used when read command policy is null.
(Inherited from AerospikeClient.)
Public fieldscanPolicyDefault
Default scan policy that is used when scan command policy is null.
(Inherited from AerospikeClient.)
Public fieldwritePolicyDefault
Default write policy that is used when write command policy is null.
(Inherited from AerospikeClient.)
Back to Top
Properties

  NameDescription
Public propertyConnected
Return if we are ready to talk to the database server cluster.
(Inherited from AerospikeClient.)
Public propertyNodes
Return array of active server nodes in the cluster.
(Inherited from AerospikeClient.)
Back to Top
See Also