mongoose-master.zip

# Mongoose Mongoose is a [MongoDB](https://www.mongodb.org/) object modeling tool designed to work in an asynchronous environment. Mongoose supports [Node.js](https://nodejs.org/en/) and [Deno](https://deno.land/) (alpha). [](https://github.com/Automattic/mongoose) [](http://badge.fury.io/js/mongoose) [](https://deno.land/x/mongoose) [](https://deno.land/x/mongoose) [](https://www.npmjs.com/package/mongoose) ## Documentation The official documentation website is [mongoosejs.com](http://mongoosejs.com/). Mongoose 7.0.0 was released on February 27, 2023. You can find more details on [backwards breaking changes in 7.0.0 on our docs site](https://mongoosejs.com/docs/migrating_to_7.html). ## Support * [Stack Overflow](http://stackoverflow.com/questions/tagged/mongoose) * [Bug Reports](https://github.com/Automattic/mongoose/issues/) * [Mongoose Slack Channel](http://slack.mongoosejs.io/) * [Help Forum](http://groups.google.com/group/mongoose-orm) * [MongoDB Support](https://www.mongodb.com/docs/manual/support/) ## Plugins Check out the [plugins search site](http://plugins.mongoosejs.io/) to see hundreds of related modules from the community. Next, learn how to write your own plugin from the [docs](http://mongoosejs.com/docs/plugins.html) or [this blog post](http://thecodebarbarian.com/2015/03/06/guide-to-mongoose-plugins). ## Contributors Pull requests are always welcome! Please base pull requests against the `master` branch and follow the [contributing guide](https://github.com/Automattic/mongoose/blob/master/CONTRIBUTING.md). If your pull requests makes documentation changes, please do **not** modify any `.html` files. The `.html` files are compiled code, so please make your changes in `docs/*.pug`, `lib/*.js`, or `test/docs/*.js`. View all 400+ [contributors](https://github.com/Automattic/mongoose/graphs/contributors). ## Installation First install [Node.js](http://nodejs.org/) and [MongoDB](https://www.mongodb.org/downloads). Then: ```sh npm install mongoose ``` Mongoose 6.8.0 also includes alpha support for [Deno](https://deno.land/). ## Importing ```javascript // Using Node.js `require()` const mongoose = require('mongoose'); // Using ES6 imports import mongoose from 'mongoose'; ``` Or, using [Deno's `createRequire()` for CommonJS support](https://deno.land/[email protected]/node/README.md?source=#commonjs-modules-loading) as follows. ```javascript import { createRequire } from 'https://deno.land/[email protected]/node/module.ts'; const require = createRequire(import.meta.url); const mongoose = require('mongoose'); mongoose.connect('mongodb://127.0.0.1:27017/test') .then(() => console.log('Connected!')); ``` You can then run the above script using the following. ```sh deno run --allow-net --allow-read --allow-sys --allow-env mongoose-test.js ``` ## Mongoose for Enterprise Available as part of the Tidelift Subscription The maintainers of mongoose and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-mongoose?utm_source=npm-mongoose&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) ## Overview ### Connecting to MongoDB First, we need to define a connection. If your app uses only one database, you should use `mongoose.connect`. If you need to create additional connections, use `mongoose.createConnection`. Both `connect` and `createConnection` take a `mongodb://` URI, or the parameters `host, database, port, options`. ```js await mongoose.connect('mongodb://127.0.0.1/my_database'); ``` Once connected, the `open` event is fired on the `Connection` instance. If you're using `mongoose.connect`, the `Connection` is `mongoose.connection`. Otherwise, `mongoose.createConnection` return value is a `Connection`. **Note:** *If the local connection fails then try using 127.0.0.1 instead of localhost. Sometimes issues may arise when the local hostname has been changed.* **Important!** Mongoose buffers all the commands until it's connected to the database. This means that you don't have to wait until it connects to MongoDB in order to define models, run queries, etc. ### Defining a Model Models are defined through the `Schema` interface. ```js const Schema = mongoose.Schema; const ObjectId = Schema.ObjectId; const BlogPost = new Schema({ author: ObjectId, title: String, body: String, date: Date }); ``` Aside from defining the structure of your documents and the types of data you're storing, a Schema handles the definition of: * [Validators](http://mongoosejs.com/docs/validation.html) (async and sync) * [Defaults](http://mongoosejs.com/docs/api/schematype.html#schematype_SchemaType-default) * [Getters](http://mongoosejs.com/docs/api/schematype.html#schematype_SchemaType-get) * [Setters](http://mongoosejs.com/docs/api/schematype.html#schematype_SchemaType-set) * [Indexes](http://mongoosejs.com/docs/guide.html#indexes) * [Middleware](http://mongoosejs.com/docs/middleware.html) * [Methods](http://mongoosejs.com/docs/guide.html#methods) definition * [Statics](http://mongoosejs.com/docs/guide.html#statics) definition * [Plugins](http://mongoosejs.com/docs/plugins.html) * [pseudo-JOINs](http://mongoosejs.com/docs/populate.html) The following example shows some of these features: ```js const Comment = new Schema({ name: { type: String, default: 'hahaha' }, age: { type: Number, min: 18, index: true }, bio: { type: String, match: /[a-z]/ }, date: { type: Date, default: Date.now }, buff: Buffer }); // a setter Comment.path('name').set(function(v) { return capitalize(v); }); // middleware Comment.pre('save', function(next) { notify(this.get('email')); next(); }); ``` Take a look at the example in [`examples/schema/schema.js`](https://github.com/Automattic/mongoose/blob/master/examples/schema/schema.js) for an end-to-end example of a typical setup. ### Accessing a Model Once we define a model through `mongoose.model('ModelName', mySchema)`, we can access it through the same function ```js const MyModel = mongoose.model('ModelName'); ``` Or just do it all at once ```js const MyModel = mongoose.model('ModelName', mySchema); ``` The first argument is the *singular* name of the collection your model is for. **Mongoose automatically looks for the *plural* version of your model name.** For example, if you use ```js const MyModel = mongoose.model('Ticket', mySchema); ``` Then `MyModel` will use the **tickets** collection, not the **ticket** collection. For more details read the [model docs](https://mongoosejs.com/docs/api/mongoose.html#mongoose_Mongoose-model). Once we have our model, we can then instantiate it, and save it: ```js const instance = new MyModel(); instance.my.key = 'hello'; await instance.save(); ``` Or we can find documents from the same collection ```js await MyModel.find({}); ``` You can also `findOne`, `findById`, `update`, etc. ```js const instance = await MyModel.findOne({ /* ... */ }); console.log(instance.my.key); // 'hello' ``` For more details check out [the docs](http://mongoosejs.com/docs/queries.html). **Important!** If you opened a separate connection using `mongoose.createConnection()` but attempt to access the model through `mongoose.model('ModelName')` it will not work as expected since it is not hooked up to an active db connection. In this case access your model through the connection you created: ```js const conn = mongoose.createConnection('your connection string'); const MyModel = conn.model