Mongoose

Mongoose コンストラクタ。

mongoose モジュールの exports オブジェクトはこのクラスのインスタンスです。ほとんどのアプリケーションはこのインスタンスを1つだけ使用します。

例

const mongoose = require('mongoose');
mongoose instanceof mongoose.Mongoose; // true

// Create a new Mongoose instance with its own `connect()`, `set()`, `model()`, etc.
const m = new mongoose.Mongoose();

Mongoose Aggregate コンストラクタ

Mongoose CastError コンストラクタ

Mongoose Collection コンストラクタ

Mongoose Connection コンストラクタ

ユーザーランド向けに接続状態を公開します。

Mongoose Date SchemaType です。

例

const schema = new Schema({ test: Date });
schema.path('test') instanceof mongoose.Date; // true

Mongoose Decimal128 SchemaType です。スキーマ内で 128ビット10進浮動小数点数 であるべきパスを宣言するために使用します。新しい Decimal128 インスタンスを作成するためにこれを使用しないでください。代わりに mongoose.Types.Decimal128 を使用してください。

例

const vehicleSchema = new Schema({ fuelLevel: mongoose.Decimal128 });

Mongoose Document コンストラクタ。

Mongoose DocumentProvider コンストラクタ。Mongoose ユーザーはこれを直接使用する必要はありません。

MongooseError コンストラクタ。

Mongoose Mixed SchemaType です。Mongoose の変更追跡、キャスティング、および検証が無視する必要があるスキーマ内のパスを宣言するために使用します。

例

const schema = new Schema({ arbitrary: mongoose.Mixed });

Mongoose Model コンストラクタ。

Mongoose コンストラクタ

mongoose モジュールのエクスポートはこのクラスのインスタンスです。

例

const mongoose = require('mongoose');
const mongoose2 = new mongoose.Mongoose();

Mongoose Number SchemaType です。Mongoose が数値にキャストする必要があるスキーマ内のパスを宣言するために使用します。

例

const schema = new Schema({ num: mongoose.Number });
// Equivalent to:
const schema = new Schema({ num: 'number' });

Mongoose ObjectId SchemaType です。スキーマ内で MongoDB ObjectId であるべきパスを宣言するために使用します。新しい ObjectId インスタンスを作成するためにこれを使用しないでください。代わりに mongoose.Types.ObjectId を使用してください。

例

const childSchema = new Schema({ parentId: mongoose.ObjectId });

Mongoose Query コンストラクタ。

ユーザーランド向けに接続状態を公開します。

Mongoose Schema コンストラクタ

例

const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const CatSchema = new Schema(..);

Mongoose SchemaType コンストラクタ

スキーマタイプオプションに使用されるコンストラクタ

さまざまな Mongoose SchemaTypes。

注記

後方互換性のために mongoose.Schema.Types のエイリアスです。

さまざまな Mongoose タイプ。

例

const mongoose = require('mongoose');
const array = mongoose.Types.Array;

タイプ

• Array
• Buffer
• 埋め込み
• DocumentArray
• Decimal128
• ObjectId
• Map
• Subdocument

ObjectId タイプへのこの公開アクセスを使用して、オンデマンドで ID を構築できます。

const ObjectId = mongoose.Types.ObjectId;
const id1 = new ObjectId;

Mongoose VirtualType コンストラクタ

デフォルトの mongoose 接続を開きます。

例

mongoose.connect('mongodb://user:pass@127.0.0.1:port/database');

// replica sets
const uri = 'mongodb://user:pass@127.0.0.1:port,anotherhost:port,yetanother:port/mydatabase';
mongoose.connect(uri);

// with options
mongoose.connect(uri, options);

// Using `await` throws "MongooseServerSelectionError: Server selection timed out after 30000 ms"
// if Mongoose can't connect.
const uri = 'mongodb://nonexistent.domain:27000';
await mongoose.connect(uri);

Mongoose モジュールのデフォルト接続。mongoose.connections[0] と同等です。connections を参照してください。

例

const mongoose = require('mongoose');
mongoose.connect(...);
mongoose.connection.on('error', cb);

これは、mongoose.model を使用して作成されたすべてのモデルにデフォルトで使用される接続です。

新しい接続を作成するには、createConnection() を使用します。

この Mongoose インスタンスに関連付けられているすべての 接続 を含む配列。デフォルトでは、接続は1つです。createConnection() を呼び出すと、この配列に接続が追加されます。

例

const mongoose = require('mongoose');
mongoose.connections.length; // 1, just the default connection
mongoose.connections[0] === mongoose.connection; // true

mongoose.createConnection('mongodb://127.0.0.1:27017/test');
mongoose.connections.length; // 2

Connection インスタンスを作成します。

各 connection インスタンスは単一のデータベースにマップされます。このメソッドは、複数のデータベース接続を管理する場合に役立ちます。

渡されたオプションは、接続文字列に含まれるオプションよりも優先されます。

例

// with mongodb:// URI
db = mongoose.createConnection('mongodb://user:pass@127.0.0.1:port/database');

// and options
const opts = { db: { native_parser: true }}
db = mongoose.createConnection('mongodb://user:pass@127.0.0.1:port/database', opts);

// replica sets
db = mongoose.createConnection('mongodb://user:pass@127.0.0.1:port,anotherhost:port,yetanother:port/database');

// and options
const opts = { replset: { strategy: 'ping', rs_name: 'testSet' }}
db = mongoose.createConnection('mongodb://user:pass@127.0.0.1:port,anotherhost:port,yetanother:port/database', opts);

// initialize now, connect later
db = mongoose.createConnection();
await db.openUri('mongodb://127.0.0.1:27017/database');

デフォルトのコネクションから、name という名前のモデルが存在する場合は削除します。この関数を使用して、テストで作成したモデルをクリーンアップし、OverwriteModelErrors を防ぐことができます。

mongoose.connection.deleteModel(name) と同等です。

例

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

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

すべてのコネクションで .close() を並列実行します。

この Mongoose インスタンスがデータベースとの通信に使用する基礎となるドライバを含む、get() と set() を持つオブジェクト。ドライバは、find() などの関数を定義する Mongoose 固有のインターフェースです。

mongoose オプションを取得します。

例

mongoose.get('test') // returns the 'test' value

指定された値が Mongoose ObjectId（instanceof を使用）である場合、または指定された値が 24 文字の16進数文字列（ObjectId の最も一般的な文字列表現）である場合、true を返します。

この関数は isValidObjectId() と似ていますが、かなり厳密です。isValidObjectId() は、Mongoose が ObjectId に変換できる*任意*の値に対して true を返すためです。これには、Mongoose ドキュメント、長さ 12 の文字列、および任意の数が含まれます。isObjectIdOrHexString() は、ObjectId インスタンスまたは 24 文字の16進数文字列に対してのみ true を返し、数値、ドキュメント、および長さ 12 の文字列に対しては false を返します。

例

mongoose.isObjectIdOrHexString(new mongoose.Types.ObjectId()); // true
mongoose.isObjectIdOrHexString('62261a65d66c6be0a63c051f'); // true

mongoose.isObjectIdOrHexString('0123456789ab'); // false
mongoose.isObjectIdOrHexString(6); // false
mongoose.isObjectIdOrHexString(new User({ name: 'test' })); // false
mongoose.isObjectIdOrHexString({ test: 42 }); // false

Mongoose が指定された値を ObjectId にキャストできる場合は true を返し、そうでない場合は false を返します。

例

mongoose.isValidObjectId(new mongoose.Types.ObjectId()); // true
mongoose.isValidObjectId('0123456789ab'); // true
mongoose.isValidObjectId(6); // true
mongoose.isValidObjectId(new User({ name: 'test' })); // true

mongoose.isValidObjectId({ test: 42 }); // false

モデルを定義または取得します。

mongoose インスタンスで定義されたモデルは、同じ mongoose インスタンスによって作成されたすべてのコネクションで使用できます。

同じ名前で異なるスキーマを使用して mongoose.model() を 2 回呼び出すと、OverwriteModelError が発生します。同じ名前とスキーマで mongoose.model() を呼び出すと、同じスキーマが返されます。

例

const mongoose = require('mongoose');

// define an Actor model with this mongoose instance
const schema = new Schema({ name: String });
mongoose.model('Actor', schema);

// create a new connection
const conn = mongoose.createConnection(..);

// create Actor model
const Actor = conn.model('Actor', schema);
conn.model('Actor') === Actor; // true
conn.model('Actor', schema) === Actor; // true, same schema
conn.model('Actor', schema, 'actors') === Actor; // true, same schema and collection name

// This throws an `OverwriteModelError` because the schema is different.
conn.model('Actor', new Schema({ name: String }));

collection 引数が渡されない場合、Mongoose はモデル名を使用します。この動作が気に入らない場合は、コレクション名を渡すか、mongoose.pluralize() を使用するか、スキーマのコレクション名オプションを設定してください。

例

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

// or

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

// or

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

この Mongoose インスタンスで作成されたモデル名の配列を返します。

注記

connection.model() を使用して作成されたモデルの名前は含まれません。

Mongoose が使用する mquery クエリビルダー。

Mongoose はこの関数を使用して、タイムスタンプ を設定する際の現在の時刻を取得します。テストのために、Sinon などのツールを使用してこの関数をスタブアウトできます。

オブジェクトを受け取り、値が厳密に undefined と等しいオブジェクトからキーを削除します。 Mongoose は TestModel.find({ name: undefined }) を TestModel.find({ name: null }) として扱うため、この関数はクエリフィルターに役立ちます。

例

const filter = { name: 'John', age: undefined, status: 'active' };
mongoose.omitUndefined(filter); // { name: 'John', status: 'active' }
filter; // { name: 'John', status: 'active' }

await UserModel.findOne(mongoose.omitUndefined(filter));

post() ミドルウェアでこの関数を使用して結果を置き換えます。

例

schema.post('find', function(res) {
  // Normally you have to modify `res` in place. But with
  // `overwriteMiddlewarResult()`, you can make `find()` return a
  // completely different value.
  return mongoose.overwriteMiddlewareResult(res.filter(doc => !doc.isDeleted));
});

すべてのスキーマで実行されるグローバルプラグインを宣言します。

作成する各スキーマで .plugin(fn) を呼び出すことと同等です。

コレクション名を複数形にするための関数のゲッター/セッター。

名前が `$` で始まるプロパティを持つネストされたオブジェクトを `$eq` でラップすることにより、クエリセレクターインジェクション攻撃 に対してクエリフィルターをサニタイズします。

const obj = { username: 'val', pwd: { $ne: null } };
sanitizeFilter(obj);
obj; // { username: 'val', pwd: { $eq: { $ne: null } } });

mongoose オプションを設定します。

key は、一度に複数のオプションを設定するためのオブジェクトとして使用できます。 1 つのオプションでエラーがスローされた場合でも、他のオプションは評価されます。

例

mongoose.set('test', value) // sets the 'test' option to `value`

mongoose.set('debug', true) // enable logging collection methods + arguments to the console/file

mongoose.set('debug', function(collectionName, methodName, ...methodArgs) {}); // use custom function to log collection methods + arguments

mongoose.set({ debug: true, autoIndex: false }); // set multiple options at once

現在サポートされているオプションは次のとおりです。

• allowDiskUse：true に設定すると、すべての集計操作でデフォルトで allowDiskUse が true に設定されます。
• applyPluginsToChildSchemas：デフォルトは `true` です。false に設定すると、グローバルプラグインが子スキーマに適用されなくなります。
• applyPluginsToDiscriminators：デフォルトは `false` です。true に設定すると、グローバルプラグインがディスクリミネータースキーマに適用されます。通常、これは必要ありません。プラグインは基本スキーマに適用され、ディスクリミネーターは基本スキーマからすべてのミドルウェア、メソッド、静的プロパティ、およびプロパティをコピーするためです。
• autoCreate：true に設定すると、mongoose.model() または conn.model() でモデルを作成するときに、Mongoose が Model.createCollection() を自動的に呼び出します。これは、トランザクション、変更ストリーム、およびコレクションが存在する必要があるその他の機能をテストするのに役立ちます。
• autoIndex：デフォルトは `true` です。false に設定すると、この Mongoose インスタンスに関連付けられているすべてのモデルの自動インデックス作成が無効になります。
• bufferCommands：すべてのコネクションとモデルの mongoose のバッファリングメカニズムを有効/無効にします。
• bufferTimeoutMS：bufferCommands がオンの場合、このオプションは、Mongoose バッファリングがエラーをスローするまで待機する最大時間を設定します。指定しない場合、Mongoose は 10000（10 秒）を使用します。
• cloneSchemas：デフォルトは `false` です。true に設定すると、モデルにコンパイルする前にすべてのスキーマが clone() されます。
• debug: `true` の場合、mongoose が MongoDB に送信する操作をコンソールに出力します。書き込み可能なストリームが渡された場合、カラー化なしでそのストリームにログを記録します。 コールバック関数が渡された場合、コレクション名、メソッド名、メソッドに渡されたすべての引数をこの順序で受け取ります。 たとえば、デフォルトのログを複製する場合、コールバック `Mongoose: ${collectionName}.${methodName}(${methodArgs.join(', ')})` から出力できます。
• id：true の場合、スキーマごとに上書きされない限り、すべてのスキーマに id 仮想フィールドを追加します。
• timestamps.createdAt.immutable: デフォルトは `true` です。 `false` の場合、`createdAt` フィールドは `immutable: false` に変更されます。これは `createdAt` を更新できることを意味します。
• maxTimeMS：設定されている場合、maxTimeMS をすべてのクエリに添付します。
• objectIdGetter：デフォルトは `true` です。Mongoose は、populate での利便性のために `this` を返す `_id` と呼ばれる MongoDB ObjectId にゲッターを追加します。 このゲッターを削除するには、false に設定します。
• overwriteModels：true に設定すると、mongoose.model() を呼び出すときに、同じ名前のモデルを上書きすることがデフォルトになります。OverwriteModelError をスローするのではなく。
• returnOriginal：false の場合、findOneAndUpdate()、findByIdAndUpdate、および findOneAndReplace() のデフォルトの returnOriginal オプションを false に変更します。これは、デフォルトで findOneAndX() 呼び出しの `new` オプションを `true` に設定することと同じです。詳細については、`findOneAndUpdate()` チュートリアル を読んでください。
• runValidators：デフォルトは `false` です。true に設定すると、デフォルトですべてのバリデーターに対して 更新バリデーター が有効になります。
• sanitizeFilter：デフォルトは `false` です。true に設定すると、名前が `$` で始まるプロパティを持つネストされたオブジェクトを `$eq` でラップすることにより、クエリフィルターのサニタイズ を有効にして、クエリセレクターインジェクション攻撃を防ぎます。
• selectPopulatedPaths：デフォルトは `true` です。false に設定すると、`populate()` するすべてのフィールドを Mongoose が `select()` に追加することをオプトアウトします。スキーマレベルのオプション `selectPopulatedPaths` はこれを上書きします。
• strict：デフォルトは `true` で、`false`、`true`、または `'throw'` です。スキーマのデフォルトの厳密モードを設定します。
• strictQuery：デフォルトは `false` です。 `false`、`true`、または `'throw'` です。スキーマのデフォルトの strictQuery モードを設定します。
• toJSON：デフォルトは `{ transform: true, flattenDecimals: true }` です。`toJSON()` へのデフォルトオブジェクトを上書きし、`JSON.stringify()` によって Mongoose ドキュメントがどのようにシリアル化されるかを決定します。
• toObject：デフォルトは `{ transform: true, flattenDecimals: true }` です。`toObject()` へのデフォルトオブジェクトを上書きします。

この Mongoose インスタンスで使用される現在のドライバを上書きします。ドライバは、`find()` などの関数を定義する Mongoose 固有のインターフェースです。

`pre()` ミドルウェアでこの関数を使用して、ラップされた関数の呼び出しをスキップします。

例

schema.pre('save', function() {
  // Will skip executing `save()`, but will execute post hooks as if
  // `save()` had executed with the result `{ matchedCount: 0 }`
  return mongoose.skipMiddlewareFunction({ matchedCount: 0 });
});

*MongoDB>= 3.6.0が必要です。* 因果整合性、再試行可能な書き込み、トランザクション などの利点のために、MongoDB セッション を開始します。

mongoose.startSession() を呼び出すことは、mongoose.connection.startSession() を呼び出すことと同等です。セッションはコネクションのスコープであるため、mongoose.startSession() を呼び出すと、デフォルトの mongoose コネクション でセッションが開始されます。

このコネクションに登録されているモデルのすべてのインデックスを同期します。

潜在的な クエリセレクターインジェクション攻撃 をフィルタリングするときに、指定されたオブジェクトをスキップするように sanitizeFilter() に指示します。 使用する既知のクエリセレクターがある場合は、このメソッドを使用します。

const obj = { username: 'val', pwd: trusted({ $type: 'string', $eq: 'my secret' }) };
sanitizeFilter(obj);

// Note that `sanitizeFilter()` did not add `$eq` around `$type`.
obj; // { username: 'val', pwd: { $type: 'string', $eq: 'my secret' } });

Mongoose のバージョン

例

console.log(mongoose.version); // '5.x.x'