mongoose

(★ 27,472)

MongoDB object modeling designed to work in an asynchronous environment.

File Explorer

Download Latest Version (.zip)

- - codeql-config.yml
- - type-tests.instructions.md
- - bug.yml
  - config.yml
  - feature.yml
  - help.yml
  - other.yml
  - performance.yml
- - benchmark.yml
  - codeql.yml
  - documentation.yml
  - encryption-tests.yml
  - publish.yml
  - stale.yml
  - test.yml
  - tidelift-alignment.yml
  - types.yml
- dependabot.yml
- FUNDING.yml
- PULL_REQUEST_TEMPLATE.md
- - infer.bench.mts
- createDeepNestedDocArray.js
- findOneAndUpdateSimple.js
- findOneWithCast.js
- get.js
- insertManySimple.js
- mapOfSubdocs.js
- nestedArrayLarge.js
- recursiveToObject.js
- saveSimple.js
- - api.css
  - carbonads.css
  - copy-code.css
  - github.css
  - home.css
  - mongoose9.css
  - railway-ad-4.jpg
  - railway-ad-6.jpg
  - search.css
  - style.css
- - asyncawait.png
  - dk.png
  - fortunegames.jpg
  - helloclub.svg
  - link_64x64.png
  - localize-mongoose-ad-banner-2x.jpg
  - logo-poprey-com-white-100.png
  - mixmax.png
  - mongoose-red.svg
  - mongoose.svg
  - pencil.svg
  - save-lifecycle-dark.svg
  - save-lifecycle.svg
  - search.svg
  - square_bg.png
  - tidelift.svg
- - favicon.pug
  - nav.pug
- - api-bold-current-nav.js
  - ask-ai.js
  - convert-old-anchorid.js
  - copy-code.js
  - mobile-navbar-toggle.js
  - native.js
  - navbar-search.js
  - redirect-old-api.js
  - search.js
  - sidebar-collapse.js
  - theme-toggle.js
  - toc.js
  - version-picker.js
- - api.js
  - home.js
  - index.js
  - tutorials.js
  - typescript.js
  - utils.js
- - custom-casting.md
  - dates.md
  - findoneandupdate.md
  - getters-setters.md
  - lean.md
  - query_casting.md
  - ssl.md
  - virtuals.md
- - populate.md
  - queries.md
  - query-helpers.md
  - schemas.md
  - statics-and-methods.md
  - subdocuments.md
  - virtuals.md
- advanced_schemas.md
- api.md
- api_split.pug
- async-await.md
- browser.md
- change-streams.md
- check-version.md
- compatibility.md
- connections.md
- customschematypes.md
- defaults.md
- deprecations.md
- discriminators.md
- documents.md
- enterprise.md
- faq.md
- field-level-encryption.md
- further_reading.md
- geojson.md
- guide.md
- guides.md
- incompatible_packages.md
- index.md
- jest.md
- lambda.md
- layout.pug
- lodash.md
- middleware.md
- migrating_to_5.md
- migrating_to_6.md
- migrating_to_7.md
- migrating_to_8.md
- migrating_to_9.md
- migration.md
- models.md
- nextjs.md
- plugins.md
- populate.md
- promises.md
- queries.md
- schematypes.md
- search.pug
- shared-schemas.md
- sponsors.pug
- subdocs.md
- timestamps.md
- transactions.md
- typescript.md
- validation.md
- version-support.md
- - bigint.js
  - boolean.js
  - date.js
  - decimal128.js
  - double.js
  - int32.js
  - number.js
  - objectid.js
  - string.js
  - uuid.js
- - aggregationCursor.js
  - changeStream.js
  - queryCursor.js
- - SPEC.md
- - browserMissingSchema.js
  - bulkSaveIncompleteError.js
  - bulkWriteError.js
  - cast.js
  - createCollectionsError.js
  - divergentArray.js
  - eachAsyncMultiError.js
  - index.js
  - invalidSchemaOption.js
  - messages.js
  - missingSchema.js
  - mongooseError.js
  - notFound.js
  - objectExpected.js
  - objectParameter.js
  - overwriteModel.js
  - parallelSave.js
  - parallelValidate.js
  - serverSelection.js
  - setOptionError.js
  - strict.js
  - strictPopulate.js
  - syncIndexes.js
  - validation.js
  - validator.js
  - version.js
- - arrayDepth.js
  - buildMiddlewareFilter.js
  - clone.js
  - common.js
  - each.js
  - firstKey.js
  - get.js
  - getConstructorName.js
  - getDefaultBulkwriteResult.js
  - getFunctionName.js
  - immediate.js
  - isAsyncFunction.js
  - isBsonType.js
  - isMongooseObject.js
  - isObject.js
  - isPOJO.js
  - isPromise.js
  - isSimpleValidator.js
  - minimize.js
  - omitUndefined.js
  - once.js
  - parallelLimit.js
  - pathTrie.js
  - pluralize.js
  - printJestWarning.js
  - processConnectionOptions.js
  - setDefaultsOnInsert.js
  - specialProperties.js
  - symbols.js
  - timers.js
  - updateValidators.js
- - populateOptions.js
  - propertyOptions.js
  - saveOptions.js
  - schemaArrayOptions.js
  - schemaBufferOptions.js
  - schemaDateOptions.js
  - schemaDocumentArrayOptions.js
  - schemaMapOptions.js
  - schemaNumberOptions.js
  - schemaObjectIdOptions.js
  - schemaStringOptions.js
  - schemaSubdocumentOptions.js
  - schemaTypeOptions.js
  - schemaUnionOptions.js
  - virtualOptions.js
- - index.js
  - saveSubdocs.js
  - sharding.js
  - trackTransaction.js
- - array.js
  - bigint.js
  - boolean.js
  - buffer.js
  - date.js
  - decimal128.js
  - documentArray.js
  - documentArrayElement.js
  - double.js
  - index.js
  - int32.js
  - map.js
  - mixed.js
  - number.js
  - objectId.js
  - string.js
  - subdocument.js
  - symbols.js
  - union.js
  - uuid.js
- - convertErrorToIssues.js
- - arraySubdocument.js
  - buffer.js
  - decimal128.js
  - double.js
  - index.js
  - map.js
  - objectid.js
  - subdocument.js
  - uuid.js
- aggregate.js
- cast.js
- collection.js
- connection.js
- connectionState.js
- constants.js
- document.js
- driver.js
- index.js
- internal.js
- model.js
- modifiedPathsSnapshot.js
- mongoose.js
- options.js
- query.js
- queryHelpers.js
- schema.js
- schemaType.js
- stateMachine.js
- tracing.js
- utils.js
- validOptions.js
- virtualType.js
- configure-cluster-with-encryption.sh
- create-tarball.js
- generateLLMsTXT.js
- generateSearch.js
- loadSponsorData.js
- setup-encryption-tests.js
- static.js
- tsc-diagnostics-check.js
- update-mongodb-links.js
- website.js
- - asyncIterator.test.js
  - cast.test.js
  - custom-casting.test.js
  - date.test.js
  - debug.test.js
  - defaults.test.js
  - discriminators.test.js
  - findoneandupdate.test.js
  - getters-setters.test.js
  - lean.test.js
  - promises.test.js
  - schemas.test.js
  - schematypes.test.js
  - transactions.test.js
  - validation.test.js
  - virtuals.test.js
- - encryption.test.js
- - aggregate.test.js
  - applyWriteConcern.test.js
  - arrayDepth.test.js
  - clone.test.js
  - common.test.js
  - cursor.eachAsync.test.js
  - document.getDeepestSubdocumentForPath.js
  - get.test.js
  - getFunctionName.test.js
  - getModelsMapForPopulate.test.js
  - indexes.getRelatedIndexes.test.js
  - indexes.isIndexEqual.test.js
  - indexes.isIndexSpecEqual.js
  - isAsyncFunction.test.js
  - isBsonType.test.js
  - isMongooseObject.test.js
  - isObject.test.js
  - isSimpleValidator.test.js
  - pathTrie.test.js
  - populate.getSchemaTypes.test.js
  - populate.getVirtual.test.js
  - populate.splitPopulateQuery.test.js
  - projection.applyProjection.test.js
  - projection.isExclusive.test.js
  - projection.isInclusive.test.js
  - projection.test.js
  - query.cast$expr.test.js
  - query.castUpdate.test.js
  - query.sanitizeFilter.test.js
  - query.selectPopulatedFields.test.js
  - query.test.js
  - schema.cleanPositionalOperators.test.js
  - schema.getPath.test.js
  - schema.getSubdocumentStrictValue.test.js
  - setDefaultsOnInsert.test.js
  - setDottetPath.test.js
  - update.applyTimestampsToChildren.test.js
  - update.applyTimestampsToUpdate.test.js
  - update.castArrayFilters.test.js
  - update.removeUnusedArrayFilters.test.js
- - project-has-error.toJSON.js
- - aggregate.test.ts
  - base.test.ts
  - check-types-filename.js
  - collection.test.ts
  - connect.test.ts
  - connection.test.ts
  - create.test.ts
  - discriminator.test.ts
  - docArray.test.ts
  - document.test.ts
  - Errors.test.ts
  - esm.test.ts
  - expressions.test.ts
  - generics.test.ts
  - helpers.test.ts
  - inferhydrateddoctype.test.ts
  - inferrawdoctype.test.ts
  - lean.test.ts
  - loadclass.test.ts
  - maps.test.ts
  - methods.test.ts
  - middleware.preposttypes.test.ts
  - middleware.test.ts
  - model.skip.middleware.test.ts
  - models.test.ts
  - mongo.test.ts
  - objectid.test.ts
  - PipelineStage.test.ts
  - plugin.test.ts
  - populate.test.ts
  - queries.test.ts
  - querycursor.test.ts
  - queryhelpers.test.ts
  - sanitizeFilter.test.ts
  - schema.create.test.ts
  - schema.test.ts
  - schemaTypeOptions.test.ts
  - subdocuments.test.ts
  - tsconfig.json
  - utility.test.ts
  - virtuals.test.ts
- aggregate.test.js
- bigint.test.js
- cast.number.test.js
- cast.test.js
- collection.capped.test.js
- collection.test.js
- common.js
- connection.test.js
- connection_server.js
- deno.mjs
- deno_mocha.mjs
- document.isselected.test.js
- document.modified.test.js
- document.populate.test.js
- document.strict.test.js
- document.strictRead.test.js
- document.test.js
- document.unit.test.js
- double.test.js
- driver.test.js
- encryptedSchema.test.js
- errors.validation.test.js
- esm.test.js
- geojson.test.js
- gh-1408.test.js
- index.test.js
- insertOne.validation.test.js
- int32.test.js
- mocha-fixtures.js
- model.aggregate.test.js
- model.countDocuments.test.js
- model.create.test.js
- model.discriminator.querying.test.js
- model.discriminator.test.js
- model.field.selection.test.js
- model.findByIdAndUpdate.test.js
- model.findOneAndDelete.test.js
- model.findOneAndReplace.test.js
- model.findOneAndUpdate.test.js
- model.hydrate.test.js
- model.indexes.test.js
- model.insertMany.test.js
- model.middleware.preposttypes.test.js
- model.middleware.test.js
- model.populate.divergent.test.js
- model.populate.setting.test.js
- model.populate.test.js
- model.query.casting.test.js
- model.querying.test.js
- model.skip.middleware.test.js
- model.test.js
- model.translateAliases.test.js
- model.updateOne.test.js
- model.validate.test.js
- model.watch.test.js
- multiple-require-instance.test.js
- object.create.null.test.js
- parallelLimit.test.js
- plugin.idGetter.test.js
- query.cursor.test.js
- query.middleware.test.js
- query.test.js
- query.toconstructor.test.js
- queryhelpers.test.js
- schema.alias.test.js
- schema.boolean.test.js
- schema.date.test.js
- schema.documentarray.test.js
- schema.mixed.test.js
- schema.number.test.js
- schema.onthefly.test.js
- schema.path.test.js
- schema.pathType.test.js
- schema.select.test.js
- schema.string.test.js
- schema.subdocumentpath.test.js
- schema.test.js
- schema.union.test.js
- schema.uuid.test.js
- schema.validation.test.js
- schemaname.test.js
- schematype.cast.test.js
- schematype.test.js
- shard.test.js
- sharding.test.js
- subdirs.test.js
- timestamps.test.js
- tracing.test.js
- types.array.test.js
- types.buffer.test.js
- types.decimal128.test.js
- types.document.test.js
- types.documentarray.test.js
- types.embeddeddocument.test.js
- types.embeddeddocumentdeclarative.test.js
- types.map.test.js
- types.number.test.js
- types.subdocument.test.js
- util.js
- utils.test.js
- versioning.test.js
- virtualtype.test.js
- auth.js
- repl.js
- sharded.js
- .gitignore
- aggregate.d.ts
- augmentations.d.ts
- callback.d.ts
- collection.d.ts
- connection.d.ts
- cursor.d.ts
- document.d.ts
- error.d.ts
- expressions.d.ts
- helpers.d.ts
- index.d.ts
- indexes.d.ts
- inferhydrateddoctype.d.ts
- inferrawdoctype.d.ts
- inferschematype.d.ts
- middlewares.d.ts
- models.d.ts
- mongooseoptions.d.ts
- pipelinestage.d.ts
- populate.d.ts
- query.d.ts
- schemaoptions.d.ts
- schematypes.d.ts
- session.d.ts
- tracing.d.ts
- types.d.ts
- utility.d.ts
- validation.d.ts
- virtuals.d.ts
.gitignore
.markdownlint-cli2.cjs
.mocharc.yml
.npmignore
.npmrc
CHANGELOG.md
CNAME
CONTRIBUTING.md
eslint.config.mjs
History.md
index.js
index.pug
lgtm.yml
LICENSE.md
migrating_to_5.md
package.json
README.md
release-items.md
SECURITY.md
tsconfig.json
tstyche.json

# Installation Guide

1. Get the code

git clone https://github.com/Automattic/mongoose

Downloads the entire project code from GitHub to your computer.

cd mongoose

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install mongoose

Downloads and installs the libraries listed in package.json.

pnpm add mongoose

Type this command into your terminal and run it.

yarn add mongoose

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

mongoose

File Explorer

# Installation Guide

2. Node.js

Today's picks

Was this content helpful?

Recent Feedback

mongoose

File Explorer

# Installation Guide

2. Node.js

Today's picks

Was this content helpful?

Recent Feedback

Download README