Class | Description | |
---|---|---|
![]() | AdminPolicy |
Policy attributes used for user administration commands.
|
![]() | AerospikeClient |
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. |
![]() | AerospikeException |
Aerospike exceptions that can be thrown from the client.
|
![]() | AerospikeException CommandRejected |
Exception thrown when asynchronous command was rejected because the
max concurrent database commands have been exceeded.
|
![]() | AerospikeException Connection |
Exception thrown when client can't connect to the server.
|
![]() | AerospikeException InvalidNode |
Exception thrown when chosen node is not active.
|
![]() | AerospikeException Parse |
Exception thrown when client can't parse data returned from server.
|
![]() | AerospikeException QueryTerminated |
Exception thrown when query was terminated prematurely.
|
![]() | AerospikeException ScanTerminated |
Exception thrown when scan was terminated prematurely.
|
![]() | AerospikeException Serialize |
Exception thrown when Java serialization error occurs.
|
![]() | AerospikeException Timeout |
Exception thrown when database request expires before completing.
|
![]() | AsyncClient |
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. |
![]() | AsyncClientPolicy |
Asynchronous client policy configuration.
|
![]() | AsyncNode |
Asynchronous server node representation.
|
![]() | BaseTask |
Task used to poll for server task completion.
|
![]() | BatchPolicy |
Configuration variables for multi-record get and exist requests.
|
![]() | Bin |
Column name/value pair.
|
![]() | BitOperation |
Bit operations. Create bit operations used by client operate command.
Offset orientation is left-to-right. Negative offsets are supported.
If the offset is negative, the offset starts backwards from end of the bitmap.
If an offset is out of bounds, a parameter error will be returned.
Bit operations on bitmap items nested in lists/maps are not currently supported by the server. |
![]() | BitPolicy |
Bit operation policy.
|
![]() | ClientPolicy |
Client initialization arguments.
|
![]() | ClusterStats |
Cluster statistics.
|
![]() | ConnectionStats |
Connection statistics.
|
![]() | CTX |
Nested CDT context. Identifies the location of nested list/map to apply the operation.
for the current level. An array of CTX identifies location of the list/map on multiple
levels on nesting.
|
![]() | ExecuteTask |
Task used to poll for long running execute job completion.
|
![]() | Filter |
Query filter used to narrow down query results.
|
![]() | Formatter |
This class contains the default formatter used when serializing objects to bytes.
|
![]() | Host |
Host name/port of database server.
|
![]() | IndexTask |
Task used to poll for long running create index completion.
|
![]() | Info |
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: |
![]() | InfoPolicy |
Policy attributes used for info commands.
|
![]() | Join |
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.
|
![]() | Key |
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.
|
![]() | KeyRecord |
Container object for key identifier and record data.
|
![]() | ListOperation |
List bin operations. Create list operations used by client operate command.
List operations support negative indexing. If the index is negative, the resolved index starts backwards from end of list. If an index is out of bounds, a parameter error will be returned. If a range is partially out of bounds, the valid part of the range will be returned. Index/Range examples:
|
![]() | ListPolicy |
List policy directives when creating a list and writing list items.
|
![]() | Log |
Aerospike client logging facility. Logs can be filtered and message callbacks
can be defined to control how log messages are written.
|
![]() | LuaConfig |
Lua static configuration variables. These variables apply to all AerospikeClient instances
in a single process.
|
![]() | MapOperation |
Unique key map bin operations. Create map operations used by the client operate command.
The default unique key map is unordered.
All maps maintain an index and a rank. The index is the item offset from the start of the map, for both unordered and ordered maps. The rank is the sorted index of the value component. Map supports negative indexing for index and rank. Index examples:
Rank examples:
|
![]() | MapPolicy |
Map policy directives when creating a map and writing map items.
|
![]() | Node |
Server node representation. This class manages server node connections and health status.
|
![]() | NodeStats |
Node statistics.
|
![]() | Operation |
Database operation definition. The class is used in client's operate() method.
|
![]() | Policy |
Transaction policy attributes used in all database commands.
|
![]() | PredExp |
Predicate expression filter.
Predicate expression filters are applied on the query results on the server.
Predicate expression filters may occur on any bin in the record.
This is an experimental API and subject to change. |
![]() | Privilege |
User privilege.
|
![]() | QueryPolicy |
Container object for policy attributes used in query operations.
|
![]() | RandomShift |
Generate pseudo random numbers using xorshift128+ algorithm.
This class is not thread-safe and should be instantiated once per thread.
|
![]() | Record |
Container object for records. Records are equivalent to rows.
|
![]() | RecordSet |
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.
|
![]() | RegexFlag |
Regex bit flags.
|
![]() | RegisterTask |
Task used to poll for UDF registration completion.
|
![]() | ResultCode |
Database operation error codes.
|
![]() | ResultSet |
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.
|
![]() | Role |
Role definition.
|
![]() | ScanPolicy |
Container object for optional parameters used in scan operations.
|
![]() | Statement |
Query statement parameters.
|
![]() | User |
User and assigned roles.
|
![]() | Value |
Polymorphic value classes used to efficiently serialize objects into the wire protocol.
|
![]() | WritePolicy |
Container object for policy attributes used in write operations.
This object is passed into methods where database writes can occur.
|
Interface | Description | |
---|---|---|
![]() | BatchListListener |
Asynchronous result notifications for batch get commands with variable bins per key.
The result is sent in a single list.
|
![]() | BatchSequenceListener |
Asynchronous result notifications for batch get commands with variable bins per key.
The results are sent one batch record at a time.
|
![]() | DeleteListener |
Asynchronous result notifications for delete commands.
|
![]() | ExistsArrayListener |
Asynchronous result notifications for batch exists commands.
The result is sent in a single array.
|
![]() | ExistsListener |
Asynchronous result notifications for exists commands.
|
![]() | ExistsSequenceListener |
Asynchronous result notifications for batch exists commands.
The results are sent one record at a time.
|
![]() | InfoListener |
Asynchronous info command result notification.
|
![]() | RecordArrayListener |
Asynchronous result notifications for batch get commands.
The result is sent in a single array.
|
![]() | RecordListener |
Asynchronous result notifications for get or operate commands.
|
![]() | RecordSequenceListener |
Asynchronous result notifications for batch get and scan commands.
The results are sent one record at a time.
|
![]() | WriteListener |
Asynchronous result notifications for put, append, prepend, add, delete and touch commands.
|
Delegate | Description | |
---|---|---|
![]() | Log 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.
|
![]() | ScanCallback |
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. |
Enumeration | Description | |
---|---|---|
![]() | AuthMode |
Authentication mode when user/password is defined.
|
![]() | BitOverflowAction |
Bitwise operation flags for resize.
|
![]() | BitResizeFlags |
Bitwise operation flags for resize.
|
![]() | BitWriteFlags |
Bitwise operation policy write flags.
|
![]() | CommitLevel |
Desired consistency guarantee when committing a transaction on the server.
|
![]() | GenerationPolicy |
How to handle record writes based on record generation.
|
![]() | IndexCollectionType |
Secondary index collection type.
|
![]() | IndexType |
Underlying data type of secondary index.
|
![]() | Language |
User defined function languages.
|
![]() | ListOrder |
List storage order.
|
![]() | ListReturnType |
List return type. Type of data to return when selecting or removing items from the list.
|
![]() | ListSortFlags |
List sort flags
|
![]() | ListWriteFlags |
List write bit flags.
|
![]() | Log Level |
Log escalation level.
|
![]() | MapOrder |
Map storage order.
|
![]() | MapReturnType |
Map return type. Type of data to return when selecting or removing items from the map.
|
![]() | MapWriteFlags |
Map write bit flags.
Requires server versions >= 4.3.
|
![]() | MapWriteMode |
Unique key map write type.
This enum should only be used for server versions < 4.3.
are recommended for server versions >= 4.3.
|
![]() | MaxCommandAction |
How to handle cases when the asynchronous maximum number of concurrent database commands have been exceeded.
|
![]() | Operation Type | |
![]() | Priority |
Priority of operations on database server.
|
![]() | PrivilegeCode |
Permission codes define the type of permission granted for a user's role.
|
![]() | ReadModeAP |
Read policy for AP (availability) namespaces.
How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode. |
![]() | ReadModeSC |
Read policy for SC (strong consistency) namespaces.
Determines SC read consistency options. |
![]() | RecordExistsAction |
How to handle writes when the record already exists.
|
![]() | Replica |
Defines algorithm used to determine the target node for a command.
The replica algorithm only affects single record commands.
Batch, scan and query are not affected by replica algorithm.
|