# Entity Storage Connector DynamoDB

This package provides an Amazon DynamoDB backend for managed NoSQL storage in cloud-native deployments. It is designed to work with the wider storage ecosystem so applications can keep behaviour consistent across connectors and environments.

## Installation

```shell
npm install @twin.org/entity-storage-connector-dynamodb
```

## Dependency versions

Published versions pin `@aws-sdk/client-dynamodb` and `@aws-sdk/lib-dynamodb` to releases that are at least 48 hours old on npm, so consumers with a minimum package age policy (for example pnpm `minimumReleaseAge`) can install without resolution failures.

## Docker

To perform testing of this component it may be necessary to launch a local instance to communicate with.

```shell
docker run -d --name twin-entity-storage-dynamodb -p 18000:8000 amazon/dynamodb-local
```

## Examples

Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)

## Reference

Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)

## Changelog

The changes between each version can be found in [docs/changelog.md](docs/changelog.md)