Aerospike.Client NamespaceAerospike
Aerospike Client Library
Classes

  ClassDescription
Public classAdminPolicy
Policy attributes used for user administration commands.
Public classAerospikeClient
Instantiate an AerospikeClient object to access an Aerospike database cluster and perform database operations.

This client is thread-safe. One client instance should be used per cluster. Multiple threads should share this cluster instance.

Your application uses this class API to perform database operations such as writing and reading records, and selecting sets of records. Write operations include specialized functionality such as append/prepend and arithmetic addition.

Each record may have multiple bins, unless the Aerospike server nodes are configured as "single-bin". In "multi-bin" mode, partial records may be written or read by specifying the relevant subset of bins.

Public classAerospikeException
Aerospike exceptions that can be thrown from the client.
Public classAerospikeException CommandRejected
Exception thrown when asynchronous command was rejected because the max concurrent database commands have been exceeded.
Public classAerospikeException Connection
Exception thrown when client can't connect to the server.
Public classAerospikeException InvalidNode
Exception thrown when chosen node is not active.
Public classAerospikeException Parse
Exception thrown when client can't parse data returned from server.
Public classAerospikeException QueryTerminated
Exception thrown when query was terminated prematurely.
Public classAerospikeException ScanTerminated
Exception thrown when scan was terminated prematurely.
Public classAerospikeException Serialize
Exception thrown when Java serialization error occurs.
Public classAerospikeException Timeout
Exception thrown when database request expires before completing.
Public classAsyncClient
Asynchronous Aerospike client.

Your application uses this class to perform asynchronous database operations such as writing and reading records, and selecting sets of records. Write operations include specialized functionality such as append/prepend and arithmetic addition.

This client is thread-safe. One client instance should be used per cluster. Multiple threads should share this cluster instance.

Each record may have multiple bins, unless the Aerospike server nodes are configured as "single-bin". In "multi-bin" mode, partial records may be written or read by specifying the relevant subset of bins.

Public classAsyncClientPolicy
Container object for client policy Command.
Public classAsyncNode
Asynchronous server node representation.
Public classBatchPolicy
Configuration variables for multi-record get and exist requests.
Public classBin
Column name/value pair.
Public classClientPolicy
Client initialization arguments.
Public classExecuteTask
Task used to poll for long running execute job completion.
Public classFilter
Query filter used to narrow down query results.
Public classFormatter
This class contains the default formatter used when serializing objects to bytes.
Public classHost
Host name/port of database server.
Public classIndexTask
Task used to poll for long running create index completion.
Public classInfo
Access server's info monitoring protocol.

The info protocol is a name/value pair based system, where an individual database server node is queried to determine its configuration and status. The list of supported names can be found at:

Onlinehttps://docs.aerospike.com/display/AS2/Config+Parameters+Reference

Public classInfoPolicy
Policy attributes used for info commands.
Public classJoin
Client-side join definition. The left record must contain a bin with a list of keys. That list will be used to retreive other records in the given namespace and set.
Public classKey
Unique record identifier. Records can be identified using a specified namespace, an optional set name, and a user defined key which must be unique within a set. Records can also be identified by namespace/digest which is the combination used on the server.
Public classLargeList
Create and manage a list within a single bin.
Public classLargeMap
Create and manage a map within a single bin.
Public classLargeSet
Create and manage a list within a single bin.
Public classLargeStack
Create and manage a stack within a single bin. A stack is last in/first out (LIFO).
Public classLog
Aerospike client logging facility. Logs can be filtered and message callbacks can be defined to control how log messages are written.
Public classLuaConfig
Lua static configuration variables.
Public classNode
Server node representation. This class manages server node connections and health status.
Public classOperation
Database operation definition. The class is used in client's operate() method.
Public classPolicy
Container object for transaction policy attributes used in all database operation calls.
Public classQueryPolicy
Container object for policy attributes used in query operations.
Public classRecord
Container object for records. Records are equivalent to rows.
Public classRecordSet
This class manages record retrieval from queries. Multiple threads will retrieve records from the server nodes and put these records on the queue. The single user thread consumes these records from the queue.
Public classRegisterTask
Task used to poll for UDF registration completion.
Public classResultCode
Database operation error codes.
Public classResultSet
This class manages result retrieval from queries. Multiple threads will retrieve results from the server nodes and put these results on the queue. The single user thread consumes these results from the queue.
Public classRole
Pre-defined user roles.
Public classScanPolicy
Container object for optional parameters used in scan operations.
Public classStatement
Query statement parameters.
Public classTask
Task used to poll for server task completion.
Public classUserRoles
User and assigned roles.
Public classValue
Polymorphic value classes used to efficiently serialize objects into the wire protocol.
Public classWritePolicy
Container object for policy attributes used in write operations. This object is passed into methods where database writes can occur.
Interfaces

  InterfaceDescription
Public interfaceDeleteListener
Asynchronous result notifications for delete commands.
Public interfaceExistsArrayListener
Asynchronous result notifications for batch exists commands. The result is sent in a single array.
Public interfaceExistsListener
Asynchronous result notifications for exists commands.
Public interfaceExistsSequenceListener
Asynchronous result notifications for batch exists commands. The results are sent one record at a time.
Public interfaceRecordArrayListener
Asynchronous result notifications for batch get commands. The result is sent in a single array.
Public interfaceRecordListener
Asynchronous result notifications for get or operate commands.
Public interfaceRecordSequenceListener
Asynchronous result notifications for batch get and scan commands. The results are sent one record at a time.
Public interfaceWriteListener
Asynchronous result notifications for put, append, prepend, add, delete and touch commands.
Delegates

  DelegateDescription
Public delegateLog Callback
The log is written to the Windows Event Log by default. The caller can override this and set a private method which will be called for each log entry.
Public delegateScanCallback
This method will be called for each record returned from a scan. The user may throw a exception if the scan should be aborted. If any exception is thrown, parallel scan threads to other nodes will also be terminated and the exception will be propagated back through the initiating scan call.

Multiple threads will likely be calling scanCallback in parallel. Therefore, your scanCallback implementation should be thread safe.

Enumerations

  EnumerationDescription
Public enumerationGenerationPolicy
How to handle record writes based on record generation.
Public enumerationIndexType
Type of secondary index.
Public enumerationLanguage
User defined function languages.
Public enumerationLog Level
Log escalation level.
Public enumerationMaxCommandAction
How to handle cases when the asynchronous maximum number of concurrent database commands have been exceeded.
Public enumerationPriority
Priority of operations on database server.
Public enumerationRecordExistsAction
How to handle writes when the record already exists.