ScyllaDB JS Driver

Installation and build process

For installation of the required packages, type command below:

npm install

For build process use this command:

npm run build

If you want to build in development mode use this command:

npm run build:debug

If command above doesn't work, make sure that you have napi package downloaded globally.

Testing the driver

There are three categories of tests in this repository (with the corresponding commands to run them):

• Unit tests (npm run unit)
• Integration short (npm run integration_short)
• Integration long (npm run integration_long)

The split between integration short and long comes from the datastax integration tests and remains currently unchanged.

Requirements

Before running any of the tests, ensure the driver is built correctly.

For the integration tests you need to do the following steps before running tests:

1. Install scylla-ccm package. You may also use ccm but not all tests are guaranteed to pass while using it.
2. Have java-8 installed and available in path /usr/lib/jvm/java-8 (scylla-ccm uses this hardcoded path)
3. Have simulacron.jar downloaded in SIMULACRON_PATH path (if you don't provide this env variable, home directory is assumed) You can download the latest version from the repository

Running examples

Before running examples, you need to build the driver and install packages for the examples by running:

npm install

in ./examples directory. You need also Cassandra or ScyllaDB running with at least three nodes (to ensure the replication_factor can be satisfied). By default, examples assume the entrypoint for the database is 172.17.0.2:9042 but you can change it by setting SCYLLA_URI env variable.

You can run all examples with the following command:

npm run examples

This will check if all examples finished successfully, but will hide any output generated by the example.

Alternatively you can run just a specific example by providing the path to it:

node ./examples/basic.js

File structure

Files in .gitignore (auto-generated)

• node_modules/
• target/
• Cargo.lock
• *.node

Not implemented functions

For functions not yet implemented:

function functionName()) {
    throw new Error(`TODO: Not implemented`);
}

And for entities that will not be implemented:

/**
 * @deprecated Not supported by the driver. Usage will throw an error.
 */
function entityName() {
  throw new ReferenceError(`entityName is not supported by our driver`);
}