gremlin-aws-sigv4

gremlin-aws-sigv4

This package provides an extension for Apache's TinkerPop3 Gremlin javascript driver compatible with IAM Database Authentication for Neptune.

Installation

This project is a Node.js module and can be installed with npm.

npm install gremlin-aws-sigv4

Usage

This package reads the environment variables for AWS authentication. These variables can be overridden.

Usage with environment variables

These three enviroment variables must be defined.

• AWS_ACCESS_KEY_ID – AWS access key.
• AWS_SECRET_ACCESS_KEY – AWS secret key.
• AWS_DEFAULT_REGION – AWS region.

  const gremlin = require('gremlin-aws-sigv4');

  const host = 'your-instance.neptune.amazonaws.com';
  const port = 8182;

  // creates the connection
  const graph = new gremlin.structure.Graph();
  const connection = new gremlin.driver.AwsSigV4DriverRemoteConnection(host, port);
  const g = graph.traversal().withRemote(connection);

  // run the query, here it counts the number of vertices in database
  const count = await g.V().count().next();

  // close the connection
  connection.close();

Usage without environment variables

  const gremlin = require('gremlin-aws-sigv4');

  const host = 'your-instance.neptune.amazonaws.com';
  const port = 8182;
  const opts = {
    accessKey: 'your-access-key',
    secretKey: 'your-secret-key',
    region: 'your-region',
  };

  // creates the connection
  const graph = new gremlin.structure.Graph();
  const connection = new gremlin.driver.AwsSigV4DriverRemoteConnection(host, port, opts);
  const g = graph.traversal().withRemote(connection);

  // run the query, here it counts the number of vertices in database
  const count = await g.V().count().next();

  // close the connection
  connection.close();

Additional options

Thses are the available config options, none of them is required.

{
  // Enable auto-reconnection on connection failure - default: false 
  autoReconnect: true,

  // Number of auto-reconnection retries - default: 10 
  maxRetry: 3,
}

• `` (default: false)
• maxRetry (default: 10)

Tests

Unit tests

# install dependencies
npm install

# run the tests
npm run test:unit

Integration tests

Docker is required to run integration tests, a gremlin-server container will be created.

# install dependencies
npm install

# start docker container
npm run docker:start

# run the tests
npm run test:e2e

# stop and delete docker container
npm run docker:stop

All tests and coverage

Docker is required to run all tests, a gremlin-server container will be created.

# install dependencies
npm install

# start docker container
npm run docker:start

# run the tests
npm run test

# stop and delete docker container
npm run docker:stop

Dependencies

• gremlin
• moment-timezone
• websocket

Contribute

Please do contribute! Open an issue or submit a pull request.

The project falls under @Shutterstock's Code of Conduct.

License