Aerospike Client Library
npm install aerospike[travis-image]: https://travis-ci.org/aerospike/aerospike-client-nodejs.svg?branch=master
[travis-url]: https://travis-ci.org/aerospike/aerospike-client-nodejs
[codecov-image]: https://codecov.io/gh/aerospike/aerospike-client-nodejs/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/aerospike/aerospike-client-nodejs
[npm-image]: https://img.shields.io/npm/v/aerospike.svg
[npm-url]: https://www.npmjs.com/package/aerospike
[downloads-image]: https://img.shields.io/npm/dm/aerospike.svg
[downloads-url]: http://npm-stat.com/charts.html?package=aerospike
The Aerospike Node.js client is a Node.js add-on module, written using V8.
The client is compatible with Node.js 25, Node.js 24 (LTS), Node.js 22 (LTS), and Node.js 20 (LTS).
It supports the following operating systems:
- RHEL 9/10
- Debian 12/13
- Amazon Linux 2023
- Ubuntu 22.04/24.04 (Focal Fossa, Jammy Jellyfish, Noble Numbat)
- Many Linux distributions compatible with one of the above OS releases.
- macOS 14/15/26
The client is compatible with arm64, aarch64, and x86_64 architectures.
The Aerospike Node.js client supports all Node.js LTS
releases. To download and
install the latest stable version of Node.js, visit
nodejs.org.
Install the necessary "development tools" and other libraries to build the client software.
Reference various docker files in the repository under the docker directory for more information.
The Aerospike Node.js client is an add-on module that uses the Aerospike C client. The installation will attempt to install the pre-built binaries including dependent C client.
You can install the Aerospike Node.js client like any other Node.js module.
Node.js modules are containers of JavaScript code and a package.json, which defines
the module, its dependencies and requirements. Modules are usually installed as
dependencies of other Node.js applications or modules. The modules are installed in
the application's node_modules directory, and can be utilized within the program
by requiring the module by name.
To install aerospike as a dependency in your project:
``bash`
npm install aerospike
To import the module in your application:
`bash`
import Aerospike from 'aerospike';
The following is very simple example how to create, update, read and remove a
record using the Aerospike database.
`js
import Aerospike from 'aerospike';
const main = async () => {
let client
try {
client = await Aerospike.connect({hosts: '127.0.0.1:3000'});
const key = new Aerospike.Key('test', 'dataset', 123);
await client.put(key, {foo: "bar", baz: "qux"}, [], null);
const record = await client.get(key);
console.info("Record created\nRecord: %o\n", record.bins);
} catch (e) {
console.error(e)
} finally {
client && client.close();
}
}
main();
`Prerequisites
#### RHEL/CentOS
To install library prerequisites using yum:
`bash`
sudo yum group install "Development Tools"
sudo yum install openssl openssl-devel
sudo yum install python3 python3-devel
#### Alpine Linux
`bash`
apk add build-base \
linux-headers \
bash \
libuv-dev \
openssl-dev \
lua5.1-dev \
zlib-dev \
git \
python3
#### Amazon Linux
`bash`
yum groupinstall "Development Tools"
yum install openssl openssl-devel
yum install python3 python3-devel
#### Debian
To install library prerequisites using apt-get:
`bash`
sudo apt -y install software-properties-common
sudo apt -y install build-essential
sudo apt -y install libssl-dev
sudo apt -y install libarchive-dev cmake rsync curl libcurl4-openssl-dev zip
sudo apt -y install python3 python3-dev python3-pip
sudo apt install zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev \
libsqlite3-dev libreadline-dev libffi-dev libbz2-dev -y
sudo apt -y install wget libtool m4 automake
#### Ubuntu
To install library prerequisites using apt:
`bash`
sudo apt install g++ libssl libssl-dev zlib1g-dev
If you are using Ubuntu 20.04, you must upgrade gcc/g++ to at least version 10:
`bash
sudo apt-get install gcc-10 g++-10
ln -s /usr/bin/gcc-10 /usr/local/bin/gcc
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-9 40
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-10 60
sudo update-alternatives --config g++
`
See our Windows README.md for details on how to build and install on windows.
Before starting with the Aerospike Nodejs Client, verify that you have the following prerequisites:
- macOS 10.8 or greater.
- Xcode 5 or greater.
OpenSSL Library
OpenSSL is needed to build the Aerospike C Client. If downloading from NPM at version 5.6.0 or later, you will not need to
have OpenSSL installed to use the Aerospike Nodejs Client. If you are using version 5.5.0 and below, you will need to do
some additional linking to use the client, which is specified below.
We recommend using brew to install OpenSSL:
`bash`
brew install openssl
LIBUV Library
Libuv is needed to build the Aerospike C Client. If downloading from NPM at version 5.6.0 or later, you will not need to
have Libuv installed to use the Aerospike Nodejs Client. If you are using version 5.5.0 and below, you will need to do
some additional linking to use the client, which is specified below.
We recommend using brew to install Libuv:
`bash`
brew install libuv
For a Mac using ARM architecture, Libuv should be linked as shown below:
When using a cloned repository, install aerospike as a dependency of your application. Instead of referencing the module by name, you reference it by path.
To clone the repository use the following command:
`bash`
git clone --recursive git@github.com:aerospike/aerospike-client-nodejs.git
#### Building dependancy C client
Make sure to build the C client before doing npm install variants
Run the following commands to build the C client:
`bash`
./scripts/build-c-client.sh
#### Building and installing the C++ addon for the Node.js client
To build and install the module as a dependency of your application:
`bash`
npm install --unsafe-perm --build-from-source
To import the module in your application:
`bash`
import Aerospike from 'aerospike';
Access the client API documentation at:
https://docs.aerospike.com/apidocs/nodejs.
This documentation is built from the client's source using JSDocs
v4 for every release.
The API docs also contain a few basic tutorials:
* Getting Started - Connecting to an Aerospike database cluster
* Managing Aerospike connections in a Node cluster
* Handling asynchronous database operations using Callbacks, Promises or async/await
A variety of additional example applications are provided in the
examples directory of this repository.
Access backward incompatible API changes by a release at:
https://aerospike.com/docs/develop/client/node/incompatible/.
The Aerospike Node.js client library follows semantic versioning.
By Aerospike versioning guidelines, changes which may break backwards compatibility are
indicated by an increase in the major version number.
Minor, or patch releases, which are incremented only the
second and third version number, are always backwards compatible.
The client includes a comprehensive typescript test suite using
Mocha. The tests can be found in the repository under ts-test directory.
Before running the tests, you need to update the dependencies:
npm update
To run all the test cases:
npm test
To run a specific tests, use:
npm test --testfile=filename.js
Various options can be provided, such as host, port, and password information
npm run test --testfile=metrics.js -- -h localhost --port 3000 -t 60000 -U superuser -P superuser
To see the options, see ts-test/test/util/options.ts for a full list.
Note: make sure your server has TTL enabled for the test` namespace (Namespace Retention Configuration) to allow all tests to run correctly.
To run the tests and also report on test coverage:
npm run coverage
Benchmark utilities are provided in the repository under benchmarks directory. See the benchmarks/README.md for details.
The Aerospike Node.js Client is made available under the terms of the Apache
License, Version 2, as stated in the LICENSE file.
Individual files may be made available under their own specific license, all
compatible with Apache License, Version 2. Refer to individual files for
details.