https://github.com/chrisguttandin/dynamo-db-local

A wrapper around Amazon's DynamoDB Local to start and stop it from Node.js.
https://github.com/chrisguttandin/dynamo-db-local

aws dynamodb dynamodb-local

Last synced: 19 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/chrisguttandin/dynamo-db-local
• Owner: chrisguttandin
• License: mit
• Created: 2015-06-12T22:49:58.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-16T16:17:43.000Z (30 days ago)
• Last Synced: 2024-10-24T12:12:42.481Z (22 days ago)
• Topics: aws, dynamodb, dynamodb-local
• Language: JavaScript
• Size: 360 MB
• Stars: 13
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# dynamo-db-local

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

[![version](https://img.shields.io/npm/v/dynamo-db-local.svg?style=flat-square)](https://www.npmjs.com/package/dynamo-db-local)

This module wraps Amazon's [DynamoDB Local](http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tools.DynamoDBLocal.html). It exposes one method called `spawn()` which calls [`child_process.spawn()`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) internally and returns its result.

```js

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.

```js

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.

```js

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

// ...

dynamoDbLocalProcess.unref();

```

### name

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

```js

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.

```js

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.

```js

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.

```js

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

// ...

dynamoDbLocalProcess.kill();

```

### stdio

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

```js

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

// ...

dynamoDbLocalProcess.kill();

```