Mongoose.js

Mongoose.js.md

Guides

Schemas

SchemaTypes

Connections

Models

Documents

Subdocuments

Queries

Find

Model.find()

Model.findOne()

Model.findById()

Delete

Model.deleteMany()

Model.deleteOne()

Model.findOneAndDelete()

Model.findByIdAndDelete()

Remove

Model.findOneAndRemove()

Model.findByIdAndRemove()

Update

Model.updateMany()

Model.updateOne()

Model.findByIdAndUpdate()

Model.findOneAndUpdate()

Replace

Model.findOneAndReplace()

Model.replaceOne()

Validation

Middleware

Populate

Discriminators

Plugins

API

Mongoose

• Mongoose()
• Mongoose.prototype.Aggregate()
• Mongoose.prototype.CastError()
• Mongoose.prototype.Collection()
• Mongoose.prototype.Connection()
• Mongoose.prototype.Decimal128
• Mongoose.prototype.Document()
• Mongoose.prototype.DocumentProvider()
• Mongoose.prototype.Error()
• Mongoose.prototype.Mixed
• Mongoose.prototype.Model()
• Mongoose.prototype.Mongoose()
• Mongoose.prototype.Number
• Mongoose.prototype.ObjectId
• Mongoose.prototype.Promise
• Mongoose.prototype.PromiseProvider()
• Mongoose.prototype.Query()
• Mongoose.prototype.STATES
• Mongoose.prototype.Schema()
• Mongoose.prototype.SchemaType()
• Mongoose.prototype.SchemaTypes
• Mongoose.prototype.Types
• Mongoose.prototype.VirtualType()
• Mongoose.prototype.connect()
• Mongoose.prototype.connection
• Mongoose.prototype.connections
• Mongoose.prototype.createConnection()
• Mongoose.prototype.deleteModel()
• Mongoose.prototype.disconnect()
• Mongoose.prototype.driver
• Mongoose.prototype.get()
• Mongoose.prototype.model()
• Mongoose.prototype.modelNames()
• Mongoose.prototype.mongo
• Mongoose.prototype.mquery
• Mongoose.prototype.now()
• Mongoose.prototype.plugin()
• Mongoose.prototype.pluralize()
• Mongoose.prototype.set()
• Mongoose.prototype.startSession()
• Mongoose.prototype.version

Schema

• Schema()
• Schema.Types
• Schema.indexTypes
• Schema.prototype.add()
• Schema.prototype.childSchemas
• Schema.prototype.clone()
• Schema.prototype.eachPath()
• Schema.prototype.get()
• Schema.prototype.index()
• Schema.prototype.indexes()
• Schema.prototype.loadClass()
• Schema.prototype.method()
• Schema.prototype.obj
• Schema.prototype.path()
• Schema.prototype.pathType()
• Schema.prototype.plugin()
• Schema.prototype.post()
• Schema.prototype.pre()
• Schema.prototype.queue()
• Schema.prototype.remove()
• Schema.prototype.requiredPaths()
• Schema.prototype.set()
• Schema.prototype.static()
• Schema.prototype.virtual()
• Schema.prototype.virtualpath()
• Schema.reserved

Connection

• Connection()
• Connection.prototype.close()
• Connection.prototype.collection()
• Connection.prototype.collections
• Connection.prototype.config
• Connection.prototype.createCollection()
• Connection.prototype.db
• Connection.prototype.deleteModel()
• Connection.prototype.dropCollection()
• Connection.prototype.dropDatabase()
• Connection.prototype.get()
• Connection.prototype.host
• Connection.prototype.model()
• Connection.prototype.modelNames()
• Connection.prototype.name
• Connection.prototype.openUri()
• Connection.prototype.pass
• Connection.prototype.plugin()
• Connection.prototype.plugins
• Connection.prototype.port
• Connection.prototype.readyState
• Connection.prototype.set()
• Connection.prototype.startSession()
• Connection.prototype.useDb()
• Connection.prototype.user

Document

• Document.prototype.$ignore()
• Document.prototype.$isDefault()
• Document.prototype.$isDeleted()
• Document.prototype.$isEmpty()
• Document.prototype.$locals
• Document.prototype.$markValid()
• Document.prototype.$session()
• Document.prototype.$set()
• Document.prototype.depopulate()
• Document.prototype.directModifiedPaths()
• Document.prototype.equals()
• Document.prototype.errors
• Document.prototype.execPopulate()
• Document.prototype.get()
• Document.prototype.id
• Document.prototype.init()
• Document.prototype.inspect()
• Document.prototype.invalidate()
• Document.prototype.isDirectModified()
• Document.prototype.isDirectSelected()
• Document.prototype.isInit()
• Document.prototype.isModified()
• Document.prototype.isNew
• Document.prototype.isSelected()
• Document.prototype.markModified()
• Document.prototype.modifiedPaths()
• Document.prototype.overwrite()
• Document.prototype.populate()
• Document.prototype.populated()
• Document.prototype.replaceOne()
• Document.prototype.save()
• Document.prototype.schema
• Document.prototype.set()
• Document.prototype.toJSON()
• Document.prototype.toObject()
• Document.prototype.toString()
• Document.prototype.unmarkModified()
• Document.prototype.update()
• Document.prototype.updateOne()
• Document.prototype.validate()
• Document.prototype.validateSync()

Model

• Model()
• Model.aggregate()
• Model.bulkWrite()
• Model.count()
• Model.countDocuments()
• Model.create()
• Model.createCollection()
• Model.createIndexes()
• Model.deleteMany()
• Model.deleteOne()
• Model.discriminator()
• Model.distinct()
• Model.ensureIndexes()
• Model.estimatedDocumentCount()
• Model.events
• Model.exists()
• Model.find()
• Model.findById()
• Model.findByIdAndDelete()
• Model.findByIdAndRemove()
• Model.findByIdAndUpdate()
• Model.findOne()
• Model.findOneAndDelete()
• Model.findOneAndRemove()
• Model.findOneAndReplace()
• Model.findOneAndUpdate()
• Model.geoSearch()
• Model.hydrate()
• Model.init()
• Model.insertMany()
• Model.inspect()
• Model.listIndexes()
• Model.mapReduce()
• Model.populate()
• Model.prototype.$where
• Model.prototype.$where()
• Model.prototype.base
• Model.prototype.baseModelName
• Model.prototype.collection
• Model.prototype.db
• Model.prototype.delete
• Model.prototype.deleteOne()
• Model.prototype.discriminators
• Model.prototype.increment()
• Model.prototype.model()
• Model.prototype.modelName
• Model.prototype.remove()
• Model.prototype.save()
• Model.prototype.schema
• Model.remove()
• Model.replaceOne()
• Model.startSession()
• Model.syncIndexes()
• Model.translateAliases()
• Model.update()
• Model.updateMany()
• Model.updateOne()
• Model.watch()
• Model.where()

Query

• Query()
• Query.prototype.$where()
• Query.prototype.Symbol.asyncIterator()
• Query.prototype.all()
• Query.prototype.and()
• Query.prototype.batchSize()
• Query.prototype.box()
• Query.prototype.cast()
• Query.prototype.catch()
• Query.prototype.center()
• Query.prototype.centerSphere()
• Query.prototype.circle()
• Query.prototype.collation()
• Query.prototype.comment()
• Query.prototype.count()
• Query.prototype.countDocuments()
• Query.prototype.cursor()
• Query.prototype.deleteMany()
• Query.prototype.deleteOne()
• Query.prototype.distinct()
• Query.prototype.elemMatch()
• Query.prototype.equals()
• Query.prototype.error()
• Query.prototype.estimatedDocumentCount()
• Query.prototype.exec()
• Query.prototype.exists()
• Query.prototype.explain()
• Query.prototype.find()
• Query.prototype.findOne()
• Query.prototype.findOneAndDelete()
• Query.prototype.findOneAndRemove()
• Query.prototype.findOneAndReplace()
• Query.prototype.findOneAndUpdate()
• Query.prototype.geometry()
• Query.prototype.get()
• Query.prototype.getFilter()
• Query.prototype.getOptions()
• Query.prototype.getPopulatedPaths()
• Query.prototype.getQuery()
• Query.prototype.getUpdate()
• Query.prototype.gt()
• Query.prototype.gte()
• Query.prototype.hint()
• Query.prototype.in()
• Query.prototype.intersects()
• Query.prototype.j()
• Query.prototype.lean()
• Query.prototype.limit()
• Query.prototype.lt()
• Query.prototype.lte()
• Query.prototype.map()
• Query.prototype.maxDistance()
• Query.prototype.maxScan()
• Query.prototype.maxTimeMS()
• Query.prototype.maxscan()
• Query.prototype.merge()
• Query.prototype.mod()
• Query.prototype.mongooseOptions()
• Query.prototype.ne()
• Query.prototype.near()
• Query.prototype.nearSphere()
• Query.prototype.nin()
• Query.prototype.nor()
• Query.prototype.or()
• Query.prototype.orFail()
• Query.prototype.polygon()
• Query.prototype.populate()
• Query.prototype.projection()
• Query.prototype.read()
• Query.prototype.readConcern()
• Query.prototype.regex()
• Query.prototype.remove()
• Query.prototype.replaceOne()
• Query.prototype.select()
• Query.prototype.selected()
• Query.prototype.selectedExclusively()
• Query.prototype.selectedInclusively()
• Query.prototype.session()
• Query.prototype.set()
• Query.prototype.setOptions()
• Query.prototype.setQuery()
• Query.prototype.setUpdate()
• Query.prototype.size()
• Query.prototype.skip()
• Query.prototype.slaveOk()
• Query.prototype.slice()
• Query.prototype.snapshot()
• Query.prototype.sort()
• Query.prototype.tailable()
• Query.prototype.then()
• Query.prototype.toConstructor()
• Query.prototype.update()
• Query.prototype.updateMany()
• Query.prototype.updateOne()
• Query.prototype.use$geoWithin
• Query.prototype.w()
• Query.prototype.where()
• Query.prototype.within()
• Query.prototype.wtimeout()

Aggregate

• Aggregate()
• Aggregate.prototype.Symbol.asyncIterator()
• Aggregate.prototype.addCursorFlag
• Aggregate.prototype.addFields()
• Aggregate.prototype.allowDiskUse()
• Aggregate.prototype.append()
• Aggregate.prototype.catch()
• Aggregate.prototype.collation()
• Aggregate.prototype.count()
• Aggregate.prototype.cursor()
• Aggregate.prototype.exec()
• Aggregate.prototype.explain()
• Aggregate.prototype.facet()
• Aggregate.prototype.graphLookup()
• Aggregate.prototype.group()
• Aggregate.prototype.hint()
• Aggregate.prototype.limit()
• Aggregate.prototype.lookup()
• Aggregate.prototype.match()
• Aggregate.prototype.model()
• Aggregate.prototype.near()
• Aggregate.prototype.option()
• Aggregate.prototype.options
• Aggregate.prototype.pipeline()
• Aggregate.prototype.project()
• Aggregate.prototype.read()
• Aggregate.prototype.readConcern()
• Aggregate.prototype.redact()
• Aggregate.prototype.replaceRoot()
• Aggregate.prototype.sample()
• Aggregate.prototype.session()
• Aggregate.prototype.skip()
• Aggregate.prototype.sort()
• Aggregate.prototype.sortByCount()
• Aggregate.prototype.then()
• Aggregate.prototype.unwind()

SchemaType

• SchemaType()
• SchemaType.cast()
• SchemaType.checkRequired()
• SchemaType.get()
• SchemaType.prototype.default()
• SchemaType.prototype.get()
• SchemaType.prototype.immutable()
• SchemaType.prototype.index()
• SchemaType.prototype.ref()
• SchemaType.prototype.required()
• SchemaType.prototype.select()
• SchemaType.prototype.set()
• SchemaType.prototype.sparse()
• SchemaType.prototype.text()
• SchemaType.prototype.unique()
• SchemaType.prototype.validate()

VirtualType

• VirtualType()
• VirtualType.prototype.applyGetters()
• VirtualType.prototype.applySetters()
• VirtualType.prototype.get()
• VirtualType.prototype.set()