io.d11.aerospike.client

Interface AerospikeClient

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

AerospikeClientImpl

public interface AerospikeClient
extends java.lang.AutoCloseable

The AerospikeClient interface provides an abstraction on top of aerospike's client for integrating its asynchronous commands in Vert.x-based Applications.

Method Summary

Modifier and Type	Method and Description
AerospikeClient	add(com.aerospike.client.policy.WritePolicy writePolicy, com.aerospike.client.Key key, com.aerospike.client.Bin[] bins, io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler) Asynchronously add integer/double bin values to existing record bin values.
AerospikeClient	append(com.aerospike.client.policy.WritePolicy writePolicy, com.aerospike.client.Key key, com.aerospike.client.Bin[] bins, io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler) Asynchronously append bin string values to existing record bin values.
void	close() Close all client connections to database server nodes.
static AerospikeClient	create(io.vertx.core.Vertx vertx) Like create(Vertx, AerospikeConnectOptions) with default options.
static AerospikeClient	create(io.vertx.core.Vertx vertx, AerospikeConnectOptions connectOptions) Create a shared aerospike client using the given connect options.
static AerospikeClient	createNonShared(io.vertx.core.Vertx vertx) Like createNonShared(Vertx, AerospikeConnectOptions) with default options.
static AerospikeClient	createNonShared(io.vertx.core.Vertx vertx, AerospikeConnectOptions connectOptions) Create a non shared aerospike client using the given connect options.
AerospikeClient	delete(com.aerospike.client.policy.WritePolicy writePolicy, com.aerospike.client.Key key, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>> handler) Asynchronously delete record for specified key.
AerospikeClient	execute(com.aerospike.client.policy.WritePolicy writePolicy, com.aerospike.client.Key key, java.lang.String packageName, java.lang.String functionName, com.aerospike.client.Value[] functionArgs, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Object>> handler) Asynchronously execute user defined function on server.
AerospikeClient	exists(com.aerospike.client.policy.BatchPolicy batchPolicy, com.aerospike.client.Key[] keys, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<java.lang.Boolean>>> handler) Asynchronously check if multiple record keys exist in one batch call.
AerospikeClient	exists(com.aerospike.client.policy.Policy policy, com.aerospike.client.Key key, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>> handler) Asynchronously determine if a record key exists.
AerospikeClient	get(com.aerospike.client.policy.BatchPolicy batchPolicy, com.aerospike.client.Key[] keys, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.Record>>> handler) Asynchronously read multiple records for specified keys in one batch call.
AerospikeClient	get(com.aerospike.client.policy.BatchPolicy batchPolicy, com.aerospike.client.Key[] keys, java.lang.String[] binNames, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.Record>>> handler) Asynchronously read multiple record headers and bins for specified keys in one batch call.
AerospikeClient	get(com.aerospike.client.policy.BatchPolicy batchPolicy, java.util.List<com.aerospike.client.BatchRead> records, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.BatchRead>>> handler) Asynchronously read multiple records for specified batch keys in one batch call.
AerospikeClient	get(com.aerospike.client.policy.Policy policy, com.aerospike.client.Key key, io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Record>> handler) Asynchronously read entire record for specified key.
AerospikeClient	get(com.aerospike.client.policy.Policy policy, com.aerospike.client.Key key, java.lang.String[] binNames, io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Record>> handler) Asynchronously read record header and bins for specified key.
com.aerospike.client.AerospikeClient	getAerospikeClient() Get the underlying AerospikeClient
AerospikeClient	getClusterStats(io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.cluster.ClusterStats>> handler) Return operating cluster statistics.
AerospikeClient	getHeader(com.aerospike.client.policy.BatchPolicy batchPolicy, com.aerospike.client.Key[] keys, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.Record>>> handler) Asynchronously read multiple record header data for specified keys in one batch call.
AerospikeClient	getHeader(com.aerospike.client.policy.Policy policy, com.aerospike.client.Key key, io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Record>> handler) Asynchronously read record generation and expiration only for specified key.
AerospikeClient	isConnected(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>> handler) Determine if we are ready to talk to the database server cluster.
AerospikeClient	operate(com.aerospike.client.policy.WritePolicy writePolicy, com.aerospike.client.Key key, com.aerospike.client.Operation[] operations, io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Record>> handler) Asynchronously perform multiple read/write operations on a single key in one batch call.
AerospikeClient	prepend(com.aerospike.client.policy.WritePolicy writePolicy, com.aerospike.client.Key key, com.aerospike.client.Bin[] bins, io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler) Asynchronously prepend bin string values to existing record bin values.
AerospikeClient	put(com.aerospike.client.policy.WritePolicy writePolicy, com.aerospike.client.Key key, com.aerospike.client.Bin[] bins, io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler) Asynchronously write record bin(s).
AerospikeClient	query(com.aerospike.client.policy.QueryPolicy queryPolicy, com.aerospike.client.query.Statement statement, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.query.KeyRecord>>> handler) Asynchronously execute query on all server nodes.
AerospikeClient	scanAll(com.aerospike.client.policy.ScanPolicy policy, java.lang.String namespace, java.lang.String setName, java.lang.String[] binNames, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.query.KeyRecord>>> handler) Asynchronously read all records in specified namespace and set
AerospikeClient	scanPartitions(com.aerospike.client.policy.ScanPolicy policy, com.aerospike.client.query.PartitionFilter partitionFilter, java.lang.String namespace, java.lang.String setName, java.lang.String[] binNames, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.query.KeyRecord>>> handler) Asynchronously read records in specified namespace, set and partition filter.
AerospikeClient	touch(com.aerospike.client.policy.WritePolicy writePolicy, com.aerospike.client.Key key, io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler) Asynchronously reset record's time to expiration using the policy's expiration.

Method Detail

create

static AerospikeClient create(io.vertx.core.Vertx vertx,
                              AerospikeConnectOptions connectOptions)

Create a shared aerospike client using the given connect options. The client will be shared across a vertx instance

Parameters:

vertx - the vertx instance

connectOptions - user provided connection options

Returns:

the client

create

static AerospikeClient create(io.vertx.core.Vertx vertx)

Like create(Vertx, AerospikeConnectOptions) with default options.

Parameters:

vertx - the vertx instance

Returns:

the client

createNonShared

static AerospikeClient createNonShared(io.vertx.core.Vertx vertx,
                                       AerospikeConnectOptions connectOptions)

Create a non shared aerospike client using the given connect options. It is not recommended to create several non shared clients in an application.

Parameters:

vertx - the vertx instance

connectOptions - user provided connection options

Returns:

the client

createNonShared

static AerospikeClient createNonShared(io.vertx.core.Vertx vertx)

Like createNonShared(Vertx, AerospikeConnectOptions) with default options.

Parameters:

vertx - the vertx instance

Returns:

the client

isConnected

AerospikeClient isConnected(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>> handler)

Determine if we are ready to talk to the database server cluster.

Parameters:

handler - the handler that will handle response

Returns:

current Aerospike client instance

See Also:

AerospikeClient.isConnected()

getClusterStats

AerospikeClient getClusterStats(io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.cluster.ClusterStats>> handler)

Return operating cluster statistics.

Parameters:

handler - the handler that will handle the received cluster statistics

Returns:

current Aerospike client instance

See Also:

AerospikeClient.getClusterStats()

close

void close()

Close all client connections to database server nodes.

Specified by:

close in interface java.lang.AutoCloseable

See Also:

AerospikeClient.close()

getAerospikeClient

com.aerospike.client.AerospikeClient getAerospikeClient()

Get the underlying AerospikeClient

Returns:

the com.aerospike.client.AerospikeClient instance which is used internally.

put

AerospikeClient put(com.aerospike.client.policy.WritePolicy writePolicy,
                    com.aerospike.client.Key key,
                    com.aerospike.client.Bin[] bins,
                    io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler)
             throws com.aerospike.client.AerospikeException

Asynchronously write record bin(s).

Parameters:

writePolicy - write configuration parameters, pass in null for defaults

key - unique record identifier

bins - array of bin name/value pairs

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.put(EventLoop, WriteListener, WritePolicy, Key, Bin...)

append

AerospikeClient append(com.aerospike.client.policy.WritePolicy writePolicy,
                       com.aerospike.client.Key key,
                       com.aerospike.client.Bin[] bins,
                       io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler)
                throws com.aerospike.client.AerospikeException

Asynchronously append bin string values to existing record bin values.

Parameters:

writePolicy - write configuration parameters, pass in null for defaults

key - unique record identifier

bins - array of bin name/value pairs

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.append(EventLoop, WriteListener, WritePolicy, Key, Bin...)

prepend

AerospikeClient prepend(com.aerospike.client.policy.WritePolicy writePolicy,
                        com.aerospike.client.Key key,
                        com.aerospike.client.Bin[] bins,
                        io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler)
                 throws com.aerospike.client.AerospikeException

Asynchronously prepend bin string values to existing record bin values.

Parameters:

writePolicy - write configuration parameters, pass in null for defaults

key - unique record identifier

bins - array of bin name/value pairs

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.prepend(WritePolicy, Key, Bin...)

add

AerospikeClient add(com.aerospike.client.policy.WritePolicy writePolicy,
                    com.aerospike.client.Key key,
                    com.aerospike.client.Bin[] bins,
                    io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler)
             throws com.aerospike.client.AerospikeException

Asynchronously add integer/double bin values to existing record bin values.

Parameters:

writePolicy - write configuration parameters, pass in null for defaults

key - unique record identifier

bins - array of bin name/value pairs

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.add(EventLoop, WriteListener, WritePolicy, Key, Bin...)

delete

AerospikeClient delete(com.aerospike.client.policy.WritePolicy writePolicy,
                       com.aerospike.client.Key key,
                       io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>> handler)
                throws com.aerospike.client.AerospikeException

Asynchronously delete record for specified key.

Parameters:

writePolicy - write configuration parameters, pass in null for defaults

key - unique record identifier

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.delete(EventLoop, DeleteListener, WritePolicy, Key)

touch

AerospikeClient touch(com.aerospike.client.policy.WritePolicy writePolicy,
                      com.aerospike.client.Key key,
                      io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Key>> handler)
               throws com.aerospike.client.AerospikeException

Asynchronously reset record's time to expiration using the policy's expiration.

Parameters:

writePolicy - write configuration parameters, pass in null for defaults

key - unique record identifier

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.touch(EventLoop, WriteListener, WritePolicy, Key)

exists

AerospikeClient exists(com.aerospike.client.policy.Policy policy,
                       com.aerospike.client.Key key,
                       io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>> handler)
                throws com.aerospike.client.AerospikeException

Asynchronously determine if a record key exists.

Parameters:

policy - generic configuration parameters, pass in null for defaults

key - unique record identifier

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.exists(EventLoop, ExistsListener, Policy, Key)

exists

AerospikeClient exists(com.aerospike.client.policy.BatchPolicy batchPolicy,
                       com.aerospike.client.Key[] keys,
                       io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<java.lang.Boolean>>> handler)
                throws com.aerospike.client.AerospikeException

Asynchronously check if multiple record keys exist in one batch call.

Parameters:

batchPolicy - batch configuration parameters, pass in null for defaults

keys - unique record identifiers

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.exists(EventLoop, ExistsArrayListener, BatchPolicy, Key[])

get

AerospikeClient get(com.aerospike.client.policy.Policy policy,
                    com.aerospike.client.Key key,
                    io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Record>> handler)
             throws com.aerospike.client.AerospikeException

Asynchronously read entire record for specified key.

Parameters:

policy - generic configuration parameters, pass in null for defaults

key - unique record identifier

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.get(EventLoop, RecordListener, Policy, Key)

get

AerospikeClient get(com.aerospike.client.policy.Policy policy,
                    com.aerospike.client.Key key,
                    java.lang.String[] binNames,
                    io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Record>> handler)
             throws com.aerospike.client.AerospikeException

Asynchronously read record header and bins for specified key.

Parameters:

policy - generic configuration parameters, pass in null for defaults

key - unique record identifier

binNames - bins to retrieve

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.get(EventLoop, RecordListener, Policy, Key, String...)

getHeader

AerospikeClient getHeader(com.aerospike.client.policy.Policy policy,
                          com.aerospike.client.Key key,
                          io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Record>> handler)
                   throws com.aerospike.client.AerospikeException

Asynchronously read record generation and expiration only for specified key. Bins are not read.

Parameters:

policy - generic configuration parameters, pass in null for defaults

key - unique record identifier

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.getHeader(EventLoop, RecordListener, Policy, Key)

get

AerospikeClient get(com.aerospike.client.policy.BatchPolicy batchPolicy,
                    java.util.List<com.aerospike.client.BatchRead> records,
                    io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.BatchRead>>> handler)
             throws com.aerospike.client.AerospikeException

Asynchronously read multiple records for specified batch keys in one batch call.

Parameters:

batchPolicy - 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.

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.get(EventLoop, BatchListListener, BatchPolicy, List)

get

AerospikeClient get(com.aerospike.client.policy.BatchPolicy batchPolicy,
                    com.aerospike.client.Key[] keys,
                    io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.Record>>> handler)
             throws com.aerospike.client.AerospikeException

Asynchronously read multiple records for specified keys in one batch call.

Parameters:

batchPolicy - batch configuration parameters, pass in null for defaults

keys - array of unique record identifiers

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.get(EventLoop, RecordArrayListener, BatchPolicy, Key[])

get

AerospikeClient get(com.aerospike.client.policy.BatchPolicy batchPolicy,
                    com.aerospike.client.Key[] keys,
                    java.lang.String[] binNames,
                    io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.Record>>> handler)
             throws com.aerospike.client.AerospikeException

Asynchronously read multiple record headers and bins for specified keys in one batch call.

Parameters:

batchPolicy - batch configuration parameters, pass in null for defaults

keys - array of unique record identifiers

binNames - array of bins to retrieve

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.get(EventLoop, RecordArrayListener, BatchPolicy, Key[], String...)

getHeader

AerospikeClient getHeader(com.aerospike.client.policy.BatchPolicy batchPolicy,
                          com.aerospike.client.Key[] keys,
                          io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.Record>>> handler)
                   throws com.aerospike.client.AerospikeException

Asynchronously read multiple record header data for specified keys in one batch call.

Parameters:

batchPolicy - batch configuration parameters, pass in null for defaults

keys - array of unique record identifiers

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.getHeader(EventLoop, RecordArrayListener, BatchPolicy, Key[])

operate

AerospikeClient operate(com.aerospike.client.policy.WritePolicy writePolicy,
                        com.aerospike.client.Key key,
                        com.aerospike.client.Operation[] operations,
                        io.vertx.core.Handler<io.vertx.core.AsyncResult<com.aerospike.client.Record>> handler)
                 throws com.aerospike.client.AerospikeException

Asynchronously perform multiple read/write operations on a single key in one batch call.

Parameters:

writePolicy - write configuration parameters, pass in null for defaults

key - unique record identifier

operations - database operations to perform

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.operate(EventLoop, RecordListener, WritePolicy, Key, Operation...)

scanAll

AerospikeClient scanAll(com.aerospike.client.policy.ScanPolicy policy,
                        java.lang.String namespace,
                        java.lang.String setName,
                        java.lang.String[] binNames,
                        io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.query.KeyRecord>>> handler)
                 throws com.aerospike.client.AerospikeException

Asynchronously read all records in specified namespace and set

Parameters:

policy - scan configuration parameters, pass in null for defaults

namespace - namespace - equivalent to database name

setName - optional set name - equivalent to database table

binNames - optional bins to retrieve. All bins will be returned if empty.

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.scanAll(EventLoop, RecordSequenceListener, ScanPolicy, String, String, String...)

scanPartitions

AerospikeClient scanPartitions(com.aerospike.client.policy.ScanPolicy policy,
                               com.aerospike.client.query.PartitionFilter partitionFilter,
                               java.lang.String namespace,
                               java.lang.String setName,
                               java.lang.String[] binNames,
                               io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.query.KeyRecord>>> handler)
                        throws com.aerospike.client.AerospikeException

Asynchronously read records in specified namespace, set and partition filter.

Parameters:

policy - scan configuration parameters, pass in null for defaults

partitionFilter - filter on a subset of data partitions

namespace - namespace - equivalent to database name

setName - optional set name - equivalent to database table

binNames - optional bins to retrieve. All bins will be returned if empty.

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.scanPartitions(EventLoop, RecordSequenceListener, ScanPolicy, PartitionFilter, String, String, String...)

execute

AerospikeClient execute(com.aerospike.client.policy.WritePolicy writePolicy,
                        com.aerospike.client.Key key,
                        java.lang.String packageName,
                        java.lang.String functionName,
                        com.aerospike.client.Value[] functionArgs,
                        io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Object>> handler)
                 throws com.aerospike.client.AerospikeException

Asynchronously execute user defined function on server.

Parameters:

writePolicy - 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

functionArgs - arguments passed in to user defined function

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.execute(EventLoop, ExecuteListener, WritePolicy, Key, String, String, Value...)

query

AerospikeClient query(com.aerospike.client.policy.QueryPolicy queryPolicy,
                      com.aerospike.client.query.Statement statement,
                      io.vertx.core.Handler<io.vertx.core.AsyncResult<java.util.List<com.aerospike.client.query.KeyRecord>>> handler)
               throws com.aerospike.client.AerospikeException

Asynchronously execute query on all server nodes.

Parameters:

queryPolicy - query configuration parameters, pass in null for defaults

statement - query filter. Statement instance is not suitable for reuse since it's modified in this method.

handler - the handler that will handle the result

Returns:

current Aerospike client instance

Throws:

com.aerospike.client.AerospikeException - if event loop registration fails

See Also:

AerospikeClient.query(EventLoop, RecordSequenceListener, QueryPolicy, Statement)