Type Definitions
AerospikeExp
Aerospike Expression object
- Source:
- Since:
- v4.0.0
Type:
- object
ClientStats
Runtime stats about a client instance.
- Source:
- Since:
- v3.8.0
- See:
Properties:
Name | Type | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
commands |
Object | Array of node stats Properties
|
||||||||||||||||||||||||||||||
nodes |
Array.<Object> | Array of node stats Properties
|
Type:
- Object
Host
Address of an Aerospike cluster seed host.
- Source:
- Since:
- v3.17.0
- See:
Properties:
Name | Type | Attributes | 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. |
Type:
- object
JobdoneCallback(errornullable)
Callback function called when a job has completed.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
JobinfoCallback(errornullable, infoopt)
The function called with the job info response.
- Source:
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
||||||||||||||||
info |
object |
<optional> |
The job info. Properties
|
Operation
Aerospike Operation object
- Source:
Type:
- object
Policies
- Source:
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 |
Type:
- Object
QueryaggregationResultCallback(errornullable, resultopt)
Callback function returning the aggregation result for a query.
- Description:
If the operation was successful,
null
will be returned for the error parameter. If there was an error,result
will beundefined
and theerror
paramter will provide more information about the error.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
result |
number | string | Array.<*> | Object |
<optional> |
The aggregation result. |
RecordObject
Aerospike Record object
- Source:
Type:
- object
batchRecordsCallback(errornullable, resultsopt)
Callback function returning one or more records from the cluster.
- Description:
If the operation was successful,
null
will be returned for the error parameter. If there was an error,results
will beundefined
and theerror
paramter will provide more information about the error.
- Source:
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
||||||||||||
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
|
connectCallback(errornullable, clientopt)
The function called when the client has successfully connected to the server.
- Description:
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 beundefined
and theerror
parameter will include more information about the error.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
client |
Client |
<optional> |
Aerospike client instance. |
doneCallback(errornullable)
Callback function called when an operation has completed.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
errorCallback(errornullable)
Callback function called when an error occured.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
infoAllCallback(errornullable, responsesopt)
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.
- Source:
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
|||||||||||||||
responses |
Array.<Object> |
<optional> |
The response string with the requested info. Properties
|
infoCallback(errornullable, responseopt)
The function called when a cluster host responds to an info query.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
response |
string |
<optional> |
The response string with the requested info. |
jobCallback(errornullable, jobopt)
Function called when a potentially long-running job has been started.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
job |
Job |
<optional> |
Handle on a potentially long-running job which can be used to check for job completion. |
recordCallback(errornullable, recordopt)
Callback function returning a single record from the cluster.
- Description:
If the operation was successful,
null
will be returned for the error parameter. If there was an error,record
will beundefined
and theerror
paramter will provide more information about the error.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or
|
record |
Record |
<optional> |
Aerospike record incl. bins, key and meta data. Depending on the operation, all, some or no bin values will be returned. |
valueCallback(errornullable, value)
Callback function returning a single, arbitrary return value.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
value |
* | The return value of the operation. |
writeCallback(errornullable, key)
Callback function called when a write operation on a single record has completed.
- Source:
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
AerospikeError |
<nullable> |
The error code and message or |
key |
Key | The key of the record. |