Entity Storage Connector MongoDB

This package provides a MongoDB backend for flexible document persistence and evolving schemas. It is designed to work with the wider storage ecosystem so applications can keep behaviour consistent across connectors and environments.

Installation

npm install @twin.org/entity-storage-connector-mongodb

Docker

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

docker pull mongo:latest
docker run -d --name twin-entity-storage-mongodb -p 27017:27017 mongo:latest

Examples

Usage of the APIs is shown in the examples docs/examples.md

Reference

Detailed reference documentation for the API can be found in docs/reference/index.md

Changelog

The changes between each version can be found in docs/changelog.md