Name | Description | |
---|---|---|
![]() | AerospikeClient(String, Int32) |
Initialize Aerospike client.
If the host connection succeeds, the client will:
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. |
![]() | AerospikeClient(ClientPolicy, Host ) |
Initialize Aerospike 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:
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. |
![]() | AerospikeClient(ClientPolicy, String, Int32) |
Initialize Aerospike client.
The client policy is used to set defaults and size internal data structures.
If the host connection succeeds, the client will:
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. |
Name | Description | |
---|---|---|
![]() | Add |
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.
|
![]() | Append |
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.
|
![]() | ChangePassword |
Change user's password. Clear-text password will be hashed using bcrypt
before sending to server.
|
![]() | Close |
Close all client connections to database server nodes.
|
![]() | 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.
This method is only supported by Aerospike 3 servers. |
![]() | 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.
This method is only supported by Aerospike 3 servers. |
![]() | CreateRole |
Create user defined role.
|
![]() | CreateUser |
Create user with password and roles. Clear-text password will be hashed using bcrypt
before sending to server.
|
![]() | Delete |
Delete record for specified key.
Return whether record existed on server before deletion.
The policy specifies the transaction timeout.
|
![]() | Dispose |
Close all client connections to database server nodes.
|
![]() | DropIndex |
Delete secondary index.
This method is only supported by Aerospike 3 servers. |
![]() | DropRole |
Drop user defined role.
|
![]() | DropUser |
Remove user from cluster.
|
![]() | Execute(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. |
![]() | Execute(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. |
![]() | 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:
udf file = <server udf dir>/<package name>.lua This method is only supported by Aerospike 3 servers. |
![]() | 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.
This method is only supported by Aerospike 3 servers. |
![]() | 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.
|
![]() | Exists(Policy, Key) |
Determine if a record key exists.
Return whether record exists or not.
The policy can be used to specify timeouts.
|
![]() | Exists(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.
|
![]() | 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.
|
![]() | 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.
|
![]() | Get(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.
|
![]() | 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.
|
![]() | 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.
|
![]() | Get(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.
|
![]() | 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.
|
![]() | 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.
|
![]() | GetHeader(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.
|
![]() | GetLargeList(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. |
![]() | GetLargeList(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. |
![]() | GetLargeMap(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. |
![]() | GetLargeMap(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. |
![]() | GetLargeSet(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. |
![]() | GetLargeSet(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. |
![]() | GetLargeStack(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. |
![]() | GetLargeStack(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. |
![]() | GrantPrivileges |
Grant privileges to an user defined role.
|
![]() | GrantRoles |
Add roles to user's list of roles.
|
![]() | 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.
|
![]() | 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.
|
![]() | Operate |
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. |
![]() | Prepend |
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.
|
![]() | Put |
Write record bin(s).
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.
This method is only supported by Aerospike 3 servers. |
![]() | Query(QueryPolicy, Statement, Action Key, Record ) |
Execute query and call action for each record returned from server.
|
![]() | 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.
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. |
![]() | QueryAggregate(QueryPolicy, Statement, Action Object ) |
Execute query, apply statement's aggregation function, call action for each aggregation
object returned from server.
|
![]() | 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.
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. |
![]() | QueryRole |
Retrieve role definition.
|
![]() | QueryRoles |
Retrieve all roles.
|
![]() | QueryUser |
Retrieve roles for a given user.
|
![]() | QueryUsers |
Retrieve all users and their roles.
|
![]() | 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.
This method is only supported by Aerospike 3 servers. |
![]() | 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.
This method is only supported by Aerospike 3 servers. |
![]() | RevokePrivileges |
Revoke privileges from an user defined role.
|
![]() | RevokeRoles |
Remove roles from user's list of roles.
|
![]() | ScanAll |
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. |
![]() | ScanNode(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. |
![]() | 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.
This call will block until the scan is complete - callbacks are made within the scope of this call. |
![]() | Touch |
Reset record's time to expiration using the policy's expiration.
Fail if the record does not exist.
|
Name | Description | |
---|---|---|
![]() | batchPolicyDefault |
Default batch policy that is used when batch command policy is null.
|
![]() | queryPolicyDefault |
Default query policy that is used when query command policy is null.
|
![]() | readPolicyDefault |
Default read policy that is used when read command policy is null.
|
![]() | scanPolicyDefault |
Default scan policy that is used when scan command policy is null.
|
![]() | writePolicyDefault |
Default write policy that is used when write command policy is null.
|
Name | Description | |
---|---|---|
![]() | Connected |
Return if we are ready to talk to the database server cluster.
|
![]() | Nodes |
Return array of active server nodes in the cluster.
|