IAerospikeClient (aerospike-client 3.1.9 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

IAsyncClient

All Known Implementing Classes:

AerospikeClient, AsyncClient
```
public interface IAerospikeClient
extends Closeable
```
This interface's sole purpose is to allow mock frameworks to operate on AerospikeClient without being constrained by final methods.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(WritePolicy policy, Key key, Bin... bins)` Add integer bin 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.
`boolean`	`delete(WritePolicy policy, Key key)` Delete record for specified key.
`void`	`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.
`Object`	`execute(Policy policy, Key key, String packageName, String functionName, Value... args)` Deprecated. Use `execute(WritePolicy policy, Key key, String packageName, String functionName, Value... args)` instead.
`ExecuteTask`	`execute(Policy policy, Statement statement, String packageName, String functionName, Value... functionArgs)` Deprecated. Use `execute(WritePolicy policy, Statement statement, String packageName, String functionName, Value... functionArgs)` instead.
`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.
`boolean`	`exists(Policy policy, Key key)` Determine if a record key exists.
`boolean[]`	`exists(Policy policy, Key[] keys)` Deprecated. Use `exists(BatchPolicy, Key[])` instead.
`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.
`Record`	`get(Policy policy, Key key)` Read entire record for specified key.
`Record[]`	`get(Policy policy, Key[] keys)` Deprecated. Use `get(BatchPolicy, Key[])` instead.
`Record[]`	`get(Policy policy, Key[] keys, String... binNames)` Deprecated. Use `get(BatchPolicy, Key[], String...)` instead.
`Record`	`get(Policy policy, Key key, String... binNames)` Read record header and bins for specified key.
`BatchPolicy`	`getBatchPolicyDefault()`
`Record[]`	`getHeader(BatchPolicy policy, Key[] keys)` 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.
`Record[]`	`getHeader(Policy policy, Key[] keys)` Deprecated. Use `getHeader(BatchPolicy, Key[])` instead.
`InfoPolicy`	`getInfoPolicyDefault()`
`LargeList`	`getLargeList(Policy policy, Key key, String binName, String userModule)` Deprecated. Use `getLargeList(WritePolicy policy, Key key, String binName)` instead.
`LargeList`	`getLargeList(WritePolicy policy, Key key, String binName)` Initialize large list operator.
`LargeList`	`getLargeList(WritePolicy policy, Key key, String binName, String userModule)` Deprecated. Use `getLargeList(WritePolicy policy, Key key, String binName)` instead.
`LargeMap`	`getLargeMap(Policy policy, Key key, String binName, String userModule)` Deprecated. Use `getLargeMap(WritePolicy policy, Key key, String binName, String userModule)` instead.
`LargeMap`	`getLargeMap(WritePolicy policy, Key key, String binName, String userModule)` Initialize large map operator.
`LargeSet`	`getLargeSet(Policy policy, Key key, String binName, String userModule)` Deprecated. Use `getLargeSet(WritePolicy policy, Key key, String binName, String userModule)` instead.
`LargeSet`	`getLargeSet(WritePolicy policy, Key key, String binName, String userModule)` Initialize large set operator.
`LargeStack`	`getLargeStack(Policy policy, Key key, String binName, String userModule)` Deprecated. Use `getLargeStack(WritePolicy policy, Key key, String binName, String userModule)` instead.
`LargeStack`	`getLargeStack(WritePolicy policy, Key key, String binName, String userModule)` Initialize large stack operator.
`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.
`Record`	`operate(WritePolicy policy, Key key, Operation... operations)` Perform multiple read/write operations on a single key in one batch call.
`void`	`prepend(WritePolicy policy, Key key, Bin... bins)` Prepend bin string values to existing record bin values.
`void`	`put(WritePolicy policy, Key key, Bin... bins)` Write record bin(s).
`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.
`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.
`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(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(WritePolicy policy, Key key)` Reset record's time to expiration using the policy's expiration.

- Method Detail
  - getReadPolicyDefault
```
Policy getReadPolicyDefault()
```
  - getWritePolicyDefault
```
WritePolicy getWritePolicyDefault()
```
  - getScanPolicyDefault
```
ScanPolicy getScanPolicyDefault()
```
  - getQueryPolicyDefault
```
QueryPolicy getQueryPolicyDefault()
```
  - getBatchPolicyDefault
```
BatchPolicy getBatchPolicyDefault()
```
  - getInfoPolicyDefault
```
InfoPolicy getInfoPolicyDefault()
```
  - close
```
void close()
```
    Close all client connections to database server nodes.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - isConnected
```
boolean isConnected()
```
    Determine if we are ready to talk to the database server cluster.
    
    Returns:
    true if cluster is ready, false if cluster is not ready
  - getNodes
```
Node[] getNodes()
```
    Return array of active server nodes in the cluster.
    
    Returns:
    array of active nodes
  - getNodeNames
```
List<String> getNodeNames()
```
    Return list of active server node names in the cluster.
    
    Returns:
    list of active node names
  - getNode
```
Node getNode(String nodeName)
             throws AerospikeException.InvalidNode
```
    Return node given its name.
    
    Throws:
    
    AerospikeException.InvalidNode - if node does not exist.
  - put
```
void put(WritePolicy policy,
       Key key,
       Bin... bins)
         throws AerospikeException
```
    Write record bin(s). The policy specifies the transaction timeout, record expiration and how the transaction is handled when the record already exists.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    bins - array of bin name/value pairs
    
    Throws:
    
    AerospikeException - if write fails
  - append
```
void append(WritePolicy policy,
          Key key,
          Bin... bins)
            throws AerospikeException
```
    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.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    bins - array of bin name/value pairs
    
    Throws:
    
    AerospikeException - if append fails
  - prepend
```
void prepend(WritePolicy policy,
           Key key,
           Bin... bins)
             throws AerospikeException
```
    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.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    bins - array of bin name/value pairs
    
    Throws:
    
    AerospikeException - if prepend fails
  - add
```
void add(WritePolicy policy,
       Key key,
       Bin... bins)
         throws AerospikeException
```
    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.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    bins - array of bin name/value pairs
    
    Throws:
    
    AerospikeException - if add fails
  - delete
```
boolean delete(WritePolicy policy,
             Key key)
               throws AerospikeException
```
    Delete record for specified key. The policy specifies the transaction timeout.
    
    Parameters:
    policy - delete configuration parameters, pass in null for defaults
    key - unique record identifier
    
    Returns:
    whether record existed on server before deletion
    
    Throws:
    
    AerospikeException - if delete fails
  - touch
```
void touch(WritePolicy policy,
         Key key)
           throws AerospikeException
```
    Reset record's time to expiration using the policy's expiration. Fail if the record does not exist.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    
    Throws:
    
    AerospikeException - if touch fails
  - exists
```
boolean exists(Policy policy,
             Key key)
               throws AerospikeException
```
    Determine if a record key exists. The policy can be used to specify timeouts.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    key - unique record identifier
    
    Returns:
    whether record exists or not
    
    Throws:
    
    AerospikeException - if command fails
  - exists
```
@Deprecated
boolean[] exists(Policy policy,
                          Key[] keys)
                 throws AerospikeException
```
    Deprecated. Use exists(BatchPolicy, Key[]) instead.
    
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    keys - array of unique record identifiers
    
    Returns:
    array key/existence status pairs
    
    Throws:
    
    AerospikeException - if command fails
  - exists
```
boolean[] exists(BatchPolicy policy,
               Key[] keys)
                 throws AerospikeException
```
    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.
    
    Parameters:
    policy - batch configuration parameters, pass in null for defaults
    keys - array of unique record identifiers
    
    Returns:
    array key/existence status pairs
    
    Throws:
    
    AerospikeException - if command fails
  - get
```
Record get(Policy policy,
         Key key)
           throws AerospikeException
```
    Read entire record for specified key. The policy can be used to specify timeouts.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    key - unique record identifier
    
    Returns:
    if found, return record instance. If not found, return null.
    
    Throws:
    
    AerospikeException - if read fails
  - get
```
Record get(Policy policy,
         Key key,
         String... binNames)
           throws AerospikeException
```
    Read record header and bins for specified key. The policy can be used to specify timeouts.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    key - unique record identifier
    binNames - bins to retrieve
    
    Returns:
    if found, return record instance. If not found, return null.
    
    Throws:
    
    AerospikeException - if read fails
  - getHeader
```
Record getHeader(Policy policy,
               Key key)
                 throws AerospikeException
```
    Read record generation and expiration only for specified key. Bins are not read. The policy can be used to specify timeouts.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    key - unique record identifier
    
    Returns:
    if found, return record instance. If not found, return null.
    
    Throws:
    
    AerospikeException - if read fails
  - get
```
void get(BatchPolicy policy,
       List<BatchRead> records)
         throws AerospikeException
```
    Read multiple records for specified batch keys in one batch call. 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 and maximum concurrent threads. This method requires Aerospike Server version >= 3.6.0.
    
    Parameters:
    policy - batch configuration parameters, pass in null for defaults
    records - list of unique record identifiers and the bins to retrieve. The returned records are located in the same list.
    
    Throws:
    
    AerospikeException - if read fails
  - get
```
@Deprecated
Record[] get(Policy policy,
                      Key[] keys)
             throws AerospikeException
```
    Deprecated. Use get(BatchPolicy, Key[]) instead.
    
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    keys - array of unique record identifiers
    
    Returns:
    array of records
    
    Throws:
    
    AerospikeException - if read fails
  - get
```
Record[] get(BatchPolicy policy,
           Key[] keys)
             throws AerospikeException
```
    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.
    
    Parameters:
    policy - batch configuration parameters, pass in null for defaults
    keys - array of unique record identifiers
    
    Returns:
    array of records
    
    Throws:
    
    AerospikeException - if read fails
  - get
```
@Deprecated
Record[] get(Policy policy,
                      Key[] keys,
                      String... binNames)
             throws AerospikeException
```
    Deprecated. Use get(BatchPolicy, Key[], String...) instead.
    
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    keys - array of unique record identifiers
    binNames - array of bins to retrieve
    
    Returns:
    array of records
    
    Throws:
    
    AerospikeException - if read fails
  - get
```
Record[] get(BatchPolicy policy,
           Key[] keys,
           String... binNames)
             throws AerospikeException
```
    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.
    
    Parameters:
    policy - batch configuration parameters, pass in null for defaults
    keys - array of unique record identifiers
    binNames - array of bins to retrieve
    
    Returns:
    array of records
    
    Throws:
    
    AerospikeException - if read fails
  - getHeader
```
@Deprecated
Record[] getHeader(Policy policy,
                            Key[] keys)
                   throws AerospikeException
```
    Deprecated. Use getHeader(BatchPolicy, Key[]) instead.
    
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    keys - array of unique record identifiers
    
    Returns:
    array of records
    
    Throws:
    
    AerospikeException - if read fails
  - getHeader
```
Record[] getHeader(BatchPolicy policy,
                 Key[] keys)
                   throws AerospikeException
```
    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.
    
    Parameters:
    policy - batch configuration parameters, pass in null for defaults
    keys - array of unique record identifiers
    
    Returns:
    array of records
    
    Throws:
    
    AerospikeException - if read fails
  - operate
```
Record operate(WritePolicy policy,
             Key key,
             Operation... operations)
               throws AerospikeException
```
    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.
    Write operations are always performed first, regardless of operation order relative to read operations.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    operations - database operations to perform
    
    Returns:
    record if there is a read in the operations list
    
    Throws:
    
    AerospikeException - if command fails
  - scanAll
```
void scanAll(ScanPolicy policy,
           String namespace,
           String setName,
           ScanCallback callback,
           String... binNames)
             throws AerospikeException
```
    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.
    
    Parameters:
    policy - scan configuration parameters, pass in null for defaults
    namespace - namespace - equivalent to database name
    setName - optional set name - equivalent to database table
    callback - read callback method - called with record data
    binNames - optional bin to retrieve. All bins will be returned if not specified. Aerospike 2 servers ignore this parameter.
    
    Throws:
    
    AerospikeException - if scan fails
  - scanNode
```
void scanNode(ScanPolicy policy,
            String nodeName,
            String namespace,
            String setName,
            ScanCallback callback,
            String... binNames)
              throws AerospikeException
```
    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.
    
    Parameters:
    policy - scan configuration parameters, pass in null for defaults
    nodeName - server node name
    namespace - namespace - equivalent to database name
    setName - optional set name - equivalent to database table
    callback - read callback method - called with record data
    binNames - optional bin to retrieve. All bins will be returned if not specified. Aerospike 2 servers ignore this parameter.
    
    Throws:
    
    AerospikeException - if scan fails
  - scanNode
```
void scanNode(ScanPolicy policy,
            Node node,
            String namespace,
            String setName,
            ScanCallback callback,
            String... binNames)
              throws AerospikeException
```
    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.
    
    Parameters:
    policy - scan configuration parameters, pass in null for defaults
    node - server node
    namespace - namespace - equivalent to database name
    setName - optional set name - equivalent to database table
    callback - read callback method - called with record data
    binNames - optional bin to retrieve. All bins will be returned if not specified. Aerospike 2 servers ignore this parameter.
    
    Throws:
    
    AerospikeException - if transaction fails
  - getLargeList
```
LargeList getLargeList(Policy policy,
                     Key key,
                     String binName,
                     String userModule)
```
    Deprecated. Use getLargeList(WritePolicy policy, Key key, String binName) instead.
    
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    key - unique record identifier
    binName - bin name
    userModule - no longer used, pass in null.
  - getLargeList
```
LargeList getLargeList(WritePolicy policy,
                     Key key,
                     String binName,
                     String userModule)
```
    Deprecated. Use getLargeList(WritePolicy policy, Key key, String binName) instead.
    
    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.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    binName - bin name
    userModule - no longer used, pass in null.
  - getLargeList
```
LargeList getLargeList(WritePolicy policy,
                     Key key,
                     String binName)
```
    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.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    binName - bin name
  - getLargeMap
```
LargeMap getLargeMap(Policy policy,
                   Key key,
                   String binName,
                   String userModule)
```
    Deprecated. Use getLargeMap(WritePolicy policy, Key key, String binName, String userModule) instead.
    
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    key - unique record identifier
    binName - bin name
    userModule - Lua function name that initializes list configuration parameters, pass null for default
  - getLargeMap
```
LargeMap getLargeMap(WritePolicy policy,
                   Key key,
                   String binName,
                   String userModule)
```
    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.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    binName - bin name
    userModule - Lua function name that initializes list configuration parameters, pass null for default
  - getLargeSet
```
LargeSet getLargeSet(Policy policy,
                   Key key,
                   String binName,
                   String userModule)
```
    Deprecated. Use getLargeSet(WritePolicy policy, Key key, String binName, String userModule) instead.
    
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    key - unique record identifier
    binName - bin name
    userModule - Lua function name that initializes list configuration parameters, pass null for default
  - getLargeSet
```
LargeSet getLargeSet(WritePolicy policy,
                   Key key,
                   String binName,
                   String userModule)
```
    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.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    binName - bin name
    userModule - Lua function name that initializes list configuration parameters, pass null for default
  - getLargeStack
```
LargeStack getLargeStack(Policy policy,
                       Key key,
                       String binName,
                       String userModule)
```
    Deprecated. Use getLargeStack(WritePolicy policy, Key key, String binName, String userModule) instead.
    
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    key - unique record identifier
    binName - bin name
    userModule - Lua function name that initializes list configuration parameters, pass null for default
  - getLargeStack
```
LargeStack getLargeStack(WritePolicy policy,
                       Key key,
                       String binName,
                       String userModule)
```
    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.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    binName - bin name
    userModule - Lua function name that initializes list configuration parameters, pass null for default
  - register
```
RegisterTask register(Policy policy,
                    String clientPath,
                    String serverPath,
                    Language language)
                      throws AerospikeException
```
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    clientPath - path of client file containing user defined functions, relative to current directory
    serverPath - path to store user defined functions on the server, relative to configured script directory.
    language - language of user defined functions
    
    Throws:
    
    AerospikeException - if register fails
  - register
```
RegisterTask register(Policy policy,
                    ClassLoader resourceLoader,
                    String resourcePath,
                    String serverPath,
                    Language language)
                      throws AerospikeException
```
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    resourceLoader - class loader where resource is located. Example: MyClass.class.getClassLoader() or Thread.currentThread().getContextClassLoader() for webapps
    resourcePath - class path where Lua resource is located
    serverPath - path to store user defined functions on the server, relative to configured script directory.
    language - language of user defined functions
    
    Throws:
    
    AerospikeException - if register fails
  - removeUdf
```
void removeUdf(InfoPolicy policy,
             String serverPath)
               throws AerospikeException
```
    Remove user defined function from server nodes.
    
    Parameters:
    policy - info configuration parameters, pass in null for defaults
    serverPath - location of UDF on server nodes. Example: mylua.lua
    
    Throws:
    
    AerospikeException - if remove fails
  - execute
```
Object execute(Policy policy,
             Key key,
             String packageName,
             String functionName,
             Value... args)
               throws AerospikeException
```
    Deprecated. Use execute(WritePolicy policy, Key key, String packageName, String functionName, Value... args) instead.
    
    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 = /.lua
    This method is only supported by Aerospike 3 servers.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    key - unique record identifier
    packageName - server package name where user defined function resides
    functionName - user defined function
    args - arguments passed in to user defined function
    
    Returns:
    return value of user defined function
    
    Throws:
    
    AerospikeException - if transaction fails
  - execute
```
Object execute(WritePolicy policy,
             Key key,
             String packageName,
             String functionName,
             Value... args)
               throws AerospikeException
```
    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 = /.lua
    This method is only supported by Aerospike 3 servers.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    key - unique record identifier
    packageName - server package name where user defined function resides
    functionName - user defined function
    args - arguments passed in to user defined function
    
    Returns:
    return value of user defined function
    
    Throws:
    
    AerospikeException - if transaction fails
  - execute
```
ExecuteTask execute(Policy policy,
                  Statement statement,
                  String packageName,
                  String functionName,
                  Value... functionArgs)
                    throws AerospikeException
```
    Deprecated. Use execute(WritePolicy policy, Statement statement, String packageName, String functionName, Value... functionArgs) instead.
    
    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.
    
    Parameters:
    policy - scan configuration parameters, pass in null for defaults
    statement - record filter
    packageName - server package where user defined function resides
    functionName - function name
    functionArgs - to pass to function name, if any
    
    Throws:
    
    AerospikeException - if command fails
  - execute
```
ExecuteTask execute(WritePolicy policy,
                  Statement statement,
                  String packageName,
                  String functionName,
                  Value... functionArgs)
                    throws AerospikeException
```
    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.
    
    Parameters:
    policy - write configuration parameters, pass in null for defaults
    statement - record filter
    packageName - server package where user defined function resides
    functionName - function name
    functionArgs - to pass to function name, if any
    
    Throws:
    
    AerospikeException - if command fails
  - query
```
RecordSet query(QueryPolicy policy,
              Statement statement)
                throws AerospikeException
```
    Execute query on all server nodes 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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    statement - database query command
    
    Returns:
    record iterator
    
    Throws:
    
    AerospikeException - if query fails
  - queryNode
```
RecordSet queryNode(QueryPolicy policy,
                  Statement statement,
                  Node node)
                    throws AerospikeException
```
    Execute query on a single server node and return record iterator. The query executor puts records on a queue in a separate thread. The calling thread concurrently pops records off the queue through the record iterator.
    This method is only supported by Aerospike 3 servers.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    statement - database query command
    
    Returns:
    record iterator
    
    Throws:
    
    AerospikeException - if query fails
  - queryAggregate
```
ResultSet queryAggregate(QueryPolicy policy,
                       Statement statement,
                       String packageName,
                       String functionName,
                       Value... functionArgs)
                         throws AerospikeException
```
    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 = /.lua
    This method is only supported by Aerospike 3 servers.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    statement - database query command
    packageName - server package where user defined function resides
    functionName - aggregation function name
    functionArgs - arguments to pass to function name, if any
    
    Returns:
    result iterator
    
    Throws:
    
    AerospikeException - if query fails
  - queryAggregate
```
ResultSet queryAggregate(QueryPolicy policy,
                       Statement statement)
                         throws AerospikeException
```
    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 resource or a filesystem file.
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    statement - database query command
    
    Throws:
    
    AerospikeException - if query fails
  - createIndex
```
IndexTask createIndex(Policy policy,
                    String namespace,
                    String setName,
                    String indexName,
                    String binName,
                    IndexType indexType)
                      throws AerospikeException
```
    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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    namespace - namespace - equivalent to database name
    setName - optional set name - equivalent to database table
    indexName - name of secondary index
    binName - bin name that data is indexed on
    indexType - underlying data type of secondary index
    
    Throws:
    
    AerospikeException - if index create fails
  - createIndex
```
IndexTask createIndex(Policy policy,
                    String namespace,
                    String setName,
                    String indexName,
                    String binName,
                    IndexType indexType,
                    IndexCollectionType indexCollectionType)
                      throws AerospikeException
```
    Create complex secondary index to be used 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.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    namespace - namespace - equivalent to database name
    setName - optional set name - equivalent to database table
    indexName - name of secondary index
    binName - bin name that data is indexed on
    indexType - underlying data type of secondary index
    indexCollectionType - index collection type
    
    Throws:
    
    AerospikeException - if index create fails
  - dropIndex
```
void dropIndex(Policy policy,
             String namespace,
             String setName,
             String indexName)
               throws AerospikeException
```
    Delete secondary index. This method is only supported by Aerospike 3 servers.
    
    Parameters:
    policy - generic configuration parameters, pass in null for defaults
    namespace - namespace - equivalent to database name
    setName - optional set name - equivalent to database table
    indexName - name of secondary index
    
    Throws:
    
    AerospikeException - if index create fails
  - createUser
```
void createUser(AdminPolicy policy,
              String user,
              String password,
              List<String> roles)
                throws AerospikeException
```
    Create user with password and roles. Clear-text password will be hashed using bcrypt before sending to server.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    user - user name
    password - user password in clear-text format
    roles - variable arguments array of role names. Valid roles are listed in Role.cs
    
    Throws:
    
    AerospikeException - if command fails
  - dropUser
```
void dropUser(AdminPolicy policy,
            String user)
              throws AerospikeException
```
    Remove user from cluster.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    user - user name
    
    Throws:
    
    AerospikeException - if command fails
  - changePassword
```
void changePassword(AdminPolicy policy,
                  String user,
                  String password)
                    throws AerospikeException
```
    Change user's password. Clear-text password will be hashed using bcrypt before sending to server.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    user - user name
    password - user password in clear-text format
    
    Throws:
    
    AerospikeException - if command fails
  - grantRoles
```
void grantRoles(AdminPolicy policy,
              String user,
              List<String> roles)
                throws AerospikeException
```
    Add roles to user's list of roles.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    user - user name
    roles - role names. Valid roles are listed in Role.cs
    
    Throws:
    
    AerospikeException - if command fails
  - revokeRoles
```
void revokeRoles(AdminPolicy policy,
               String user,
               List<String> roles)
                 throws AerospikeException
```
    Remove roles from user's list of roles.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    user - user name
    roles - role names. Valid roles are listed in Role.cs
    
    Throws:
    
    AerospikeException - if command fails
  - createRole
```
void createRole(AdminPolicy policy,
              String roleName,
              List<Privilege> privileges)
                throws AerospikeException
```
    Create user defined role.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    roleName - role name
    privileges - privileges assigned to the role.
    
    Throws:
    
    AerospikeException - if command fails
  - dropRole
```
void dropRole(AdminPolicy policy,
            String roleName)
              throws AerospikeException
```
    Drop user defined role.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    roleName - role name
    
    Throws:
    
    AerospikeException - if command fails
  - grantPrivileges
```
void grantPrivileges(AdminPolicy policy,
                   String roleName,
                   List<Privilege> privileges)
                     throws AerospikeException
```
    Grant privileges to an user defined role.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    roleName - role name
    privileges - privileges assigned to the role.
    
    Throws:
    
    AerospikeException - if command fails
  - revokePrivileges
```
void revokePrivileges(AdminPolicy policy,
                    String roleName,
                    List<Privilege> privileges)
                      throws AerospikeException
```
    Revoke privileges from an user defined role.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    roleName - role name
    privileges - privileges assigned to the role.
    
    Throws:
    
    AerospikeException - if command fails
  - queryUser
```
User queryUser(AdminPolicy policy,
             String user)
               throws AerospikeException
```
    Retrieve roles for a given user.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    user - user name filter
    
    Throws:
    
    AerospikeException - if command fails
  - queryUsers
```
List<User> queryUsers(AdminPolicy policy)
                      throws AerospikeException
```
    Retrieve all users and their roles.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    
    Throws:
    
    AerospikeException - if command fails
  - queryRole
```
Role queryRole(AdminPolicy policy,
             String roleName)
               throws AerospikeException
```
    Retrieve role definition.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    roleName - role name filter
    
    Throws:
    
    AerospikeException - if command fails
  - queryRoles
```
List<Role> queryRoles(AdminPolicy policy)
                      throws AerospikeException
```
    Retrieve all roles.
    
    Parameters:
    policy - admin configuration parameters, pass in null for defaults
    
    Throws:
    
    AerospikeException - if command fails

Interface IAerospikeClient

Method Summary

Method Detail

getReadPolicyDefault

getWritePolicyDefault

getScanPolicyDefault

getQueryPolicyDefault

getBatchPolicyDefault

getInfoPolicyDefault

close

isConnected

getNodes

getNodeNames

getNode

put

append

prepend

add

delete

touch

exists

exists

exists

get

get

getHeader

get

get

get

get

get

getHeader

getHeader

operate

scanAll

scanNode

scanNode

getLargeList

getLargeList

getLargeList

getLargeMap

getLargeMap

getLargeSet

getLargeSet

getLargeStack

getLargeStack

register

register

removeUdf

execute

execute

execute

execute

query

queryNode

queryAggregate

queryAggregate

createIndex

createIndex

dropIndex

createUser

dropUser

changePassword

grantRoles

revokeRoles

createRole

dropRole

grantPrivileges

revokePrivileges

queryUser

queryUsers

queryRole

queryRoles