接続

Connectionコンストラクタ

実用上の理由から、ConnectionはDbと等価です。

この接続がMongoDBに正常に接続されたときに解決されるPromise、または接続に失敗したときに拒否されるPromiseを返します。

例

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からキャッピングされたコレクションとビューを作成するために使用されます。

オプションは、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ノードドライバの`listCollections()`のヘルパー。コレクションオブジェクトの配列を返します。

MongoDBノードドライバの`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()に渡すすべてのスキーマで実行されるプラグインを宣言します

作成する各スキーマで.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 と通信するために使用する 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;

同じ 接続プール を使用して、別のデータベースに切り替えます。

新しい db を使用した、新しい接続オブジェクトを返します。

例

// 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 issue を参照してください。
• '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);
});