\r\n\r\nAn insanely basic implementation of some form of Object Document Mapping (not ORM) for MongoDB. This was not really made to be used as a widely available package, it does not contain severely insane levels of logging. \r\n\r\n## Getting Started\r\n\r\nTo get started you must install the package via your dependency manager (you can use yarn as well)\r\n\r\n`npm install @cameronct/mongo-odm`\r\n\r\n### Initiating the Connection\r\n\r\n```js\r\nimport MongoODM from \"@cameronct/mongo-odm\";\r\n\r\n// Basic\r\nawait MongoODM.connect();\r\n\r\n// With Connection URI\r\nawait MongoODM.connect(\"mongodb://localhost:27017/my-app\");\r\n\r\n// With Custom Models Folder\r\nawait MongoODM.connect(\"mongodb://localhost:27017/my-app\", path.join(__dirname, \"path/to/models\"));\r\n```\r\n\r\n### Creating a Model\r\n\r\nHere is an example Model that can be found in `/models/User.js`\r\n```js\r\nimport MongoODM from \"@cameronct/mongo-odm\";\r\n\r\nconst User = new MongoODM.Model(\"users\", [\r\n { name: \"name\", type: MongoODM.FieldTypes.String, required: true },\r\n { name: \"email\", type: MongoODM.FieldTypes.String, required: true },\r\n { name: \"password\", type: MongoODM.FieldTypes.String, required: true },\r\n { name: \"type\", type: MongoODM.FieldTypes.String, default: \"basic\" },\r\n], [ \r\n { name: \"uniqueEmail\", fields: { email: \"text\" } },\r\n])\r\n```\r\n\r\n### Using a Model\r\n\r\nSome examples, most native functionality from MongoDB will work here.\r\n```js\r\nimport User from \"./models/User\";\r\n\r\nawait User.count({ email: \"@example.com\" });\r\nawait User.findOne({ email: \"@example.com\" });\r\nawait User.findOneOrCreate({ email: \"@example.com\" }, { name: \"test\", email: \"@example.com\" });\r\nawait User.findOneAndUpdate({ email: \"@example.com\" }, { name: \"test\", email: \"new@example.com\" }, \"$set\");\r\nawait User.insertOne({ name: \"test\", email: \"@example.com\" });\r\nawait User.updateOne({ email: \"@example.com\" }, { name: \"test\", email: \"new@example.com\" }, \"$set\");\r\nawait User.removeOne({ email: \"@example.com\" });\r\n```\r\n\r\n### Using QueryBuilder\r\n\r\nThis is **not** a recommend way of doing my library, as you're essentially doing the same thing as using the native MongoDB driver. However, you can use the QueryBuilder class directly to interact with the Database which will skip the entire Model/Schematic aspect of the library.\r\n\r\nThe only difference is you will specify the collection name manually, like in the example it's doing the queries in the `users` collection.\r\n\r\n```js\r\nimport MongoODM from \"@cameronct/mongo-odm\";\r\n\r\nconst queryBuilder = new MongoODM.QueryBuilder();\r\n\r\nawait queryBuilder.count(\"users\", { email: \"@example.com\" });\r\nawait queryBuilder.findOne(\"users\", { email: \"@example.com\" });\r\nawait queryBuilder.findOneOrCreate(\"users\", { email: \"@example.com\" }, { name: \"test\", email: \"@example.com\" });\r\nawait queryBuilder.findOneAndUpdate(\"users\", { email: \"@example.com\" }, { name: \"test\", email: \"new@example.com\" }, \"$set\");\r\nawait queryBuilder.insertOne(\"users\", { name: \"test\", email: \"@example.com\" });\r\nawait queryBuilder.updateOne(\"users\", { email: \"@example.com\" }, { name: \"test\", email: \"new@example.com\" }, \"$set\");\r\nawait queryBuilder.removeOne(\"users\", { email: \"@example.com\" });\r\n```\r\n\r\n### Documents\r\nWhen a document is inserted into the collection, we specifically add `createdAt` field for new documents using `insertOne`, `insertMany` and `findOneOrCreate`. \r\nWe also add an `updatedAt` field for new documents using `updateOne`, `updateMany` and `findOneAndUpdate`\r\n\r\nThese parameters **cannot** be overridden inside of the Model. I may change this functionality later, but for now it is what it is.\r\n\r\n## Tests\r\n\r\nInserting 50,000 documents using `insertMany`. Code for generating documents is below.\r\n```js\r\nfunction generateTestData() {\r\n const documents = Array.from({ length: 50000 }, (_, index) => ({\r\n name: `Student ${index}`,\r\n age: Math.floor(Math.random() * 100),\r\n }));\r\n\r\n return documents;\r\n}\r\n```\r\n\r\nResults:\r\n```\r\nMongoDB Native Test completed in 297 milliseconds\r\nMongoose Test completed in 1883 milliseconds\r\nMongoODM Test completed in 313 milliseconds\r\n```\r\n","readmeFilename":"README.md"}
![](\"https://i.imgur.com/0Mldh0I.png\")
\r\n![](\"https://img.shields.io/badge/GitHub-CameronCT-181717.svg?style=flat&logo=github\"){kind=icon}
![](\"https://img.shields.io/codecov/c/github/CameronCT/Mongo-ODM\")
![](\"https://img.shields.io/github/issues/CameronCT/Mongo-ODM\")
![](\"https://img.shields.io/github/license/CameronCT/Mongo-ODM\")
\r\n