AerospikeClient MethodsAerospike
The AerospikeClient type exposes the following members.
Methods

  NameDescription
Public methodAdd
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.
Public methodAppend
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.
Public methodChangePassword
Change user's password. Clear-text password will be hashed using bcrypt before sending to server.
Public methodClose
Close all client connections to database server nodes.
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.

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.

Public methodCreateRole
Create user defined role.
Public methodCreateUser
Create user with password and roles. Clear-text password will be hashed using bcrypt before sending to server.
Public methodDelete
Delete record for specified key. Return whether record existed on server before deletion. The policy specifies the transaction timeout.
Public methodDispose
Close all client connections to database server nodes.
Public methodDropIndex
Delete secondary index.

This method is only supported by Aerospike 3 servers.

Public methodDropRole
Drop user defined role.
Public methodDropUser
Remove user from cluster.
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.

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.

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.

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.

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.
Public methodExists(Policy, Key)
Determine if a record key exists. Return whether record exists or not. The policy can be used to specify timeouts.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.

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.

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.

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.

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.

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.

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.

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.

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

Public methodPrepend
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.
Public methodPut
Write record bin(s). The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists.
Public methodQuery
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.

Public methodQueryAggregate
Execute query, apply statement's aggregation function, and return result iterator. The query executor puts results on a queue in separate threads. The calling thread concurrently pops results off the queue through the result iterator.

The aggregation function is called on both server and client (final reduce). Therefore, the Lua script files must also reside on both server and client. The package name is used to locate the udf file location:

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

This method is only supported by Aerospike 3 servers.

Public methodQueryRole
Retrieve role definition.
Public methodQueryRoles
Retrieve all roles.
Public methodQueryUser
Retrieve roles for a given user.
Public methodQueryUsers
Retrieve all users and their roles.
Public methodRegister
Register package 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.

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

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.

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.

Public methodTouch
Reset record's time to expiration using the policy's expiration. Fail if the record does not exist.
Back to Top
See Also