連線

連線建構函式

基於實務考量，一個連線等於一個 Db。

返回一個 promise，當此連線成功連線到 MongoDB 時 resolve，或當此連線連線失敗時 reject。

範例

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 驅動程式集合) 的精簡包裝器。使用 Collection 會繞過 Mongoose 中介軟體、驗證和類型轉換，讓您可以直接使用 MongoDB Node.js 驅動程式 功能。

與此連線關聯的集合的雜湊表

與此連線關聯的全域選項的雜湊表

createCollection() 的輔助函式。將明確使用指定的選項建立給定的集合。用於從 mongoose 建立 capped 集合 和 視圖。

選項會未經修改地傳遞到 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:psw@127.0.0.1:27017/mydb').pass; // "psw"

宣告一個外掛程式，該外掛程式會在您傳遞給 conn.model() 的所有 Schema 上執行

等同於對您建立的每個 Schema 呼叫 .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 的 Port 部分。如果有多個主機（例如副本集），則此處將包含 URI 中第一個主機名稱的 Port。

範例

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 通訊的 MongoDB 驅動程式 MongoClient 實例。如果您已經有 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:psw@127.0.0.1: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);
});