Overview: Aerospike Node.js client

For the complete documentation index see: llms.txt

All documentation pages available in markdown.

Feature highlights

Execution models:

Promises and async/await: Non-blocking database operations using modern JavaScript patterns. See Asynchronous operations.
Callbacks: Supported for existing codebases.
Cluster module: Run concurrent workloads across processes with the Cluster module.

Advanced data operations:

String operations: Run server-side String transforms with String operations and String expressions. Requires Aerospike Database 8.2.0 or later and Node.js client 7.0.0 or later.
Batch protocol: Combine reads, writes, deletes, and UDF calls in batch operations.
Transactions: Group create, update, read, and delete steps in multi-record transactions (Database 8.0.0.0 and later).
Query types: Primary-index, secondary-index, and background queries.

Policy and expression enhancements:

Policies: Tune timeouts, retries, consistency, and write behavior with client policies.
Filter expressions: Conditional reads and writes with expressions.
Path expressions: Server-side path expression support for advanced filtering operations.

Data model improvements:

Document model: Store and query JSON-like documents using Map bins.
Type support: All Aerospike scalar and collection data types, including Lists, Maps, HyperLogLog, and geospatial bins.

Operations and observability:

Metrics: Collect standard and extended client metrics programmatically or through Dynamic Client Configuration.
Error details: Read server subcodes from AerospikeError.subcode when you set errorDetailVerbosity on the command policy (Node.js client 7.0.0 and later). See Error handling.
Security: Connect with username/password authentication and mutual TLS (mTLS).

See the release notes for version history.

Quickstart

Check out the Aerospike client Quickstart for installation instructions and query examples.

Best practices

Already familiar with the Node.js client? Our best practices guide can help you optimize for performance and reliability.

Error handling

Actionable errors with recovery suggestions. Know exactly what went wrong and how to fix it.

Usage examples

Want to dive straight into the API? We have usage examples for all the basic CRUD operations.