public interface IAerospikeClient extends Closeable
Modifier and Type | Method and Description |
---|---|
void |
add(EventLoop eventLoop,
WriteListener listener,
WritePolicy policy,
Key key,
Bin... bins)
Asynchronously add integer bin values to existing record bin values.
|
void |
add(WritePolicy policy,
Key key,
Bin... bins)
Add integer bin values to existing record bin values.
|
void |
append(EventLoop eventLoop,
WriteListener listener,
WritePolicy policy,
Key key,
Bin... bins)
Asynchronously append bin string values to existing record bin values.
|
void |
append(WritePolicy policy,
Key key,
Bin... bins)
Append bin string values to existing record bin values.
|
void |
changePassword(AdminPolicy policy,
String user,
String password)
Change user's password.
|
void |
close()
Close all client connections to database server nodes.
|
IndexTask |
createIndex(Policy policy,
String namespace,
String setName,
String indexName,
String binName,
IndexType indexType)
Create scalar secondary index.
|
IndexTask |
createIndex(Policy policy,
String namespace,
String setName,
String indexName,
String binName,
IndexType indexType,
IndexCollectionType indexCollectionType)
Create complex secondary index to be used on bins containing collections.
|
void |
createRole(AdminPolicy policy,
String roleName,
List<Privilege> privileges)
Create user defined role.
|
void |
createUser(AdminPolicy policy,
String user,
String password,
List<String> roles)
Create user with password and roles.
|
void |
delete(EventLoop eventLoop,
DeleteListener listener,
WritePolicy policy,
Key key)
Asynchronously delete record for specified key.
|
boolean |
delete(WritePolicy policy,
Key key)
Delete record for specified key.
|
IndexTask |
dropIndex(Policy policy,
String namespace,
String setName,
String indexName)
Delete secondary index.
|
void |
dropRole(AdminPolicy policy,
String roleName)
Drop user defined role.
|
void |
dropUser(AdminPolicy policy,
String user)
Remove user from cluster.
|
void |
execute(EventLoop eventLoop,
ExecuteListener listener,
WritePolicy policy,
Key key,
String packageName,
String functionName,
Value... functionArgs)
Asynchronously execute user defined function on server.
|
Object |
execute(WritePolicy policy,
Key key,
String packageName,
String functionName,
Value... args)
Execute user defined function on server and return results.
|
ExecuteTask |
execute(WritePolicy policy,
Statement statement,
String packageName,
String functionName,
Value... functionArgs)
Apply user defined function on records that match the statement filter.
|
boolean[] |
exists(BatchPolicy policy,
Key[] keys)
Check if multiple record keys exist in one batch call.
|
void |
exists(EventLoop eventLoop,
ExistsArrayListener listener,
BatchPolicy policy,
Key[] keys)
Asynchronously check if multiple record keys exist in one batch call.
|
void |
exists(EventLoop eventLoop,
ExistsListener listener,
Policy policy,
Key key)
Asynchronously determine if a record key exists.
|
void |
exists(EventLoop eventLoop,
ExistsSequenceListener listener,
BatchPolicy policy,
Key[] keys)
Asynchronously check if multiple record keys exist in one batch call.
|
boolean |
exists(Policy policy,
Key key)
Determine if a record key exists.
|
Record[] |
get(BatchPolicy policy,
Key[] keys)
Read multiple records for specified keys in one batch call.
|
Record[] |
get(BatchPolicy policy,
Key[] keys,
String... binNames)
Read multiple record headers and bins for specified keys in one batch call.
|
void |
get(BatchPolicy policy,
List<BatchRead> records)
Read multiple records for specified batch keys in one batch call.
|
void |
get(EventLoop eventLoop,
BatchListListener listener,
BatchPolicy policy,
List<BatchRead> records)
Asynchronously read multiple records for specified batch keys in one batch call.
|
void |
get(EventLoop eventLoop,
BatchSequenceListener listener,
BatchPolicy policy,
List<BatchRead> records)
Asynchronously read multiple records for specified batch keys in one batch call.
|
void |
get(EventLoop eventLoop,
RecordArrayListener listener,
BatchPolicy policy,
Key[] keys)
Asynchronously read multiple records for specified keys in one batch call.
|
void |
get(EventLoop eventLoop,
RecordArrayListener listener,
BatchPolicy policy,
Key[] keys,
String... binNames)
Asynchronously read multiple record headers and bins for specified keys in one batch call.
|
void |
get(EventLoop eventLoop,
RecordListener listener,
Policy policy,
Key key)
Asynchronously read entire record for specified key.
|
void |
get(EventLoop eventLoop,
RecordListener listener,
Policy policy,
Key key,
String... binNames)
Asynchronously read record header and bins for specified key.
|
void |
get(EventLoop eventLoop,
RecordSequenceListener listener,
BatchPolicy policy,
Key[] keys)
Asynchronously read multiple records for specified keys in one batch call.
|
void |
get(EventLoop eventLoop,
RecordSequenceListener listener,
BatchPolicy policy,
Key[] keys,
String... binNames)
Asynchronously read multiple record headers and bins for specified keys in one batch call.
|
Record |
get(Policy policy,
Key key)
Read entire record for specified key.
|
Record |
get(Policy policy,
Key key,
String... binNames)
Read record header and bins for specified key.
|
BatchPolicy |
getBatchPolicyDefault() |
ClusterStats |
getClusterStats()
Return operating cluster statistics.
|
Record[] |
getHeader(BatchPolicy policy,
Key[] keys)
Read multiple record header data for specified keys in one batch call.
|
void |
getHeader(EventLoop eventLoop,
RecordArrayListener listener,
BatchPolicy policy,
Key[] keys)
Asynchronously read multiple record header data for specified keys in one batch call.
|
void |
getHeader(EventLoop eventLoop,
RecordListener listener,
Policy policy,
Key key)
Asynchronously read record generation and expiration only for specified key.
|
void |
getHeader(EventLoop eventLoop,
RecordSequenceListener listener,
BatchPolicy policy,
Key[] keys)
Asynchronously read multiple record header data for specified keys in one batch call.
|
Record |
getHeader(Policy policy,
Key key)
Read record generation and expiration only for specified key.
|
InfoPolicy |
getInfoPolicyDefault() |
Node |
getNode(String nodeName)
Return node given its name.
|
List<String> |
getNodeNames()
Return list of active server node names in the cluster.
|
Node[] |
getNodes()
Return array of active server nodes in the cluster.
|
QueryPolicy |
getQueryPolicyDefault() |
Policy |
getReadPolicyDefault() |
ScanPolicy |
getScanPolicyDefault() |
WritePolicy |
getWritePolicyDefault() |
void |
grantPrivileges(AdminPolicy policy,
String roleName,
List<Privilege> privileges)
Grant privileges to an user defined role.
|
void |
grantRoles(AdminPolicy policy,
String user,
List<String> roles)
Add roles to user's list of roles.
|
boolean |
isConnected()
Determine if we are ready to talk to the database server cluster.
|
void |
operate(EventLoop eventLoop,
RecordListener listener,
WritePolicy policy,
Key key,
Operation... operations)
Asynchronously perform multiple read/write operations on a single key in one batch call.
|
Record |
operate(WritePolicy policy,
Key key,
Operation... operations)
Perform multiple read/write operations on a single key in one batch call.
|
void |
prepend(EventLoop eventLoop,
WriteListener listener,
WritePolicy policy,
Key key,
Bin... bins)
Asynchronously prepend bin string values to existing record bin values.
|
void |
prepend(WritePolicy policy,
Key key,
Bin... bins)
Prepend bin string values to existing record bin values.
|
void |
put(EventLoop eventLoop,
WriteListener listener,
WritePolicy policy,
Key key,
Bin... bins)
Asynchronously write record bin(s).
|
void |
put(WritePolicy policy,
Key key,
Bin... bins)
Write record bin(s).
|
void |
query(EventLoop eventLoop,
RecordSequenceListener listener,
QueryPolicy policy,
Statement statement)
Asynchronously execute query on all server nodes.
|
RecordSet |
query(QueryPolicy policy,
Statement statement)
Execute query on all server nodes and return record iterator.
|
ResultSet |
queryAggregate(QueryPolicy policy,
Statement statement)
Execute query, apply statement's aggregation function, and return result iterator.
|
ResultSet |
queryAggregate(QueryPolicy policy,
Statement statement,
String packageName,
String functionName,
Value... functionArgs)
Execute query, apply statement's aggregation function, and return result iterator.
|
ResultSet |
queryAggregateNode(QueryPolicy policy,
Statement statement,
Node node)
Execute query on a single server node, apply statement's aggregation function, and return
result iterator.
|
RecordSet |
queryNode(QueryPolicy policy,
Statement statement,
Node node)
Execute query on a single server node and return record iterator.
|
Role |
queryRole(AdminPolicy policy,
String roleName)
Retrieve role definition.
|
List<Role> |
queryRoles(AdminPolicy policy)
Retrieve all roles.
|
User |
queryUser(AdminPolicy policy,
String user)
Retrieve roles for a given user.
|
List<User> |
queryUsers(AdminPolicy policy)
Retrieve all users and their roles.
|
RegisterTask |
register(Policy policy,
ClassLoader resourceLoader,
String resourcePath,
String serverPath,
Language language)
Register package located in a resource containing user defined functions with server.
|
RegisterTask |
register(Policy policy,
String clientPath,
String serverPath,
Language language)
Register package located in a file containing user defined functions with server.
|
RegisterTask |
registerUdfString(Policy policy,
String code,
String serverPath,
Language language)
Register UDF functions located in a code string with server.
|
void |
removeUdf(InfoPolicy policy,
String serverPath)
Remove user defined function from server nodes.
|
void |
revokePrivileges(AdminPolicy policy,
String roleName,
List<Privilege> privileges)
Revoke privileges from an user defined role.
|
void |
revokeRoles(AdminPolicy policy,
String user,
List<String> roles)
Remove roles from user's list of roles.
|
void |
scanAll(EventLoop eventLoop,
RecordSequenceListener listener,
ScanPolicy policy,
String namespace,
String setName,
String... binNames)
Asynchronously read all records in specified namespace and set.
|
void |
scanAll(ScanPolicy policy,
String namespace,
String setName,
ScanCallback callback,
String... binNames)
Read all records in specified namespace and set.
|
void |
scanNode(ScanPolicy policy,
Node node,
String namespace,
String setName,
ScanCallback callback,
String... binNames)
Read all records in specified namespace and set for one node only.
|
void |
scanNode(ScanPolicy policy,
String nodeName,
String namespace,
String setName,
ScanCallback callback,
String... binNames)
Read all records in specified namespace and set for one node only.
|
void |
touch(EventLoop eventLoop,
WriteListener listener,
WritePolicy policy,
Key key)
Asynchronously reset record's time to expiration using the policy's expiration.
|
void |
touch(WritePolicy policy,
Key key)
Reset record's time to expiration using the policy's expiration.
|
void |
truncate(InfoPolicy policy,
String ns,
String set,
Calendar beforeLastUpdate)
Remove records in specified namespace/set efficiently.
|
Policy getReadPolicyDefault()
WritePolicy getWritePolicyDefault()
ScanPolicy getScanPolicyDefault()
QueryPolicy getQueryPolicyDefault()
BatchPolicy getBatchPolicyDefault()
InfoPolicy getInfoPolicyDefault()
void close()
close
in interface AutoCloseable
close
in interface Closeable
boolean isConnected()
true
if cluster is ready,
false
if cluster is not readyNode[] getNodes()
List<String> getNodeNames()
Node getNode(String nodeName) throws AerospikeException.InvalidNode
AerospikeException.InvalidNode
- if node does not exist.ClusterStats getClusterStats()
void put(WritePolicy policy, Key key, Bin... bins) throws AerospikeException
policy
- write configuration parameters, pass in null for defaultskey
- unique record identifierbins
- array of bin name/value pairsAerospikeException
- if write failsvoid put(EventLoop eventLoop, WriteListener listener, WritePolicy policy, Key key, Bin... bins) throws AerospikeException
The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists.
eventLoop
- event loop that will process the commandlistener
- where to send results, pass in null for fire and forgetpolicy
- write configuration parameters, pass in null for defaultskey
- unique record identifierbins
- array of bin name/value pairsAerospikeException
- if event loop registration failsvoid append(WritePolicy policy, Key key, Bin... bins) throws AerospikeException
policy
- write configuration parameters, pass in null for defaultskey
- unique record identifierbins
- array of bin name/value pairsAerospikeException
- if append failsvoid append(EventLoop eventLoop, WriteListener listener, WritePolicy policy, Key key, Bin... bins) throws AerospikeException
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.
eventLoop
- event loop that will process the commandlistener
- where to send results, pass in null for fire and forgetpolicy
- write configuration parameters, pass in null for defaultskey
- unique record identifierbins
- array of bin name/value pairsAerospikeException
- if event loop registration failsvoid prepend(WritePolicy policy, Key key, Bin... bins) throws AerospikeException
policy
- write configuration parameters, pass in null for defaultskey
- unique record identifierbins
- array of bin name/value pairsAerospikeException
- if prepend failsvoid prepend(EventLoop eventLoop, WriteListener listener, WritePolicy policy, Key key, Bin... bins) throws AerospikeException
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.
eventLoop
- event loop that will process the commandlistener
- where to send results, pass in null for fire and forgetpolicy
- write configuration parameters, pass in null for defaultskey
- unique record identifierbins
- array of bin name/value pairsAerospikeException
- if event loop registration failsvoid add(WritePolicy policy, Key key, Bin... bins) throws AerospikeException
policy
- write configuration parameters, pass in null for defaultskey
- unique record identifierbins
- array of bin name/value pairsAerospikeException
- if add failsvoid add(EventLoop eventLoop, WriteListener listener, WritePolicy policy, Key key, Bin... bins) throws AerospikeException
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.
eventLoop
- event loop that will process the commandlistener
- where to send results, pass in null for fire and forgetpolicy
- write configuration parameters, pass in null for defaultskey
- unique record identifierbins
- array of bin name/value pairsAerospikeException
- if event loop registration failsboolean delete(WritePolicy policy, Key key) throws AerospikeException
policy
- delete configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if delete failsvoid delete(EventLoop eventLoop, DeleteListener listener, WritePolicy policy, Key key) throws AerospikeException
The policy specifies the transaction timeout.
eventLoop
- event loop that will process the commandlistener
- where to send results, pass in null for fire and forgetpolicy
- write configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if event loop registration failsvoid truncate(InfoPolicy policy, String ns, String set, Calendar beforeLastUpdate) throws AerospikeException
See https://www.aerospike.com/docs/reference/info#truncate
This asynchronous server call may return before the truncation is complete. The user can still write new records after the server call returns because new records will have last update times greater than the truncate cutoff (set at the time of truncate call).
policy
- info command configuration parameters, pass in null for defaultsns
- required namespaceset
- optional set name. Pass in null to delete all sets in namespace.beforeLastUpdate
- optional delete records before record last update time.
If specified, value must be before the current time.
Pass in null to delete all records in namespace/set.AerospikeException
- if truncate failsvoid touch(WritePolicy policy, Key key) throws AerospikeException
policy
- write configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if touch failsvoid touch(EventLoop eventLoop, WriteListener listener, WritePolicy policy, Key key) throws AerospikeException
Fail if the record does not exist.
eventLoop
- event loop that will process the commandlistener
- where to send results, pass in null for fire and forgetpolicy
- write configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if event loop registration failsboolean exists(Policy policy, Key key) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if command failsvoid exists(EventLoop eventLoop, ExistsListener listener, Policy policy, Key key) throws AerospikeException
The policy can be used to specify timeouts.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- generic configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if event loop registration failsboolean[] exists(BatchPolicy policy, Key[] keys) throws AerospikeException
policy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersAerospikeException
- if command failsvoid exists(EventLoop eventLoop, ExistsArrayListener listener, BatchPolicy policy, Key[] keys) throws AerospikeException
The returned boolean array is in positional order with the original key array order.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultskeys
- unique record identifiersAerospikeException
- if event loop registration failsvoid exists(EventLoop eventLoop, ExistsSequenceListener listener, BatchPolicy policy, Key[] keys) throws AerospikeException
Each key's result is returned in separate onExists() calls.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultskeys
- unique record identifiersAerospikeException
- if event loop registration failsRecord get(Policy policy, Key key) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if read failsvoid get(EventLoop eventLoop, RecordListener listener, Policy policy, Key key) throws AerospikeException
The policy can be used to specify timeouts.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- generic configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if event loop registration failsRecord get(Policy policy, Key key, String... binNames) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultskey
- unique record identifierbinNames
- bins to retrieveAerospikeException
- if read failsvoid get(EventLoop eventLoop, RecordListener listener, Policy policy, Key key, String... binNames) throws AerospikeException
The policy can be used to specify timeouts.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- generic configuration parameters, pass in null for defaultskey
- unique record identifierbinNames
- bins to retrieveAerospikeException
- if event loop registration failsRecord getHeader(Policy policy, Key key) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if read failsvoid getHeader(EventLoop eventLoop, RecordListener listener, Policy policy, Key key) throws AerospikeException
The policy can be used to specify timeouts.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- generic configuration parameters, pass in null for defaultskey
- unique record identifierAerospikeException
- if event loop registration failsvoid get(BatchPolicy policy, List<BatchRead> records) throws AerospikeException
policy
- batch configuration parameters, pass in null for defaultsrecords
- list of unique record identifiers and the bins to retrieve.
The returned records are located in the same list.AerospikeException
- if read failsvoid get(EventLoop eventLoop, BatchListListener listener, BatchPolicy policy, List<BatchRead> records) throws AerospikeException
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 BatchRead key field is not found, the corresponding record field will be null. The policy can be used to specify timeouts.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultsrecords
- list of unique record identifiers and the bins to retrieve.
The returned records are located in the same list.AerospikeException
- if event loop registration failsvoid get(EventLoop eventLoop, BatchSequenceListener listener, BatchPolicy policy, List<BatchRead> records) throws AerospikeException
This method allows different namespaces/bins to be requested for each key in the batch. Each record result is returned in separate onRecord() calls. If the BatchRead key field is not found, the corresponding record field will be null. The policy can be used to specify timeouts.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultsrecords
- list of unique record identifiers and the bins to retrieve.
The returned records are located in the same list.AerospikeException
- if event loop registration failsRecord[] get(BatchPolicy policy, Key[] keys) throws AerospikeException
policy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersAerospikeException
- if read failsvoid get(EventLoop eventLoop, RecordArrayListener listener, BatchPolicy policy, Key[] keys) throws AerospikeException
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.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersAerospikeException
- if event loop registration failsvoid get(EventLoop eventLoop, RecordSequenceListener listener, BatchPolicy policy, Key[] keys) throws AerospikeException
Each record result is returned in separate onRecord() calls. If a key is not found, the record will be null. The policy can be used to specify timeouts.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersAerospikeException
- if event loop registration failsRecord[] get(BatchPolicy policy, Key[] keys, String... binNames) throws AerospikeException
policy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersbinNames
- array of bins to retrieveAerospikeException
- if read failsvoid get(EventLoop eventLoop, RecordArrayListener listener, BatchPolicy policy, Key[] keys, String... binNames) throws AerospikeException
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.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersbinNames
- array of bins to retrieveAerospikeException
- if event loop registration failsvoid get(EventLoop eventLoop, RecordSequenceListener listener, BatchPolicy policy, Key[] keys, String... binNames) throws AerospikeException
Each record result is returned in separate onRecord() calls. If a key is not found, the record will be null. The policy can be used to specify timeouts.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersbinNames
- array of bins to retrieveAerospikeException
- if event loop registration failsRecord[] getHeader(BatchPolicy policy, Key[] keys) throws AerospikeException
policy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersAerospikeException
- if read failsvoid getHeader(EventLoop eventLoop, RecordArrayListener listener, BatchPolicy policy, Key[] keys) throws AerospikeException
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.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersAerospikeException
- if event loop registration failsvoid getHeader(EventLoop eventLoop, RecordSequenceListener listener, BatchPolicy policy, Key[] keys) throws AerospikeException
Each record result is returned in separate onRecord() calls. If a key is not found, the record will be null. The policy can be used to specify timeouts.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- batch configuration parameters, pass in null for defaultskeys
- array of unique record identifiersAerospikeException
- if event loop registration failsRecord operate(WritePolicy policy, Key key, Operation... operations) throws AerospikeException
Write operations are always performed first, regardless of operation order relative to read operations.
policy
- write configuration parameters, pass in null for defaultskey
- unique record identifieroperations
- database operations to performAerospikeException
- if command failsvoid operate(EventLoop eventLoop, RecordListener listener, WritePolicy policy, Key key, Operation... operations) throws AerospikeException
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.
Both scalar bin operations (Operation) and list bin operations (ListOperation) can be performed in same call.
eventLoop
- event loop that will process the commandlistener
- where to send results, pass in null for fire and forgetpolicy
- write configuration parameters, pass in null for defaultskey
- unique record identifieroperations
- database operations to performAerospikeException
- if event loop registration failsvoid scanAll(ScanPolicy policy, String namespace, String setName, ScanCallback callback, String... binNames) throws AerospikeException
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.
policy
- scan configuration parameters, pass in null for defaultsnamespace
- namespace - equivalent to database namesetName
- optional set name - equivalent to database tablecallback
- read callback method - called with record databinNames
- optional bin to retrieve. All bins will be returned if not specified.
Aerospike 2 servers ignore this parameter.AerospikeException
- if scan failsvoid scanAll(EventLoop eventLoop, RecordSequenceListener listener, ScanPolicy policy, String namespace, String setName, String... binNames) throws AerospikeException
concurrentNodes
is specified, each server node will be read in
parallel. Otherwise, server nodes are read in series.
This method registers the command with an event loop and returns. The event loop thread will process the command and send the results to the listener.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- scan configuration parameters, pass in null for defaultsnamespace
- namespace - equivalent to database namesetName
- optional set name - equivalent to database tablebinNames
- optional bin to retrieve. All bins will be returned if not specified.
Aerospike 2 servers ignore this parameter.AerospikeException
- if event loop registration failsvoid scanNode(ScanPolicy policy, String nodeName, String namespace, String setName, ScanCallback callback, String... binNames) throws AerospikeException
This call will block until the scan is complete - callbacks are made within the scope of this call.
policy
- scan configuration parameters, pass in null for defaultsnodeName
- server node namenamespace
- namespace - equivalent to database namesetName
- optional set name - equivalent to database tablecallback
- read callback method - called with record databinNames
- optional bin to retrieve. All bins will be returned if not specified.
Aerospike 2 servers ignore this parameter.AerospikeException
- if scan failsvoid scanNode(ScanPolicy policy, Node node, String namespace, String setName, ScanCallback callback, String... binNames) throws AerospikeException
This call will block until the scan is complete - callbacks are made within the scope of this call.
policy
- scan configuration parameters, pass in null for defaultsnode
- server nodenamespace
- namespace - equivalent to database namesetName
- optional set name - equivalent to database tablecallback
- read callback method - called with record databinNames
- optional bin to retrieve. All bins will be returned if not specified.
Aerospike 2 servers ignore this parameter.AerospikeException
- if transaction failsRegisterTask register(Policy policy, String clientPath, String serverPath, Language language) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultsclientPath
- path of client file containing user defined functions, relative to current directoryserverPath
- path to store user defined functions on the server, relative to configured script directory.language
- language of user defined functionsAerospikeException
- if register failsRegisterTask register(Policy policy, ClassLoader resourceLoader, String resourcePath, String serverPath, Language language) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultsresourceLoader
- class loader where resource is located. Example: MyClass.class.getClassLoader() or Thread.currentThread().getContextClassLoader() for webappsresourcePath
- class path where Lua resource is locatedserverPath
- path to store user defined functions on the server, relative to configured script directory.language
- language of user defined functionsAerospikeException
- if register failsRegisterTask registerUdfString(Policy policy, String code, String serverPath, Language language) throws AerospikeException
String code =
"local function reducer(val1,val2)\n" +
" return val1 + val2\n" +
"end\n" +
"\n" +
"function sum_single_bin(stream,name)\n" +
" local function mapper(rec)\n" +
" return rec[name]\n" +
" end\n" +
" return stream : map(mapper) : reduce(reducer)\n" +
"end\n";
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.
policy
- generic configuration parameters, pass in null for defaultscode
- code string containing user defined functions.serverPath
- path to store user defined functions on the server, relative to configured script directory.language
- language of user defined functionsAerospikeException
- if register failsvoid removeUdf(InfoPolicy policy, String serverPath) throws AerospikeException
policy
- info configuration parameters, pass in null for defaultsserverPath
- location of UDF on server nodes. Example: mylua.luaAerospikeException
- if remove failsObject execute(WritePolicy policy, Key key, String packageName, String functionName, Value... args) throws AerospikeException
udf file =
policy
- write configuration parameters, pass in null for defaultskey
- unique record identifierpackageName
- server package name where user defined function residesfunctionName
- user defined functionargs
- arguments passed in to user defined functionAerospikeException
- if transaction failsvoid execute(EventLoop eventLoop, ExecuteListener listener, WritePolicy policy, Key key, String packageName, String functionName, Value... functionArgs) throws AerospikeException
The function operates on a single record. The package name is used to locate the udf file location:
udf file =
eventLoop
- event loop that will process the commandlistener
- where to send results, pass in null for fire and forgetpolicy
- write configuration parameters, pass in null for defaultskey
- unique record identifierpackageName
- server package name where user defined function residesfunctionName
- user defined functionfunctionArgs
- arguments passed in to user defined functionAerospikeException
- if event loop registration failsExecuteTask execute(WritePolicy policy, Statement statement, String packageName, String functionName, Value... functionArgs) throws AerospikeException
policy
- write configuration parameters, pass in null for defaultsstatement
- record filterpackageName
- server package where user defined function residesfunctionName
- function namefunctionArgs
- to pass to function name, if anyAerospikeException
- if command failsRecordSet query(QueryPolicy policy, Statement statement) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultsstatement
- database query commandAerospikeException
- if query failsvoid query(EventLoop eventLoop, RecordSequenceListener listener, QueryPolicy policy, Statement statement) throws AerospikeException
Each record result is returned in separate onRecord() calls.
eventLoop
- event loop that will process the commandlistener
- where to send resultspolicy
- query configuration parameters, pass in null for defaultsstatement
- database query commandAerospikeException
- if event loop registration failsRecordSet queryNode(QueryPolicy policy, Statement statement, Node node) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultsstatement
- database query commandnode
- server node to execute queryAerospikeException
- if query failsResultSet queryAggregate(QueryPolicy policy, Statement statement, String packageName, String functionName, Value... functionArgs) throws AerospikeException
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 =
policy
- generic configuration parameters, pass in null for defaultsstatement
- database query commandpackageName
- server package where user defined function residesfunctionName
- aggregation function namefunctionArgs
- arguments to pass to function name, if anyAerospikeException
- if query failsResultSet queryAggregate(QueryPolicy policy, Statement statement) throws AerospikeException
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.
policy
- generic configuration parameters, pass in null for defaultsstatement
- database query commandAerospikeException
- if query failsResultSet queryAggregateNode(QueryPolicy policy, Statement statement, Node node) throws AerospikeException
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.
policy
- generic configuration parameters, pass in null for defaultsstatement
- database query commandnode
- server node to execute queryAerospikeException
- if query failsIndexTask createIndex(Policy policy, String namespace, String setName, String indexName, String binName, IndexType indexType) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultsnamespace
- namespace - equivalent to database namesetName
- optional set name - equivalent to database tableindexName
- name of secondary indexbinName
- bin name that data is indexed onindexType
- underlying data type of secondary indexAerospikeException
- if index create failsIndexTask createIndex(Policy policy, String namespace, String setName, String indexName, String binName, IndexType indexType, IndexCollectionType indexCollectionType) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultsnamespace
- namespace - equivalent to database namesetName
- optional set name - equivalent to database tableindexName
- name of secondary indexbinName
- bin name that data is indexed onindexType
- underlying data type of secondary indexindexCollectionType
- index collection typeAerospikeException
- if index create failsIndexTask dropIndex(Policy policy, String namespace, String setName, String indexName) throws AerospikeException
policy
- generic configuration parameters, pass in null for defaultsnamespace
- namespace - equivalent to database namesetName
- optional set name - equivalent to database tableindexName
- name of secondary indexAerospikeException
- if index create failsvoid createUser(AdminPolicy policy, String user, String password, List<String> roles) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsuser
- user namepassword
- user password in clear-text formatroles
- variable arguments array of role names. Valid roles are listed in Role.csAerospikeException
- if command failsvoid dropUser(AdminPolicy policy, String user) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsuser
- user nameAerospikeException
- if command failsvoid changePassword(AdminPolicy policy, String user, String password) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsuser
- user namepassword
- user password in clear-text formatAerospikeException
- if command failsvoid grantRoles(AdminPolicy policy, String user, List<String> roles) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsuser
- user nameroles
- role names. Valid roles are listed in Role.csAerospikeException
- if command failsvoid revokeRoles(AdminPolicy policy, String user, List<String> roles) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsuser
- user nameroles
- role names. Valid roles are listed in Role.csAerospikeException
- if command failsvoid createRole(AdminPolicy policy, String roleName, List<Privilege> privileges) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsroleName
- role nameprivileges
- privileges assigned to the role.AerospikeException
- if command failsvoid dropRole(AdminPolicy policy, String roleName) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsroleName
- role nameAerospikeException
- if command failsvoid grantPrivileges(AdminPolicy policy, String roleName, List<Privilege> privileges) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsroleName
- role nameprivileges
- privileges assigned to the role.AerospikeException
- if command failsvoid revokePrivileges(AdminPolicy policy, String roleName, List<Privilege> privileges) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsroleName
- role nameprivileges
- privileges assigned to the role.AerospikeException
- if command failsUser queryUser(AdminPolicy policy, String user) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsuser
- user name filterAerospikeException
- if command failsList<User> queryUsers(AdminPolicy policy) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsAerospikeException
- if command failsRole queryRole(AdminPolicy policy, String roleName) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsroleName
- role name filterAerospikeException
- if command failsList<Role> queryRoles(AdminPolicy policy) throws AerospikeException
policy
- admin configuration parameters, pass in null for defaultsAerospikeException
- if command failsCopyright ? 2012–2018 Aerospike, Inc. All rights reserved.