@discue/mongodb-resource-client
Advanced tools
Simple wrapper around mongodb client allowing easier managing of resources
Light wrapper around MongoDB 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 from the official MongoDB blog.
The module provides support for history / auditing tables to keep track of changes made to documents. The ResourceStorageHistory component can be used as an extension
of a storage instance e.g. SimpleResourceStorage. An instance of ResourceStorageHistory can listen to storage events of another storage instance and populate a ${resourceName}_history collection with timestamp, change type, and the full resource state.
const { EventEmiter } = require('events')
const { OneToFewResourceStorage, ResourceStorageHistory } = require('@discue/mongodb-resource-client')
const eventEmitter = new EventEmitter()
const collectionName = 'api_clients'
const url = 'mongodb://127.0.0.1:27017'
const oneToFewResourceStorage = new OneToFewResourceStorage({
url,
collectionName,
eventEmitter
})
const history = new ResourceStorageHistory({
url,
collectionName,
usageEventPrefix: oneToFewResourceStorage.usageEventPrefix
eventEmitter
})
history.listenForStorageEvents()
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.
The module supports creating locks. Meaning: A way to synchronize application functionality e.g. for rate limiting. Check out the ResourceLock documentation to find out more.
The database name can be configured via environment variable: DSQ_MONGOD_RESOURCE_CLIENT_DB_NAME
npm install @discue/mongodb-resource-client
To run tests, run the following command
./test.sh
FAQs
Simple wrapper around mongodb client allowing easier managing of resources
The npm package @discue/mongodb-resource-client receives a total of 108 weekly downloads. As such, @discue/mongodb-resource-client popularity was classified as not popular.
We found that @discue/mongodb-resource-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.