Aerospike

Modules

Classes

AdminPolicy
ApplyPolicy
BasePolicy
BatchApplyPolicy
BatchPolicy
BatchReadPolicy
BatchRemovePolicy
BatchWritePolicy
BitwisePolicy
CdtContext

Nested CDT context type.

Client

Construct a new Aerospike client instance.

Command
CommandQueuePolicy
Config
Double

Creates a new Double instance.

GeoJSON

Creates a new GeoJSON instance.

HLLPolicy
IndexJob
InfoPolicy
Job
Key

A key uniquely identifies a record in the Aerospike database within a given namespace.

ListPolicy
MapPolicy
OperatePolicy
Privilege

User privileges including a permission code, namespace, and set.

Query
QueryPolicy
ReadPolicy
Record

Construct a new Aerospike Record instance.

RecordStream
RemovePolicy
Role

Contains user roles and other user related information

Scan
ScanPolicy
UdfJob
User

Contains user roles and other user related information

WritePolicy

Type Definitions

AerospikeExp

Aerospike Expression object

Type:
  • object
Since:
  • v4.0.0
Source:

ClientStats

Runtime stats about a client instance.

Type:
  • Object
Properties:
Name Type Description
commands Object

Array of node stats

Properties
Name Type Description
inFlight number

Approximate number of commands actively being proccessed.
queued number

Approximate number of commands queued on the global command queue, that have not yet been started.
nodes Array.<Object>

Array of node stats

Properties
Name Type Description
name string

Node ID
syncConnections Object

Synchronous connection stats

Properties
Name Type Description
inPool number

Connections residing in pool(s) for this node. There can be multiple pools per node. This value is a summary of those pools for this node.
inUse number

Connections actively being used in database transactions for this node.
asyncConnections Object

Asynchronous connection stats

Properties
Name Type Description
inPool number

Connections residing in pool(s) for this node. There can be multiple pools per node. This value is a summary of those pools for this node.
inUse number

Connections actively being used in database transactions for this node.
Since:
  • v3.8.0
Source:
See:

Host

Address of an Aerospike cluster seed host.

Type:
  • object
Properties:
Name Type Argument Description
addr string

The hostname/IP address of the host.
port number <optional>

Optional port number; the default port number will be used if not specified.
tlsname string <optional>

Optional name to use when verifying the TLS certificate for TLS encrypted server connections.
Since:
  • v3.17.0
Source:
See:

JobdoneCallback(error)

Callback function called when a job has completed.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
Source:

JobinfoCallback(error [, info])

The function called with the job info response.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
info object <optional>

The job info.

Properties
Name Type Argument Description
status number <optional>

Status of the job. See module:aerospike.jobStatus.
progressPct number <optional>

Progress estimate for the job, as percentage.
recordsRead number <optional>

How many records have been processed.
Source:

Operation

Aerospike Operation object

Type:
  • object
Source:

Policies

Type:
  • Object
Properties:
Name Type Description
apply ApplyPolicy

Default apply policy
batch BatchPolicy

Default batch policy
info InfoPolicy

Default info policy
operate OperatePolicy

Default operate policy
read ReadPolicy

Default read policy
remove RemovePolicy

Default remove policy
scan ScanPolicy

Default scan policy
query QueryPolicy

Default query policy
write WritePolicy

Default write policy
map MapPolicy

Default map policy
list ListPolicy

Default list policy
commandQueue CommandQueuePolicy

Default command queue policy
Source:

QueryaggregationResultCallback(error [, result])

Callback function returning the aggregation result for a query.

If the operation was successful, null will be returned for the error parameter. If there was an error, result will be undefined and the error paramter will provide more information about the error.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
result number | string | Array.<*> | Object <optional>

The aggregation result.
Source:

RecordObject

Aerospike Record object

Type:
  • object
Source:

batchRecordsCallback(error [, results])

Callback function returning one or more records from the cluster.

If the operation was successful, null will be returned for the error parameter. If there was an error, results will be undefined and the error paramter will provide more information about the error.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
results Array.<Object> <optional>

The results of the operation. Depending on the specific operation, the full record, a selection of bins or just the meta data for the record will be included in the results.

Properties
Name Type Argument Description
status number

The status for fetching an individual record.
record Record <optional>

A database record of null if status is not AEROSPIKE_OK.
Source:

connectCallback(error [, client])

The function called when the client has successfully connected to the server.

Once you receive the connect callback the client instance returned in the callback is ready to accept commands for the Aerospike cluster.

If an error occurred while connecting to the cluster, the client parameter will be undefined and the error parameter will include more information about the error.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
client Client <optional>

Aerospike client instance.
Source:

doneCallback(error)

Callback function called when an operation has completed.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
Source:

errorCallback(error)

Callback function called when an error occured.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null.
Source:

infoAllCallback(error [, responses])

The function called when all cluster nodes have responded to the info request. Note that the error parameter in the callback will be non-null if at least one of the cluster hosts responded with an error to the info request.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
responses Array.<Object> <optional>

The response string with the requested info.
responses[].info String

The response string with the requested info.
responses[].host Object

The node that send the info response.

Properties
Name Type Description
node_id String

The name of the node.
Source:

infoCallback(error [, response])

The function called when a cluster host responds to an info query.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
response string <optional>

The response string with the requested info.
Source:

jobCallback(error [, job])

Function called when a potentially long-running job has been started.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
job Job <optional>

Handle on a potentially long-running job which can be used to check for job completion.
Source:

recordCallback(error [, record])

Callback function returning a single record from the cluster.

If the operation was successful, null will be returned for the error parameter. If there was an error, record will be undefined and the error paramter will provide more information about the error.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
record Record <optional>

Aerospike record incl. bins, key and meta data. Depending on the operation, all, some or no bin values will be returned.
Source:

valueCallback(error, value)

Callback function returning a single, arbitrary return value.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
value *

The return value of the operation.
Source:

writeCallback(error, key)

Callback function called when a write operation on a single record has completed.

Parameters:
Name Type Argument Description
error AerospikeError <nullable>

The error code and message or null if the operation was successful.
key Key

The key of the record.
Source: