ドキュメント

指定されたパスがポピュレートされていない場合はエラーをスローします

例

const doc = await Model.findOne().populate('author');

doc.$assertPopulated('author'); // does not throw
doc.$assertPopulated('other path'); // throws an error

// Manually populate and assert in one call. The following does
// `doc.$set({ likes })` before asserting.
doc.$assertPopulated('likes', { likes });

ドキュメントの変更されたパスをクリアします。

例

const doc = await TestModel.findOne();

doc.name = 'test';
doc.$isModified('name'); // true

doc.$clearModifiedPaths();
doc.name; // 'test', `$clearModifiedPaths()` does **not** modify the document's data, only change tracking

_doc と $__ のディープクローンを持つこのドキュメントのコピーを返します。

このドキュメントの内部変更追跡状態のスナップショットを作成します。後で、$restoreModifiedPathsSnapshot() を使用して、このドキュメントの変更追跡状態をリセットできます。

例

const doc = await TestModel.findOne();
const snapshot = doc.$createModifiedPathsSnapshot();

現在のバリデーションの $errors を含むハッシュ。

すべてのサブドキュメントを取得（bfsによる）

このドキュメントに関連付けられたすべてのポピュレートされたドキュメントを取得します。

このパスでバリデーションを実行したり、このパスへの変更を永続化したりしないでください。

例

doc.foo = null;
doc.$ignore('foo');
doc.save(); // changes to foo will not be persisted and validators won't be run

path の数値値を指定された val で増分します。このドキュメントで save() を呼び出すと、Mongoose は $set ではなく $inc を送信します。

例

const schema = new Schema({ counter: Number });
const Test = db.model('Test', schema);

const doc = await Test.create({ counter: 0 });
doc.$inc('counter', 2);
await doc.save(); // Sends a `{ $inc: { counter: 2 } }` to MongoDB
doc.counter; // 2

doc.counter += 2;
await doc.save(); // Sends a `{ $set: { counter: 2 } }` to MongoDB

.init のエイリアス

パスがデフォルトに設定されているかどうかをチェックします。

例

MyModel = mongoose.model('test', { name: { type: String, default: 'Val '} });
const m = new MyModel();
m.$isDefault('name'); // true

ゲッター/セッター。ドキュメントが削除されたかどうかを判断します。

例

const product = await product.remove();
product.$isDeleted(); // true
product.remove(); // no-op, doesn't send anything to the db

product.$isDeleted(false);
product.$isDeleted(); // false
product.remove(); // will execute a remove against the db

指定されたパスが nullish であるか、空のオブジェクトのみを含んでいる場合は true を返します。このサブドキュメントが minimize オプション によって削除されるかどうかを判断するのに役立ちます。

例

const schema = new Schema({ nested: { foo: String } });
const Model = mongoose.model('Test', schema);
const doc = new Model({});
doc.$isEmpty('nested'); // true
doc.nested.$isEmpty(); // true

doc.nested.foo = 'bar';
doc.$isEmpty('nested'); // false
doc.nested.$isEmpty(); // false

.isModified のエイリアス

ドキュメントが新しいかどうかを指定するブール値フラグ。new を使用してドキュメントを作成した場合、このドキュメントは「新しい」と見なされます。$isNew は、Mongoose が save() が insertOne() を使用して新しいドキュメントを作成するか、updateOne() を使用して既存のドキュメントを更新するかを判断する方法です。

例

const user = new User({ name: 'John Smith' });
user.$isNew; // true

await user.save(); // Sends an `insertOne` to MongoDB

一方、findOne() または別の クエリ操作 を使用してデータベースから既存のドキュメントをロードした場合、$isNew は false になります。

例

const user = await User.findOne({ name: 'John Smith' });
user.$isNew; // false

Mongoose は、save() が成功するとすぐに $isNew を false に設定します。つまり、Mongoose は post('save') フックが実行される 前 に $isNew を false に設定します。post('save') フックでは、save() が成功した場合、$isNew は false になります。

例

userSchema.post('save', function() {
  this.$isNew; // false
});
await User.create({ name: 'John Smith' });

サブドキュメントの場合、$isNew は、親に $isNew が設定されているか、新しいサブドキュメントを作成した場合に true になります。

例

// Assume `Group` has a document array `users`
const group = await Group.findOne();
group.users[0].$isNew; // false

group.users.push({ name: 'John Smith' });
group.users[1].$isNew; // true

ドキュメントにプロパティを格納するために使用できる空のオブジェクト。これは、Mongoose の内部処理と競合することなく、ミドルウェアにデータを渡すのに便利です。

例

schema.pre('save', function() {
  // Mongoose will set `isNew` to `false` if `save()` succeeds
  this.$locals.wasNew = this.isNew;
});

schema.post('save', function() {
  // Prints true if `isNew` was set before `save()`
  console.log(this.$locals.wasNew);
});

パスを有効としてマークし、既存のバリデーションエラーを削除します。

Mongoose がこのドキュメントで実行している現在の操作を含む文字列。null、'save'、'validate'、または 'remove' の場合があります。

例

const doc = new Model({ name: 'test' });
doc.$op; // null

const promise = doc.save();
doc.$op; // 'save'

await promise;
doc.$op; // null

parent() のエイリアス。このドキュメントがサブドキュメントまたはポピュレートされたドキュメントである場合は、ドキュメントの親を返します。それ以外の場合は undefined を返します。

.populated のエイリアス。

このドキュメントの変更追跡状態を指定されたスナップショットに復元します。$restoreModifiedPathsSnapshot() は、ドキュメントのプロパティを変更するのではなく、変更追跡状態をリセットするだけであることに注意してください。

このメソッドは、トランザクションを中止するときに変更追跡を復元する必要がある カスタムトランザクションラッパー を記述する場合に特に役立ちます。

例

const doc = await TestModel.findOne();
const snapshot = doc.$createModifiedPathsSnapshot();

doc.name = 'test';
doc.$restoreModifiedPathsSnapshot(snapshot);
doc.$isModified('name'); // false because `name` was not modified when snapshot was taken
doc.name; // 'test', `$restoreModifiedPathsSnapshot()` does **not** modify the document's data, only change tracking

このドキュメントに関連付けられたセッションの周りのゲッター/セッター。関連付けられたセッションを持つクエリから取得したドキュメントを save() する場合に、session を自動的に設定するために使用されます。

例

const session = MyModel.startSession();
const doc = await MyModel.findOne().session(session);
doc.$session() === session; // true
doc.$session(null);
doc.$session() === null; // true

これがトップレベルのドキュメントである場合、セッションを設定すると、すべての子ドキュメントに伝播されます。

競合を避けるために内部で使用される set() のエイリアス

save() および bulkSave() を使用するときに、このドキュメントがデフォルトでタイムスタンプを適用するかどうかに関するゲッター/セッター。

例

const TestModel = mongoose.model('Test', new Schema({ name: String }, { timestamps: true }));
const doc = new TestModel({ name: 'John Smith' });

doc.$timestamps(); // true

doc.$timestamps(false);
await doc.save(); // Does **not** apply timestamps

.validate のエイリアス

Mongoose がこのドキュメントを保存し、isNew が false の場合に、追加のクエリフィルターを追加するには、このプロパティを設定します。

例

// Make sure `save()` never updates a soft deleted document.
schema.pre('save', function() {
  this.$where = { isDeleted: false };
});

ポピュレートされたフィールドを取り、ポピュレートされていない状態に戻します。

例

Model.findOne().populate('author').exec(function (err, doc) {
  console.log(doc.author.name); // Dr.Seuss
  console.log(doc.depopulate('author'));
  console.log(doc.author); // '5144cf8050f071d979c118a7'
})

パスが指定されていない場合は、すべてのポピュレートされたフィールドがポピュレートされていない状態に戻ります。

直接変更されたパスのリストを返します。直接変更されたパスとは、doc.foo = 'bar'、Object.assign(doc, { foo: 'bar' })、または doc.set('foo', 'bar') を介して明示的に設定したパスです。

パス a は、modifiedPaths() に含まれているが、directModifiedPaths() に含まれていない可能性があります。これは、a の子が直接変更されたためです。

例

const schema = new Schema({ foo: String, nested: { bar: String } });
const Model = mongoose.model('Test', schema);
await Model.create({ foo: 'original', nested: { bar: 'original' } });

const doc = await Model.findOne();
doc.nested.bar = 'modified';
doc.directModifiedPaths(); // ['nested.bar']
doc.modifiedPaths(); // ['nested', 'nested.bar']

このドキュメントが別のドキュメントと等しい場合は true を返します。

ドキュメントは、一致する _id がある場合に等しいと見なされます。ただし、どちらのドキュメントにも _id がない場合は、この関数は deepEqual() を使用してフォールバックします。

現在のバリデーションエラーを含むハッシュ。

パスの値を返します。

例

// path
doc.get('age') // 47

// dynamic casting to a string
doc.get('age', String) // "47"

MongoDB に送信される形式で、ドキュメントに発生した変更を返します。

例

const userSchema = new Schema({
  name: String,
  age: Number,
  country: String
});
const User = mongoose.model('User', userSchema);
const user = await User.create({
  name: 'Hafez',
  age: 25,
  country: 'Egypt'
});

// returns an empty object, no changes happened yet
user.getChanges(); // { }

user.country = undefined;
user.age = 26;

user.getChanges(); // { $set: { age: 26 }, { $unset: { country: 1 } } }

await user.save();

user.getChanges(); // { }

getChanges() が返すオブジェクトを変更しても、ドキュメントの変更追跡状態には影響しません。delete user.getChanges().$set を実行した場合でも、Mongoose は $set をサーバーに送信します。

このドキュメントの _id の文字列バージョン。

注意

このゲッターは、デフォルトですべてのドキュメントに存在します。ゲッターは、構築時にSchemaのidオプションをfalseに設定することで無効にできます。

new Schema({ name: String }, { id: false });

セッターや変更のマークをせずにドキュメントを初期化します。

ドキュメントがmongodbから返された後、内部的に呼び出されます。通常、この関数を自分で呼び出す必要はありません。

この関数は、init ミドルウェアをトリガーします。initフックは同期であることに注意してください。

console.logのヘルパー

パスを無効としてマークし、検証を失敗させます。

errorMsg引数は、ValidationErrorのメッセージになります。

value引数（渡された場合）は、ValidationError.valueプロパティから利用可能になります。

doc.invalidate('size', 'must be less than 20', 14);

doc.validate(function (err) {
  console.log(err)
  // prints
  { message: 'Validation failed',
    name: 'ValidationError',
    errors:
     { size:
        { message: 'must be less than 20',
          name: 'ValidatorError',
          path: 'size',
          type: 'user defined',
          value: 14 } } }
})

pathが直接設定および変更された場合はtrue、それ以外の場合はfalseを返します。

例

doc.set('documents.0.title', 'changed');
doc.isDirectModified('documents.0.title') // true
doc.isDirectModified('documents') // false

pathが明示的に選択されたかどうかを確認します。射影がない場合は、常にtrueを返します。

例

Thing.findOne().select('nested.name').exec(function (err, doc) {
   doc.isDirectSelected('nested.name') // true
   doc.isDirectSelected('nested.otherName') // false
   doc.isDirectSelected('nested')  // false
})

pathがinit状態にあるかどうか、つまりDocument#init()によって設定され、それ以降変更されていないかどうかを確認します。

指定されたパスのいずれかが変更された場合はtrue、それ以外の場合はfalseを返します。引数がない場合は、このドキュメント内のいずれかのパスが変更された場合にtrueを返します。

pathが指定されている場合は、pathをパスチェーンの一部として含むパスまたは完全なパスが変更されているかどうかを確認します。

例

doc.set('documents.0.title', 'changed');
doc.isModified()                      // true
doc.isModified('documents')           // true
doc.isModified('documents.0.title')   // true
doc.isModified('documents otherProp') // true
doc.isDirectModified('documents')     // false

$isNewのレガシーエイリアス。

このドキュメントを初期化したソースクエリでpathが選択されたかどうかを確認します。

例

const doc = await Thing.findOne().select('name');
doc.isSelected('name') // true
doc.isSelected('age')  // false

パスを、dbに書き込む保留中の変更があるとしてマークします。

Mixed型を使用する場合に非常に役立ちます。

例

doc.mixed.type = 'changed';
doc.markModified('mixed.type');
doc.save() // changes to mixed.type are now persisted

変更されたパスのリストを返します。

不変のプロパティを除き、このドキュメントのすべての値をobjの値で上書きします。set()と同様に動作しますが、objにないすべてのプロパティを未設定にする点が異なります。

このドキュメントがサブドキュメントまたはポピュレートされたドキュメントの場合、ドキュメントの親を返します。親がない場合は、元のドキュメントを返します。

既存のドキュメントのパスをポピュレートします。

例

// Given a document, `populate()` lets you pull in referenced docs
await doc.populate([
  'stories',
  { path: 'fans', sort: { name: -1 } }
]);
doc.populated('stories'); // Array of ObjectIds
doc.stories[0].title; // 'Casino Royale'
doc.populated('fans'); // Array of ObjectIds

// If the referenced doc has been deleted, `populate()` will
// remove that entry from the array.
await Story.delete({ title: 'Casino Royale' });
await doc.populate('stories'); // Empty array

// You can also pass additional query options to `populate()`,
// like projections:
await doc.populate('fans', '-email');
doc.fans[0].email // undefined because of 2nd param `select`

指定されたpathのポピュレーション中に使用される_idを取得します。

例

const doc = await Model.findOne().populate('author');

console.log(doc.author.name); // Dr.Seuss
console.log(doc.populated('author')); // '5144cf8050f071d979c118a7'

パスがポピュレートされていない場合は、undefinedを返します。

このドキュメントの_idをクエリセレクターとして使用してreplaceOneコマンドを送信します。

有効なオプション

• Model.replaceOneと同じ

document.isNewがtrueの場合、データベースに新しいドキュメントを挿入してこのドキュメントを保存するか、updateOne操作を変更のみを使用してデータベースに送信します。後者の場合、ドキュメント全体を置き換えません。

例

product.sold = Date.now();
product = await product.save();

保存が成功した場合、返されたPromiseは保存されたドキュメントで解決されます。

例

const newProduct = await product.save();
newProduct === product; // true

ドキュメントのスキーマ。

パスまたは複数のパスの値を設定します。.$setのエイリアス。

例

// path, value
doc.set(path, value)

// object
doc.set({
    path  : value
  , path2 : {
       path  : value
    }
})

// on-the-fly cast to number
doc.set(path, value, Number)

// on-the-fly cast to string
doc.set(path, value, String)

// changing strict mode behavior
doc.set(path, value, { strict: false });

このメソッドの戻り値は、JSON.stringify(doc)の呼び出しで使用されます。

このメソッドは、Document#toObjectと同じオプションを受け入れます。スキーマのすべてのドキュメントにデフォルトでオプションを適用するには、スキーマのtoJSONオプションを同じ引数に設定します。

schema.set('toJSON', { virtuals: true });

toJSON()とtoObject()のオプションには1つの違いがあります。toJSON()を呼び出すと、flattenMapsオプションがデフォルトでtrueになります。これは、JSON.stringify()がデフォルトでMapをオブジェクトに変換しないためです。toObject()を呼び出すと、flattenMapsオプションはデフォルトでfalseになります。

toJSONオプションのデフォルト設定の詳細については、スキーマオプションを参照してください。

このドキュメントをプレーンな JavaScript オブジェクト（POJO）に変換します。

Buffer は、適切な保存のために mongodb.Binary のインスタンスに変換されます。

ゲッター/バーチャル

パスゲッターのみを適用する例

doc.toObject({ getters: true, virtuals: false })

バーチャルゲッターのみを適用する例

doc.toObject({ virtuals: true })

パスゲッターとバーチャルゲッターの両方を適用する例

doc.toObject({ getters: true })

これらのオプションをスキーマのすべてのドキュメントにデフォルトで適用するには、スキーマの toObject オプションに同じ引数を設定します。

schema.set('toObject', { virtuals: true })

変換

機密情報を削除したり、カスタムオブジェクトを返したりするなど、何らかの基準に基づいて結果のオブジェクトを変換する必要がある場合があります。この場合、オプションの transform 関数を設定します。

変換関数は 3 つの引数を受け取ります。

function (doc, ret, options) {}

• doc 変換される Mongoose ドキュメント
• ret 変換されたプレーンなオブジェクト表現
• options 使用中のオプション（スキーマオプションまたはインラインで渡されたオプション）

例

// specify the transform schema option
if (!schema.options.toObject) schema.options.toObject = {};
schema.options.toObject.transform = function (doc, ret, options) {
  // remove the _id of every document before returning the result
  delete ret._id;
  return ret;
}

// without the transformation in the schema
doc.toObject(); // { _id: 'anId', name: 'Wreck-it Ralph' }

// with the transformation
doc.toObject(); // { name: 'Wreck-it Ralph' }

変換を使用すると、プロパティの削除だけでなく、完全に新しいカスタマイズされたオブジェクトを返すこともできます。

if (!schema.options.toObject) schema.options.toObject = {};
schema.options.toObject.transform = function (doc, ret, options) {
  return { movie: ret.name }
}

// without the transformation in the schema
doc.toObject(); // { _id: 'anId', name: 'Wreck-it Ralph' }

// with the transformation
doc.toObject(); // { movie: 'Wreck-it Ralph' }

注：変換関数が undefined を返した場合、戻り値は無視されます。

変換はインラインで適用することもでき、スキーマオプションで設定された変換をオーバーライドします。toObject オプションで指定された変換関数は、サブドキュメントにも伝播します。

function deleteId(doc, ret, options) {
  delete ret._id;
  return ret;
}

const schema = mongoose.Schema({ name: String, docArr: [{ name: String }] });
const TestModel = mongoose.model('Test', schema);

const doc = new TestModel({ name: 'test', docArr: [{ name: 'test' }] });

// pass the transform as an inline option. Deletes `_id` property
// from both the top-level document and the subdocument.
const obj = doc.toObject({ transform: deleteId });
obj._id; // undefined
obj.docArr[0]._id; // undefined

変換をスキップする場合は、transform: false を使用します。

schema.options.toObject.hide = '_id';
schema.options.toObject.transform = function (doc, ret, options) {
  if (options.hide) {
    options.hide.split(' ').forEach(function (prop) {
      delete ret[prop];
    });
  }
  return ret;
}

const doc = new Doc({ _id: 'anId', secret: 47, name: 'Wreck-it Ralph' });
doc.toObject();                                        // { secret: 47, name: 'Wreck-it Ralph' }
doc.toObject({ hide: 'secret _id', transform: false });// { _id: 'anId', secret: 47, name: 'Wreck-it Ralph' }
doc.toObject({ hide: 'secret _id', transform: true }); // { name: 'Wreck-it Ralph' }

toObject() オプションで変換を渡すと、Mongoose はトップレベルのドキュメントに加えて、サブドキュメントにも変換を適用します。同様に、transform: false はすべてのサブドキュメントの変換をスキップします。この動作は、スキーマで定義された変換とは異なります。schema.options.toObject.transform で変換を定義した場合、その変換はサブドキュメントには適用されません。

const memberSchema = new Schema({ name: String, email: String });
const groupSchema = new Schema({ members: [memberSchema], name: String, email });
const Group = mongoose.model('Group', groupSchema);

const doc = new Group({
  name: 'Engineering',
  email: 'dev@mongoosejs.io',
  members: [{ name: 'Val', email: 'val@mongoosejs.io' }]
});

// Removes `email` from both top-level document **and** array elements
// { name: 'Engineering', members: [{ name: 'Val' }] }
doc.toObject({ transform: (doc, ret) => { delete ret.email; return ret; } });

変換は、これらのオプションと同様に、toJSON でも利用できます。toJSON() と toObject() が別々の関数である理由については、この JSON.stringify() ガイドを参照してください。

詳細については、スキーマオプションを参照してください。

保存中、カスタムオプションはデータベースに送信される前のドキュメントには適用されません。

console.logのヘルパー

指定されたパスの変更済み状態をクリアします。

例

doc.foo = 'bar';
doc.unmarkModified('foo');
doc.save(); // changes to foo will not be persisted

このドキュメントの _id をクエリセレクターとして使用して、updateOne コマンドを送信します。

例

weirdCar.updateOne({$inc: {wheels:1}}, { w: 1 }, callback);

有効なオプション

• Model.updateOne と同じです

このドキュメントに登録された検証ルールを実行します。

注意

このメソッドは、保存の前に pre で呼び出され、検証ルールに違反した場合、save が中止され、エラーがスローされます。

例

await doc.validate({ validateModifiedOnly: false, pathsToSkip: ['name', 'email']});

このドキュメントに登録された検証ルール（非同期バリデーターをスキップ）を実行します。

注意

このメソッドは、同期検証が必要な場合に便利です。

例

const err = doc.validateSync();
if (err) {
  handleError(err);
} else {
  // validation passed
}