Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/discue/mongodb-resource-client

Light wrapper around mongodb library to ease working with resources and documents
https://github.com/discue/mongodb-resource-client

discue mongodb nodejs storage

Last synced: 10 days ago
JSON representation

Light wrapper around mongodb library to ease working with resources and documents

Host: GitHub
URL: https://github.com/discue/mongodb-resource-client
Owner: discue
License: mit
Created: 2023-05-28T20:26:16.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-01T20:09:41.000Z (about 2 months ago)
Last Synced: 2024-10-14T02:07:35.162Z (about 1 month ago)
Topics: discue, mongodb, nodejs, storage
Language: JavaScript
Homepage: https://www.discue.io
Size: 1.12 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        













[![GitHub tag](https://img.shields.io/github/tag/discue/mongodb-resource-client?include_prereleases=&sort=semver&color=blue)](https://github.com/discue/mongodb-resource-client/releases/)

[![Latest Stable Version](https://img.shields.io/npm/v/@discue/mongodb-resource-client.svg)](https://www.npmjs.com/package/@discue/mongodb-resource-client)

[![License](https://img.shields.io/npm/l/@discue/mongodb-resource-client.svg)](https://www.npmjs.com/package/@discue/mongodb-resource-client)




[![NPM Downloads](https://img.shields.io/npm/dt/@discue/mongodb-resource-client.svg)](https://www.npmjs.com/package/@discue/mongodb-resource-client)

[![NPM Downloads](https://img.shields.io/npm/dm/@discue/mongodb-resource-client.svg)](https://www.npmjs.com/package/@discue/mongodb-resource-client)




[![contributions - welcome](https://img.shields.io/badge/contributions-welcome-blue)](/CONTRIBUTING.md "Go to contributions doc")

[![Made with Node.js](https://img.shields.io/badge/Node.js->=20-blue?logo=node.js&logoColor=white)](https://nodejs.org "Go to Node.js homepage")



# mongodb-resource-client

Light wrapper around [MongoDB](https://mongodb.com/) client library to allow for easier management of resources and documents. All storage modules are based on the best practices described in the article [6 Rules of Thumb for MongoDB Schema Design](https://www.mongodb.com/blog/post/6-rules-of-thumb-for-mongodb-schema-design) from the official [MongoDB blog](https://www.mongodb.com/blog).

**Please read the installation instructions mentioned below.**

## Installation

This module has built-in support for tracing via Open Telemetry. The necessary dependencies are not declared in the module's `package.json` to allow applications to enable or disable the tracing feature.

### Install with support for tracing

```bash

npm i @discue/mongodb-resource-client @discue/open-telemetry-tracing

```

### Install without tracing features

```bash

npm i @discue/mongodb-resource-client @discue/open-telemetry-tracing@npm:@discue/open-telemetry-tracing-noop

```

## Component References

- [Aggregations](README_AGGREGATIONS.md)

- [EventEmitter](README_EVENT_EMITTER.md)

- [OneToFewRefStorage](README_ONE_TO_FEW_REF_STORAGE.md)

- [OneToFewResourceStorage](README_ONE_TO_FEW_RESOURCE_STORAGE.md)

- [OneToManyResourceStorage](README_ONE_TO_MANY_RESOURCE_STORAGE.md)

- [ResourceStorageHistory](README_STORAGE_HISTORY.md)

- [ResourceLock](README_STORAGE_LOCK.md)

- [SimpleResourceStorage](README_SIMPLE_RESOURCE_STORAGE.md)

- [SimpleTimeseriesStorage](README_SIMPLE_TIMESERIES_STORAGE.md)

## History / Auditing

The module provides support for history / auditing tables to keep track of changes made to documents by calling the `enableHistory` method.

```javascript

import { MongoClient } from ('mongodb')

import { OneToFewResourceStorage, ResourceStorageHistory } from ('@discue/mongodb-resource-client')

const collectionName = 'api_clients'

const url = 'mongodb://127.0.0.1:27017'

const client = new MongoClient(url, {

  serverApi: { version: '1', strict: true, deprecationErrors: true }, // https://www.mongodb.com/docs/manual/reference/stable-api/

})

const oneToFewResourceStorage = new OneToFewResourceStorage({

  client,

  collectionName,

  eventEmitter

})

oneToFewResourceStorage.enableHistory()

```

## Transactions

The module supports transactions for atomic updates of multiple collections. However, as only MongoDB replica sets support transactions, transaction support needs to be explicitly enabled via setting the environment variable `DSQ_MONGOD_ENABLE_TRANSACTIONS` with value `true`.

## Locks

The module supports creating locks. Meaning: A way to synchronize application functionality e.g. for rate limiting. Check out the [ResourceLock](README_STORAGE_LOCK.md) documentation to find out more.

## Database name

The database name can be configured via environment variable: `DSQ_MONGODB_RESOURCE_CLIENT_DB_NAME`

## Tracing

This module has built-in support for tracing via Open Telemetry. Under the hood it uses [@discue/open-telemetry-tracing](https://github.com/discue/open-telemetry-tracing/).

Please read the installation instructions mentioned above.

## Run tests

To run tests, run the following command

```bash

./test.sh

```

## License

[MIT](https://choosealicense.com/licenses/mit/)