dynamo-db-local v9.1.1

dynamo-db-local

A wrapper around Amazon's DynamoDB Local to start and stop it from Node.js.

This module wraps Amazon's DynamoDB Local. It exposes one method called spawn() which calls child_process.spawn() internally and returns its result.

const dynamoDbLocalProcess = dynamoDbLocal.spawn();
// ...
dynamoDbLocalProcess.kill();

Configuration

The spawn() function accecpts an optional options object.

command

The command property of that object can be used to run DynamoDB Local with Docker instead of using the bundled Java version.

const command = 'docker';
const dynamoDbLocalProcess = dynamoDbLocal.spawn({ command });
// ...
dynamoDbLocalProcess.kill();

detached

In a CI/CD environment you might want to let DynamoDB Local to run in the background. In this case, you should use the detached property.

const dynamoDbLocalProcess = dynamoDbLocal.spawn({ detached: true, stdio: 'ignore' });
// ...
dynamoDbLocalProcess.unref();

name

A custom name may be used to indentify the Docker container by name.

const dynamoDbLocalProcess = dynamoDbLocal.spawn({ command: 'docker', name: 'a-unique-name' });
// ...
dynamoDbLocalProcess.kill();

path

The options object can also be used to set an optional path property. If set, that path will be used to store the database file. If no path is specified the database will be kept in memory.

const path = 'somewhere/on/your/disk';
const dynamoDbLocalProcess = dynamoDbLocal.spawn({ path });
// ...
dynamoDbLocalProcess.kill();

port

Another property the options object could have is port. It specifies the port number that the process will run on. In absence of the port property, 8000 is used as the port number.

const port = 8001;
const dynamoDbLocalProcess = dynamoDbLocal.spawn({ port });
// ...
dynamoDbLocalProcess.kill();

sharedDb

The options object could also have a sharedDb property. If true, DynamoDB Local will use a single database file, instead of using separate files for each credential and region. The default of this option is false.

const dynamoDbLocalProcess = dynamoDbLocal.spawn({ sharedDb: true });
// ...
dynamoDbLocalProcess.kill();

stdio

Finally the options object can also be used to specify a custom stdio configuration.

const dynamoDbLocalProcess = dynamoDbLocal.spawn({ stdio: 'inherit' });
// ...
dynamoDbLocalProcess.kill();