连接

Connection 构造函数

出于实际原因，连接等于 Db。

返回一个 promise，当此连接成功连接到 MongoDB 时解析，或者如果此连接连接失败则拒绝。

示例

const conn = await mongoose.createConnection('mongodb://127.0.0.1:27017/test').
  asPromise();
conn.readyState; // 1, means Mongoose is connected

此连接用于与 MongoDB 交谈的 MongoClient 实例。Mongoose 在连接打开时会自动设置此属性。

关闭连接

检索原始集合实例，如果未缓存则创建它。此方法返回 [MongoDB Node.js 驱动程序集合](MongoDB Node.js 驱动程序集合) 的一个薄包装器。使用集合绕过 Mongoose 中间件、验证和转换，允许您直接使用 MongoDB Node.js 驱动程序 功能。

与此连接关联的集合的哈希值

与此连接关联的全局选项的哈希值

createCollection() 的助手。将使用指定的选项显式创建给定的集合。用于从 mongoose 创建 固定大小集合 和 视图。

选项将不经修改传递给 MongoDB 驱动程序的 createCollection() 函数

按顺序对模型调用 createCollection()。

mongodb.Db 实例，在连接打开时设置

从此连接中删除名为 name 的模型（如果存在）。您可以使用此函数清理在测试中创建的任何模型，以防止 OverwriteModelErrors。

示例

conn.model('User', new Schema({ name: String }));
console.log(conn.model('User')); // Model object
conn.deleteModel('User');
console.log(conn.model('User')); // undefined

// Usually useful in a Mocha `afterEach()` hook
afterEach(function() {
  conn.deleteModel(/.+/); // Delete every model
});

销毁连接。类似于 .close，但还会从 Mongoose 的 connections 列表中删除连接，并阻止连接重新打开。

dropCollection() 的助手。将删除给定的集合，包括所有文档和索引。

dropDatabase() 的助手。删除给定的数据库，包括所有集合、文档和索引。

示例

const conn = mongoose.createConnection('mongodb://127.0.0.1:27017/mydb');
// Deletes the entire 'mydb' database
await conn.dropDatabase();

获取选项 key 的值。等效于 conn.options[key]

示例

conn.get('test'); // returns the 'test' value

返回此连接用于与 MongoDB 交谈的 MongoDB 驱动程序 MongoClient 实例。

示例

const conn = await mongoose.createConnection('mongodb://127.0.0.1:27017/test').
  asPromise();

conn.getClient(); // MongoClient { ... }

URI 的主机名部分。如果有多个主机（例如副本集），这将包含 URI 中的第一个主机名

示例

mongoose.createConnection('mongodb://127.0.0.1:27017/mydb').host; // "127.0.0.1"

此连接的数字标识符。用于调试您有多个连接时 多个连接。

示例

// The default connection has `id = 0`
mongoose.connection.id; // 0

// If you create a new connection, Mongoose increments id
const conn = mongoose.createConnection();
conn.id; // 1

MongoDB Node 驱动程序 listCollections() 的助手。返回一个集合对象的数组。

MongoDB Node 驱动程序 listDatabases() 的助手。返回一个包含 databases 属性的对象，该属性包含一个数据库对象的数组。

示例

const { databases } = await mongoose.connection.listDatabases();
databases; // [{ name: 'mongoose_test', sizeOnDisk: 0, empty: false }]

定义或检索模型。

const mongoose = require('mongoose');
const db = mongoose.createConnection(..);
db.model('Venue', new Schema(..));
const Ticket = db.model('Ticket', new Schema(..));
const Venue = db.model('Venue');

当不传递 collection 参数时，Mongoose 通过将模型 name 传递给 utils.toCollectionName 方法来生成集合名称。此方法将名称复数化。如果您不喜欢这种行为，要么传递一个集合名称，要么设置模式的集合名称选项。

示例

const schema = new Schema({ name: String }, { collection: 'actor' });

// or

schema.set('collection', 'actor');

// or

const collectionName = 'actor'
const M = conn.model('Actor', schema, collectionName)

返回在此连接上创建的模型名称数组。

一个 POJO，其中包含一个从模型名称到模型的映射。包含已使用 Connection#model() 添加到此连接的所有模型。

示例

const conn = mongoose.createConnection();
const Test = conn.model('Test', mongoose.Schema({ name: String }));

Object.keys(conn.models).length; // 1
conn.models.Test === Test; // true

此连接指向的数据库的名称。

示例

mongoose.createConnection('mongodb://127.0.0.1:27017/mydb').name; // "mydb"

使用 MongoClient.connect() 以 URI 打开连接。

URI 中指定的密码

示例

mongoose.createConnection('mongodb://val:[email protected]:27017/mydb').pass; // "psw"

声明在您传递给 conn.model() 的所有模式上执行的插件

等效于在您创建的每个模式上调用.plugin(fn)。

示例

const db = mongoose.createConnection('mongodb://127.0.0.1:27017/mydb');
db.plugin(() => console.log('Applied'));
db.plugins.length; // 1

db.model('Test', new Schema({})); // Prints "Applied"

将应用于在此连接上创建的所有模型的插件。

示例

const db = mongoose.createConnection('mongodb://127.0.0.1:27017/mydb');
db.plugin(() => console.log('Applied'));
db.plugins.length; // 1

db.model('Test', new Schema({})); // Prints "Applied"

URI 的端口部分。如果有多个主机，例如副本集，则将包含 URI 中第一个主机名的端口。

示例

mongoose.createConnection('mongodb://127.0.0.1:27017/mydb').port; // 27017

连接就绪状态

• 0 = 已断开连接
• 1 = 已连接
• 2 = 正在连接
• 3 = 正在断开连接

每个状态更改都会发出其关联的事件名称。

示例

conn.on('connected', callback);
conn.on('disconnected', callback);

删除使用 useDb() 创建的给定名称的数据库连接。

如果未找到数据库连接，则抛出错误。

示例

// Connect to `initialdb` first
const conn = await mongoose.createConnection('mongodb://127.0.0.1:27017/initialdb').asPromise();

// Creates an un-cached connection to `mydb`
const db = conn.useDb('mydb');

// Closes `db`, and removes `db` from `conn.relatedDbs` and `conn.otherDbs`
await conn.removeDb('mydb');

设置选项 key 的值。等效于 conn.options[key] = val

支持的选项包括

• maxTimeMS: 为此连接上的所有查询设置maxTimeMS。
• 'debug': 如果为 true，则将 Mongoose 发送到 MongoDB 的操作打印到控制台。如果传递了一个可写流，它将记录到该流，不进行着色。如果传递了回调函数，它将收到集合名称、方法名称，然后是传递给该方法的所有参数。例如，如果您想复制默认日志记录，您可以从回调输出 Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})。

示例

conn.set('test', 'foo');
conn.get('test'); // 'foo'
conn.options.test; // 'foo'

设置MongoDB 驱动程序 MongoClient 实例，此连接使用该实例与 MongoDB 交谈。如果您已经拥有 MongoClient 实例，并且想要重用它，这很有用。

示例

const client = await mongodb.MongoClient.connect('mongodb://127.0.0.1:27017/test');

const conn = mongoose.createConnection().setClient(client);

conn.getClient(); // MongoClient { ... }
conn.readyState; // 1, means 'CONNECTED'

需要 MongoDB >= 3.6.0. 启动一个MongoDB 会话，以获得因果一致性、可重试写入 和事务 等优势。

示例

const session = await conn.startSession();
let doc = await Person.findOne({ name: 'Ned Stark' }, null, { session });
await doc.remove();
// `doc` will always be null, even if reading from a replica set
// secondary. Without causal consistency, it is possible to
// get a doc back from the below query if the query reads from a
// secondary that is experiencing replication lag.
doc = await Person.findOne({ name: 'Ned Stark' }, null, { session, readPreference: 'secondary' });

同步与此连接注册的所有模型的索引。

需要 MongoDB >= 3.6.0. 在事务中执行包装的异步函数。如果异步函数成功执行，Mongoose 将提交事务，如果出现可重试错误，则尝试重试。

调用 MongoDB 驱动程序的session.withTransaction()，但还处理如下所示的重置 Mongoose 文档状态。

示例

const doc = new Person({ name: 'Will Riker' });
await db.transaction(async function setRank(session) {
  doc.rank = 'Captain';
  await doc.save({ session });
  doc.isNew; // false

  // Throw an error to abort the transaction
  throw new Error('Oops!');
},{ readPreference: 'primary' }).catch(() => {});

// true, `transaction()` reset the document's state because the
// transaction was aborted.
doc.isNew;

使用相同的连接池 切换到不同的数据库。

返回一个新的连接对象，其中包含新的数据库。

示例

// Connect to `initialdb` first
const conn = await mongoose.createConnection('mongodb://127.0.0.1:27017/initialdb').asPromise();

// Creates an un-cached connection to `mydb`
const db = conn.useDb('mydb');
// Creates a cached connection to `mydb2`. All calls to `conn.useDb('mydb2', { useCache: true })` will return the same
// connection instance as opposed to creating a new connection instance
const db2 = conn.useDb('mydb2', { useCache: true });

URI 中指定的用户名

示例

mongoose.createConnection('mongodb://val:[email protected]:27017/mydb').user; // "val"

监视整个底层数据库以进行更改。类似于Model.watch()。

此函数不会触发任何中间件。特别是，它不会触发聚合中间件。

ChangeStream 对象是一个事件发射器，它会发出以下事件

• 'change': 发生了更改，请参见下面的示例
• 'error': 发生了不可恢复的错误。特别是，更改流目前会在它们与副本集主服务器失去连接时出错。关注此 GitHub 问题 以获取更新。
• 'end': 如果底层流关闭，则发出
• 'close': 如果底层流关闭，则发出

示例

const User = conn.model('User', new Schema({ name: String }));

const changeStream = conn.watch().on('change', data => console.log(data));

// Triggers a 'change' event on the change stream.
await User.create({ name: 'test' });

connection.client.withSession() 的便捷包装器。

示例

await conn.withSession(async session => {
  const doc = await TestModel.findOne().session(session);
});