Name | Description | |
---|---|---|
![]() | AsyncClient(String, Int32) |
Initialize asynchronous 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. |
![]() | AsyncClient(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:
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. |
![]() | AsyncClient(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:
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(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.
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. |
![]() | 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.
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. |
![]() | Close |
Close all client connections to database server nodes.
(Inherited from AerospikeClient.) |
![]() | CreateIndex |
Create 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.)This method is only supported by Aerospike 3 servers. |
![]() | 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.
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. |
![]() | DropIndex |
Delete secondary index.
(Inherited from AerospikeClient.)This method is only supported by Aerospike 3 servers. |
![]() | Execute(Policy, 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 This method is only supported by Aerospike 3 servers. |
![]() | Execute(Policy, 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.)This method is only supported by Aerospike 3 servers. |
![]() | 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(Policy, 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.
(Inherited from AerospikeClient.) |
![]() | Exists(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. |
![]() | Exists(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. |
![]() | Exists(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. |
![]() | 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(Policy, 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.
(Inherited from AerospikeClient.) |
![]() | 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, 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.
(Inherited from AerospikeClient.) |
![]() | Get(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. |
![]() | Get(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. |
![]() | Get(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. |
![]() | Get(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. |
![]() | Get(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. |
![]() | Get(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. |
![]() | 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(Policy, 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.
(Inherited from AerospikeClient.) |
![]() | GetHeader(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. |
![]() | GetHeader(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. |
![]() | GetHeader(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. |
![]() | GetLargeList |
Initialize large list operator. This operator can be used to create and manage a list
within a single bin.
(Inherited from AerospikeClient.)This method is only supported by Aerospike 3 servers. |
![]() | GetLargeMap |
Initialize large map operator. This operator can be used to create and manage a map
within a single bin.
(Inherited from AerospikeClient.)This method is only supported by Aerospike 3 servers. |
![]() | GetLargeSet |
Initialize large set operator. This operator can be used to create and manage a set
within a single bin.
(Inherited from AerospikeClient.)This method is only supported by Aerospike 3 servers. |
![]() | GetLargeStack |
Initialize large stack operator. This operator can be used to create and manage a stack
within a single bin.
(Inherited from AerospikeClient.)This method is only supported by Aerospike 3 servers. |
![]() | 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.) |
![]() | Operate(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. |
![]() | 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.
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. |
![]() | 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).
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. |
![]() | Query |
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.)This method is only supported by Aerospike 3 servers. |
![]() | QueryAggregate |
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.
(Inherited from AerospikeClient.)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. |
![]() | Register |
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.
(Inherited from AerospikeClient.)This method is only supported by Aerospike 3 servers. |
![]() | 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) |
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.
(Inherited from AerospikeClient.) |
![]() | Touch(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. |
Name | Description | |
---|---|---|
![]() | Connected |
Return if we are ready to talk to the database server cluster.
(Inherited from AerospikeClient.) |
![]() | Nodes |
Return array of active server nodes in the cluster.
(Inherited from AerospikeClient.) |