mongodb-utility
v1.0.30
Published
Utility functions for MongoDB Atlas with Node.js Typescript setup
Downloads
18
Maintainers
Readme
Utility functions for MongoDB Atlas with Node.js Typescript setup
Installation
- Install in your project using
npm i mongodb-utility
Available functions / API
Environment variables MONGO_USER
, MONGO_PASSWORD
, MONGO_PATH
are needed to use this utility.
connectToTheDatabase() Connect to the MongoDB database
- @param
mongooseInstance
mongoose instance to connect to - @param
enableLogging
flag for enabling/disabling logging
getAllDocs() Get all the documents in a collection
- @param
mongooseInstance
mongoose instance to connect to - @param
collectionName
instance of the collection - @param
enableLogging
flag for enabling/disabling logging
dropCollection() Drops a collection by it's name
- @param
collectionName
name of the collection - @param
enableLogging
flag for enabling/disabling logging
insertMany() Insert many documents to MongoDb instance
- @param
collectionName
The name of the collection - @param
docs
The documents which needs to be inserted - @param
enableLogging
flag for enabling/disabling logging
getCompiledModel() Gives the model of the specific schema with the specified name
- @param
modelName
The name of the model (generally same as the name of the resultant collection) - @param
schemaJSON
The schema of the model - @param
enableLogging
flag for enabling/disabling logging
Contributions welcome!
Open a new PR here on GitHub.
Run locally
- Run
git clone https://github.com/nordible/mongodb-utility.git
this project - Run
cd mongodb-utility/
to this project - Run
npm run dev
to start the project on local machine
Bugs and Issues
Have a bug or an issue? Open a new issue here on GitHub.
License
Code licensed under MIT. Everything else is CC
Follow us
© nordible