Advanced Schemas
diff --git a/docs/api.html b/docs/api.html
index 2e69559fca0..45ef5940aae 100644
--- a/docs/api.html
+++ b/docs/api.html
@@ -1,5 +1,5 @@
-Mongoose v8.1.3: Redirect to API
+Mongoose v8.2.0: Redirect to API
Redirecting
diff --git a/docs/api/aggregate.html b/docs/api/aggregate.html
index df9ddb4ac5b..a9121445f41 100644
--- a/docs/api/aggregate.html
+++ b/docs/api/aggregate.html
@@ -1,4 +1,4 @@
-Mongoose v8.1.3: Aggregate
+Mongoose v8.2.0: Aggregate
Aggregate
+Mongoose v8.2.0: AggregationCursor
AggregationCursor
+Mongoose v8.2.0: Array
Array
+Mongoose v8.2.0: ArraySubdocument
ArraySubdocument
+Mongoose v8.2.0: Buffer
Buffer
+Mongoose v8.2.0: Connection
\ No newline at end of file
diff --git a/docs/api/decimal128.html b/docs/api/decimal128.html
index 80813ecf014..0c9fd5e4e9f 100644
--- a/docs/api/decimal128.html
+++ b/docs/api/decimal128.html
@@ -1,4 +1,4 @@
-Mongoose v8.1.3: Decimal128
Connection
Connection()Connection.prototype.asPromise()Connection.prototype.clientConnection.prototype.close()Connection.prototype.collection()Connection.prototype.collectionsConnection.prototype.configConnection.prototype.createCollection()Connection.prototype.createCollections()Connection.prototype.dbConnection.prototype.deleteModel()Connection.prototype.destroy()Connection.prototype.dropCollection()Connection.prototype.dropDatabase()Connection.prototype.get()Connection.prototype.getClient()Connection.prototype.hostConnection.prototype.idConnection.prototype.listCollections()Connection.prototype.model()Connection.prototype.modelNames()Connection.prototype.modelsConnection.prototype.nameConnection.prototype.openUri()Connection.prototype.passConnection.prototype.plugin()Connection.prototype.pluginsConnection.prototype.portConnection.prototype.readyStateConnection.prototype.removeDb()Connection.prototype.set()Connection.prototype.setClient()Connection.prototype.startSession()Connection.prototype.syncIndexes()Connection.prototype.transaction()Connection.prototype.useDb()Connection.prototype.userConnection.prototype.watch()
Connection()
Parameters:
base+})();Connection()Connection.prototype.asPromise()Connection.prototype.clientConnection.prototype.close()Connection.prototype.collection()Connection.prototype.collectionsConnection.prototype.configConnection.prototype.createCollection()Connection.prototype.createCollections()Connection.prototype.dbConnection.prototype.deleteModel()Connection.prototype.destroy()Connection.prototype.dropCollection()Connection.prototype.dropDatabase()Connection.prototype.get()Connection.prototype.getClient()Connection.prototype.hostConnection.prototype.idConnection.prototype.listCollections()Connection.prototype.model()Connection.prototype.modelNames()Connection.prototype.modelsConnection.prototype.nameConnection.prototype.openUri()Connection.prototype.passConnection.prototype.plugin()Connection.prototype.pluginsConnection.prototype.portConnection.prototype.readyStateConnection.prototype.removeDb()Connection.prototype.set()Connection.prototype.setClient()Connection.prototype.startSession()Connection.prototype.syncIndexes()Connection.prototype.transaction()Connection.prototype.useDb()Connection.prototype.userConnection.prototype.watch()Connection.prototype.withSession()
Connection()Parameters:
base«Mongoose» a mongoose instance
Inherits:
Connection constructor
For practical reasons, a Connection equals a Db.
@@ -363,5 +363,13 @@Example:
// Triggers a 'change' event on the change stream. await User.create({ name: 'test' }); + +Connection.prototype.withSession()Parameters:
executor+«Function» called with 1 argument: aClientSessioninstance +
Returns:
- «Promise» resolves to the return value of the executor function
A convenience wrapper for
+connection.client.withSession().Example:
+await conn.withSession(async session => { + const doc = await TestModel.findOne().session(session); +});
+Mongoose v8.2.0: Decimal128
Decimal128
+Mongoose v8.2.0: Document
Document
+Mongoose v8.2.0: DocumentArray
DocumentArray
+Mongoose v8.2.0: Error
Error
+Mongoose v8.2.0: Map
Map
+Mongoose v8.2.0: Model
Model
Model()Model.$where()Model.aggregate()Model.applyDefaults()Model.bulkSave()Model.bulkWrite()Model.castObject()Model.cleanIndexes()Model.countDocuments()Model.create()Model.createCollection()Model.createIndexes()Model.createSearchIndex()Model.dbModel.deleteMany()Model.deleteOne()Model.diffIndexes()Model.discriminator()Model.distinct()Model.dropSearchIndex()Model.ensureIndexes()Model.estimatedDocumentCount()Model.eventsModel.exists()Model.find()Model.findById()Model.findByIdAndDelete()Model.findByIdAndUpdate()Model.findOne()Model.findOneAndDelete()Model.findOneAndReplace()Model.findOneAndUpdate()Model.hydrate()Model.init()Model.insertMany()Model.inspect()Model.listIndexes()Model.populate()Model.prototype.$model()Model.prototype.$whereModel.prototype.baseModel.prototype.baseModelNameModel.prototype.collectionModel.prototype.collectionModel.prototype.dbModel.prototype.deleteOne()Model.prototype.discriminatorsModel.prototype.increment()Model.prototype.model()Model.prototype.modelNameModel.prototype.save()Model.replaceOne()Model.schemaModel.startSession()Model.syncIndexes()Model.translateAliases()Model.updateMany()Model.updateOne()Model.updateSearchIndex()Model.validate()Model.watch()Model.where()
Model()
Parameters:
doc+})();Model()Model.$where()Model.aggregate()Model.applyDefaults()Model.bulkSave()Model.bulkWrite()Model.castObject()Model.cleanIndexes()Model.countDocuments()Model.create()Model.createCollection()Model.createIndexes()Model.createSearchIndex()Model.dbModel.deleteMany()Model.deleteOne()Model.diffIndexes()Model.discriminator()Model.distinct()Model.dropSearchIndex()Model.ensureIndexes()Model.estimatedDocumentCount()Model.eventsModel.exists()Model.find()Model.findById()Model.findByIdAndDelete()Model.findByIdAndUpdate()Model.findOne()Model.findOneAndDelete()Model.findOneAndReplace()Model.findOneAndUpdate()Model.hydrate()Model.init()Model.insertMany()Model.inspect()Model.listIndexes()Model.populate()Model.prototype.$model()Model.prototype.$whereModel.prototype.baseModel.prototype.baseModelNameModel.prototype.collectionModel.prototype.collectionModel.prototype.dbModel.prototype.deleteOne()Model.prototype.discriminatorsModel.prototype.increment()Model.prototype.model()Model.prototype.modelNameModel.prototype.save()Model.recompileSchema()Model.replaceOne()Model.schemaModel.startSession()Model.syncIndexes()Model.translateAliases()Model.updateMany()Model.updateOne()Model.updateSearchIndex()Model.validate()Model.watch()Model.where()
Model()Parameters:
doc«Object» values for initial set[fields]«Object» optional object containing the fields that were selected in the query which returned this document. You do not need to set this parameter to ensure Mongoose handles your query projection. @@ -735,6 +735,8 @@Note:
«Object» optional options[options.setters=false]«Boolean» if true, apply schema setters when hydrating +[options.hydratedPopulatedDocs=false]+«Boolean» if true, populates the docs if passing pre-populated data
Returns:
- «Document» document instance
Shortcut for creating a new Document from existing raw data, pre-saved in the DB. The document returned has no paths marked as modified initially.
Example:
@@ -944,6 +946,21 @@Example:
Example:
const newProduct = await product.save(); newProduct === product; // true +Model.recompileSchema()Returns:
- «undefined,void»
Apply changes made to this model's schema after this model was compiled. +By default, adding virtuals and other properties to a schema after the model is compiled does nothing. +Call this function to apply virtuals and properties that were added later.
+Example:
+const schema = new mongoose.Schema({ field: String }); +const TestModel = mongoose.model('Test', schema); +TestModel.schema.virtual('myVirtual').get(function() { + return this.field + ' from myVirtual'; +}); +const doc = new TestModel({ field: 'Hello' }); +doc.myVirtual; // undefined + +TestModel.recompileSchema(); +doc.myVirtual; // 'Hello from myVirtual'Model.replaceOne()Parameters:
filter«Object»docdiff --git a/docs/api/mongoose.html b/docs/api/mongoose.html index 6dbaba8ef53..57e6af89679 100644 --- a/docs/api/mongoose.html +++ b/docs/api/mongoose.html @@ -1,4 +1,4 @@ -Mongoose v8.1.3: Mongoose +Mongoose v8.2.0: Mongoose
Mongoose
+Mongoose v8.2.0: Query
Query
+Mongoose v8.2.0: QueryCursor
QueryCursor
+Mongoose v8.2.0: Schema
Schema
+Mongoose v8.2.0: SchemaArray
SchemaArray
+Mongoose v8.2.0: SchemaArrayOptions
SchemaArrayOptions
+Mongoose v8.2.0: SchemaBoolean
SchemaBoolean
+Mongoose v8.2.0: SchemaBuffer
SchemaBuffer
+Mongoose v8.2.0: SchemaBufferOptions
SchemaBufferOptions
+Mongoose v8.2.0: SchemaDateOptions
SchemaDateOptions
+Mongoose v8.2.0: SchemaDocumentArray
SchemaDocumentArray