Модель

Модель()

Параметры:

• doc «Объект» значения для начального набора
• [fields] «Объект» необязательный объект, содержащий поля, которые были выбраны в запросе, вернувшем этот документ. Вам не нужно устанавливать этот параметр, чтобы Mongoose обрабатывал вашу проекцию запроса.
• [skipId=false] «Булево» необязательный булевый параметр. Если true, Mongoose не добавляет поле _id в документ.

Наследуется от:

• «Документ»

// `UserModel` is a "Model", a subclass of `mongoose.Model`.
const UserModel = mongoose.model('User', new Schema({ name: String }));

// You can use a Model to create new documents using `new`:
const userDoc = new UserModel({ name: 'Foo' });
await userDoc.save();

// You also use a model to create queries:
const userFromDb = await UserModel.findOne({ name: 'Foo' });

Модель.$where()

Параметры:

• argument «Строка|Функция» — это строка JavaScript или анонимная функция

Возвращает:

• «Запрос»

См.:

• Запрос.$where

Blog.$where('this.username.indexOf("val") !== -1').exec(function (err, docs) {});

Модель.aggregate()

Параметры:

• [pipeline] «Массив» конвейер агрегации в виде массива объектов
• [options] «Объект» параметры агрегации

Возвращает:

• «Агрегация»

См.:

• Агрегация
• MongoDB

// Find the max balance of all accounts
const res = await Users.aggregate([
  { $group: { _id: null, maxBalance: { $max: '$balance' }}},
  { $project: { _id: 0, maxBalance: 1 }}
]);

console.log(res); // [ { maxBalance: 98000 } ]

// Or use the aggregation pipeline builder.
const res = await Users.aggregate().
  group({ _id: null, maxBalance: { $max: '$balance' } }).
  project('-id maxBalance').
  exec();
console.log(res); // [ { maxBalance: 98 } ]

Модель.applyDefaults()

Параметры:

• obj «Объект|Документ» объект или документ, на котором нужно применить значения по умолчанию

Модель.bulkSave()

Параметры:

• documents «Массив<Документ>»
• [options] «Объект» параметры, передаваемые в базовую bulkWrite()
• [options.timestamps] «Булево» по умолчанию null, при установке в false Mongoose не будет добавлять/обновлять временные метки в документы.
• [options.session=null] «Сессия клиента» сессия, связанная с этим массовым записью. См. документацию по транзакциям.
• [options.w=1] «Строка|число» уровень гарантии записи. См. Query#w() для получения дополнительной информации.
• [options.wtimeout=null] «число» таймаут уровня гарантии записи.
• [options.j=true] «Булево» Если false, отключение признания журнала

Модель.bulkWrite()

Параметры:

• ops «Массив»
• [ops.insertOne.document] «Объект» Вставляемый документ
• [ops.updateOne.filter] «Объект» Обновление первого документа, соответствующего этому фильтру
• [ops.updateOne.update] «Объект» Объект, содержащий операторы обновления
• [ops.updateOne.upsert=false] «Булево» Если true, вставить документ, если ни один не соответствует
• [ops.updateOne.timestamps=true] «Булево» Если false, не применять временные метки к операции
• [ops.updateOne.collation] «Объект» Сортировка MongoDB для использования
• [ops.updateOne.arrayFilters] «Массив» Фильтры массива, используемые в update
• [ops.updateMany.filter] «Объект» Обновить все документы, соответствующие этому фильтру
• [ops.updateMany.update] «Объект» Объект, содержащий операторы обновления
• [ops.updateMany.upsert=false] «Булево» Если true, вставить документ, если ни один документ не соответствует filter
• [ops.updateMany.timestamps=true] «Булево» Если false, не применять временные метки к операции
• [ops.updateMany.collation] «Объект» Сортировка MongoDB для использования
• [ops.updateMany.arrayFilters] «Массив» Фильтры массива, используемые в update
• [ops.deleteOne.filter] «Объект» Удалить первый документ, соответствующий этому фильтру
• [ops.deleteMany.filter] «Объект» Удалить все документы, соответствующие этому фильтру
• [ops.replaceOne.filter] «Объект» Заменить первый документ, соответствующий этому фильтру
• [ops.replaceOne.replacement] «Объект» Заменяющий документ
• [ops.replaceOne.upsert=false] «Булево» Если true, вставить документ, если ни один документ не соответствует filter
• [options] «Объект»
• [options.ordered=true] «Булево» Если true, выполнить записи в порядке и остановиться на первой ошибке. Если false, выполнить записи параллельно и продолжать до тех пор, пока все записи не будут выполнены успешно или с ошибкой.
• [options.session=null] «Сеанс клиента» Сеанс, связанный с этим массовым записыванием. См. документацию по транзакциям.
• [options.w=1] «Строка|число» Обеспечение записи. См. Query#w() для получения дополнительной информации.
• [options.wtimeout=null] «Число» Тайм-аут обеспечения записи.
• [options.j=true] «Булево» Если false, отключить подтверждение журнала
• [options.skipValidation=false] «Булево» Установите в значение true, чтобы пропустить проверку схемы Mongoose при массовом записи. В настоящее время Mongoose выполняет проверку по умолчанию для операций insertOne и replaceOne.
• [options.bypassDocumentValidation=false] «Булево» Если true, отключить проверку схемы MongoDB на стороне сервера для всех записей в этом наборе.
• [options.throwOnValidationError=false] «Булево» Если true и ordered: false, вызывать ошибку, если одна из операций не прошла проверку, но все допустимые операции были выполнены успешно.
• [options.strict=null] «Булево» Перезаписывает strict параметр в схеме. Если false, позволяет фильтровать и записывать поля, не определенные в схеме, для всех записей в этом наборе.

Возвращает:

• «Обещание» возвращает BulkWriteOpResult, если операция выполняется успешно

Character.bulkWrite([
  {
    insertOne: {
      document: {
        name: 'Eddard Stark',
        title: 'Warden of the North'
      }
    }
  },
  {
    updateOne: {
      filter: { name: 'Eddard Stark' },
      // If you were using the MongoDB driver directly, you'd need to do
      // `update: { $set: { title: ... } }` but mongoose adds $set for
      // you.
      update: { title: 'Hand of the King' }
    }
  },
  {
    deleteOne: {
      filter: { name: 'Eddard Stark' }
    }
  }
]).then(res => {
 // Prints "1 1 1"
 console.log(res.insertedCount, res.modifiedCount, res.deletedCount);
});

Model.castObject()

Параметры:

• obj «Объект» объект или документ для приведения типов
• options «Объект» параметры, передаваемые в castObject
• options.ignoreCastErrors «Булево» Если установлено в true, не будет вызывать ValidationError и вернуть только значения, которые были успешно приведены к типу.

const Test = mongoose.model('Test', Schema({ num: Number }));

const obj = Test.castObject({ num: '42' });
obj.num; // 42 as a number

Test.castObject({ num: 'not a number' }); // Throws a ValidationError

Model.cleanIndexes()

Параметры:

• [callback] «Функция» необязательный обратный вызов

Возвращает:

• «Обещание,undefined,void» Возвращает undefined если указан обратный вызов, возвращает обещание, если обратного вызова нет.

Model.count()

Параметры:

• [filter] «Объект»

Возвращает:

• «Запрос»

const count = await Adventure.count({ type: 'jungle' });
console.log('there are %d jungle adventures', count);

Model.countDocuments()

Параметры:

• filter «Объект»

Возвращает:

• «Запрос»

Adventure.countDocuments({ type: 'jungle' }, function (err, count) {
  console.log('there are %d jungle adventures', count);
});

Model.create()

Параметры:

• docs «Array|Object» Документы для вставки, в виде разбросанных значений или массива
• [options] «Object» Параметры, передаваемые в save(). Для указания options, docs обязательно должен быть массивом, а не разбросанными значениями. Смотрите Model.save для доступных параметров.
• [options.ordered] «Boolean» сохраняет документы последовательно, а не параллельно.
• [options.aggregateErrors] «Boolean» Агрегировать ошибки вместо выброса первой возникшей. По умолчанию: false

Возвращает:

• «Promise»

// Insert one new `Character` document
await Character.create({ name: 'Jean-Luc Picard' });

// Insert multiple new `Character` documents
await Character.create([{ name: 'Will Riker' }, { name: 'Geordi LaForge' }]);

// Create a new character within a transaction. Note that you **must**
// pass an array as the first parameter to `create()` if you want to
// specify options.
await Character.create([{ name: 'Jean-Luc Picard' }], { session });

Model.createCollection()

Параметры:

• [options] «Object» см. документацию драйвера MongoDB

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

User.createCollection().then(function(collection) {
  console.log('Collection is created!');
});

Model.createIndexes()

Параметры:

• [options] «Object» внутренние параметры

Возвращает:

• «Promise»

Model.db

Тип:

• «свойство»

Model.deleteMany()

Параметры:

• conditions «Object»
• [options] «Object» необязательно, см. Query.prototype.setOptions()
• [options.translateAliases=null] «Boolean» Если установлено в true, преобразует любые определённые в схеме псевдонимы в filter, projection, update, и distinct. Выбрасывает ошибку, если есть конфликты, где и псевдоним, и исходное свойство определены в одном объекте.

Возвращает:

• «Query»

await Character.deleteMany({ name: /Stark/, age: { $gte: 18 } }); // returns {deletedCount: x} where x is the number of documents deleted.

Model.deleteOne()

Параметры:

• conditions «Object»
• [options] «Object» необязательно, см. Query.prototype.setOptions()
• [options.translateAliases=null] «Boolean» Если установлено в true, преобразует любые определённые в схеме псевдонимы в filter, projection, update, и distinct. Выбрасывает ошибку, если есть конфликты, где и псевдоним, и исходное свойство определены в одном объекте.

Возвращает:

• «Query»

await Character.deleteOne({ name: 'Eddard Stark' }); // returns {deletedCount: 1}

Model.diffIndexes()

Параметры:

• [options] «Object»

Model.discriminator()

Параметры:

• name «String» имя модели-дискриминатора
• schema «Schema» схема модели-дискриминатора
• [options] «Object|String» Если строка, то то же, что и options.value.
• [options.value] «String» строка, хранящаяся в свойстве discriminatorKey. Если не указано, Mongoose использует параметр name.
• [options.clone=true] «Boolean» По умолчанию, discriminator() клонирует заданную schema. Установите в false чтобы пропустить клонирование.
• [options.overwriteModels=false] «Boolean» По умолчанию, Mongoose не позволяет определять дискриминатор с тем же именем, что и другой дискриминатор. Установите это значение, чтобы разрешить перезапись дискриминаторов с одинаковым именем.
• [options.mergeHooks=true] «Boolean» По умолчанию, Mongoose объединяет хуки базовой схемы с хуками схемы дискриминатора. Установите этот параметр в false чтобы Mongoose использовал хуки схемы дискриминатора вместо этого.
• [options.mergePlugins=true] «Boolean» По умолчанию, Mongoose объединяет плагины базовой схемы с плагинами схемы дискриминатора. Установите этот параметр в false чтобы Mongoose использовал плагины схемы дискриминатора вместо этого.

Возвращает:

• «Model» Новая созданная модель-дискриминатор

function BaseSchema() {
  Schema.apply(this, arguments);

  this.add({
    name: String,
    createdAt: Date
  });
}
util.inherits(BaseSchema, Schema);

const PersonSchema = new BaseSchema();
const BossSchema = new BaseSchema({ department: String });

const Person = mongoose.model('Person', PersonSchema);
const Boss = Person.discriminator('Boss', BossSchema);
new Boss().__t; // "Boss". `__t` is the default `discriminatorKey`

const employeeSchema = new Schema({ boss: ObjectId });
const Employee = Person.discriminator('Employee', employeeSchema, 'staff');
new Employee().__t; // "staff" because of 3rd argument above

Model.distinct()

Параметры:

• field «String»
• [conditions] «Object» необязательно

Возвращает:

• «Query»

const query = Link.distinct('url');
query.exec();

Model.ensureIndexes()

Параметры:

• [options] «Object» внутренние параметры

Возвращает:

• «Promise»

Event.ensureIndexes(function (err) {
  if (err) return handleError(err);
});

const eventSchema = new Schema({ thing: { type: 'string', unique: true } })
const Event = mongoose.model('Event', eventSchema);

Event.on('index', function (err) {
  if (err) console.error(err); // error occurred during index creation
})

Model.estimatedDocumentCount()

Параметры:

• [options] «Object»

Возвращает:

• «Query»

const numAdventures = await Adventure.estimatedDocumentCount();

Model.events

Тип:

• «свойство»

MyModel.events.on('error', err => console.log(err.message));

// Prints a 'CastError' because of the above handler
await MyModel.findOne({ _id: 'Not a valid ObjectId' }).catch(noop);

Model.exists()

Параметры:

• filter «Object»
• [options] «Object» необязательно, см. Query.prototype.setOptions()

Возвращает:

• «Query»

await Character.deleteMany({});
await Character.create({ name: 'Jean-Luc Picard' });

await Character.exists({ name: /picard/i }); // { _id: ... }
await Character.exists({ name: /riker/i }); // null

Model.find()

Параметры:

• filter «Объект|ObjectId»
• [projection] «Объект|Строка|Массив[Строка]» необязательные поля для возврата, см. Query.prototype.select()
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.translateAliases=null] «Булево» Если установлено в true, переводит любые псевдонимы, определённые схемой, в filter, projection, update, и distinct. Выбрасывает ошибку, если есть конфликты, где и псевдоним, и исходное свойство определены в одном и том же объекте.

Возвращает:

• «Запрос»

См.:

• выбор полей
• преобразование запросов

// find all documents
await MyModel.find({});

// find all documents named john and at least 18
await MyModel.find({ name: 'john', age: { $gte: 18 } }).exec();

// executes, name LIKE john and only selecting the "name" and "friends" fields
await MyModel.find({ name: /john/i }, 'name friends').exec();

// passing options
await MyModel.find({ name: /john/i }, null, { skip: 10 }).exec();

Model.findById()

Параметры:

• id «Любой» значение _id для поиска
• [projection] «Объект|Строка|Массив[Строка]» необязательные поля для возврата, см. Query.prototype.select()
• [options] «Объект» необязательно, см. Query.prototype.setOptions()

Возвращает:

• «Запрос»

См.:

• выбор полей
• запросы lean
• findById в Mongoose

// Find the adventure with the given `id`, or `null` if not found
await Adventure.findById(id).exec();

// select only the adventures name and length
await Adventure.findById(id, 'name length').exec();

Model.findByIdAndDelete()

Параметры:

• id «Объект|Число|Строка» значение _id для поиска
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.strict] «Булево|Строка» перезаписывает опцию строгого режима схемы строгого режима
• [options.translateAliases=null] «Булево» Если установлено в true, переводит любые псевдонимы, определённые схемой, в filter, projection, update, и distinct. Выбрасывает ошибку, если есть конфликты, где и псевдоним, и исходное свойство определены в одном и том же объекте.

Возвращает:

• «Запрос»

См.:

• Model.findOneAndRemove
• mongodb

Model.findByIdAndRemove()

Параметры:

• id «Объект|Число|Строка» значение _id для поиска
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.strict] «Булево|Строка» перезаписывает опцию строгого режима схемы строгого режима
• [options.session=null] «Сессия клиента» Сессия, связанная с этим запросом. См. документацию по транзакциям.
• [options.projection=null] «Объект|Строка|Массив[Строка]» необязательные поля для возврата, см. Query.prototype.select()
• [options.sort] «Объект|Строка» если найдено несколько документов, устанавливает порядок сортировки для выбора документа для обновления.
• [options.rawResult] «Булево» если true, возвращает сырой результат из драйвера MongoDB
• [options.select] «Объект|Строка» устанавливает поля документа, которые нужно вернуть.
• [options.translateAliases=null] «Булево» Если установлено в true, переводит любые псевдонимы, определённые схемой, в filter, projection, update, и distinct. Выбрасывает ошибку, если есть конфликты, где и псевдоним, и исходное свойство определены в одном и том же объекте.

Возвращает:

• «Запрос»

См.:

• Model.findOneAndRemove
• mongodb

A.findByIdAndRemove(id, options)  // return Query
A.findByIdAndRemove(id) // returns Query
A.findByIdAndRemove()           // returns Query

Model.findByIdAndUpdate()

Параметры:

• id «Объект|Число|Строка» значение _id для запроса
• [update] «Объект»
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.returnDocument='before'] «Строка» Имеет два возможных значения, 'before' и 'after'. По умолчанию возвращает документ до применения обновления.
• [options.lean] «Объект» если истинно, mongoose вернёт документ как обычный JavaScript-объект, а не документ mongoose. См. Query.lean() и учебник Mongoose по lean.
• [options.session=null] «ClientSession» Сессия, связанная с этим запросом. См. документацию по транзакциям.
• [options.strict] «Булево|Строка» перезаписывает опцию строгого режима схемы
• [options.timestamps=null] «Булево» Если установлено false, и включены временные метки на уровне схемы, пропустить временные метки для этого обновления. Обратите внимание, что это позволяет перезаписать временные метки. Не делает ничего, если временные метки на уровне схемы не заданы.
• [options.overwrite=false] «Булево» По умолчанию, если вы не включаете операторы обновления в update, Mongoose обернёт update в $set за вас. Это предотвращает случайное перезаписывание документа. Эта опция говорит Mongoose пропустить добавление $set. Альтернативой этому является использование Model.findOneAndReplace({ _id: id }, update, options).
• [options.sort] «Объект|Строка» если по условиям найдено несколько документов, задаёт порядок сортировки, чтобы выбрать, какой документ обновить.
• [options.runValidators] «Булево» если true, выполняет валидаторы обновлений для этой команды. Валидаторы обновлений проверяют операцию обновления по схеме модели.
• [options.setDefaultsOnInsert=true] «Булево» Если setDefaultsOnInsert и upsert истинны, mongoose применит значения по умолчанию, указанные в схеме модели, если создаётся новый документ.
• [options.rawResult] «Булево» если true, возвращает сырой результат из драйвера MongoDB
• [options.upsert=false] «Булево» если true, и документы не найдены, вставить новый документ
• [options.new=false] «Булево» если true, вернуть изменённый документ, а не исходный
• [options.select] «Объект|Строка» устанавливает поля документа для возврата.
• [options.translateAliases=null] «Булево» Если установлено true, переводит любые псевдонимы, определённые в схеме, в filter, projection, update, и distinct. Выбрасывает ошибку, если есть конфликты, где псевдоним и исходное свойство определены в одном объекте.

Возвращает:

• «Запрос»

См.:

• Model.findOneAndUpdate
• mongodb

A.findByIdAndUpdate(id, update, options)  // returns Query
A.findByIdAndUpdate(id, update)           // returns Query
A.findByIdAndUpdate()                     // returns Query

Model.findByIdAndUpdate(id, { name: 'jason bourne' }, options)

// is sent as
Model.findByIdAndUpdate(id, { $set: { name: 'jason bourne' }}, options)

const doc = await Model.findById(id)
doc.name = 'jason bourne';
await doc.save();

Model.findOne()

Параметры:

• [conditions] «Объект»
• [projection] «Объект|Строка|Массив[Строка]» необязательные поля для возврата, см. Query.prototype.select()
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.translateAliases=null] «Булево» Если установлено true, переводит любые псевдонимы, определённые в схеме, в filter, projection, update, и distinct. Выбрасывает ошибку, если есть конфликты, где псевдоним и исходное свойство определены в одном объекте.

Возвращает:

• «Запрос»

См.:

• выбор полей
• lean-запросы

// Find one adventure whose `country` is 'Croatia', otherwise `null`
await Adventure.findOne({ country: 'Croatia' }).exec();

// Model.findOne() no longer accepts a callback

// Select only the adventures name and length
await Adventure.findOne({ country: 'Croatia' }, 'name length').exec();

Model.findOneAndDelete()

Параметры:

• conditions «Объект»
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.strict] «Булево|Строка» перезаписывает опцию строгого режима схемы
• [options.projection=null] «Объект|Строка|Массив[Строка]» необязательные поля для возврата, см. Query.prototype.select()
• [options.session=null] «ClientSession» Сессия, связанная с этим запросом. См. документацию по транзакциям.
• [options.rawResult] «Булево» если true, возвращает сырой результат из драйвера MongoDB
• [options.sort] «Объект|Строка» если по условиям найдено несколько документов, задаёт порядок сортировки, чтобы выбрать, какой документ обновить.
• [options.select] «Объект|Строка» устанавливает поля документа для возврата.
• [options.maxTimeMS] «Число» устанавливает временной лимит на запрос - требует mongodb >= 2.6.0
• [options.translateAliases=null] «Булево» Если установлено true, переводит любые псевдонимы, определённые в схеме, в filter, projection, update, и distinct. Выбрасывает ошибку, если есть конфликты, где псевдоним и исходное свойство определены в одном объекте.

Возвращает:

• «Запрос»

A.findOneAndDelete(conditions, options)  // return Query
A.findOneAndDelete(conditions) // returns Query
A.findOneAndDelete()           // returns Query

const doc = await Model.findById(id)
doc.name = 'jason bourne';
await doc.save();

Model.findOneAndRemove()

Параметры:

• conditions «Объект»
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.session=null] «ClientSession» Сессия, связанная с этим запросом. См. документацию по транзакциям.
• [options.strict] «Булево значение или строка» перезаписывает опцию строгого режима схемы опцию строгого режима
• [options.projection=null] «Объект, строка или массив строк» необязательные поля для возврата, см. Query.prototype.select()
• [options.sort] «Объект или строка» если по условиям найдено несколько документов, устанавливает порядок сортировки для выбора документа для обновления.
• [options.rawResult] «Булево значение» если true, возвращает исходный результат из драйвера MongoDB
• [options.select] «Объект или строка» задаёт поля документа для возврата.
• [options.maxTimeMS] «Число» устанавливает временной лимит на запрос — требует mongodb >= 2.6.0
• [options.translateAliases=null] «Булево значение» Если установлено true, переводит любые определённые схемой псевдонимы в filter, projection, update, и distinct. Выбрасывает ошибку, если существуют конфликты, где и псевдоним, и исходное свойство определены в одном объекте.

Возвращаемое значение:

• «Query»

См. также:

• mongodb

A.findOneAndRemove(conditions, options)  // return Query
A.findOneAndRemove(conditions) // returns Query
A.findOneAndRemove()           // returns Query

const doc = await Model.findById(id);
doc.name = 'jason bourne';
await doc.save();

Model.findOneAndReplace()

Параметры:

• filter «Объект» Заменяет первый документ, соответствующий этому фильтру
• [replacement] «Объект» Заменять этим документом
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.returnDocument='before'] «Строка» Имеет два возможных значения, 'before' и 'after'. По умолчанию возвращает документ до применения обновления.
• [options.lean] «Объект» если имеет истинное значение, mongoose вернёт документ как обычный JavaScript-объект, а не как документ mongoose. См. Query.lean() и учебник по Mongoose lean.
• [options.session=null] «ClientSession» Сессия, связанная с этим запросом. См. документацию по транзакциям.
• [options.strict] «Булево значение или строка» перезаписывает опцию строгого режима схемы опцию строгого режима
• [options.timestamps=null] «Булево значение» Если установлено false и включены временные метки на уровне схемы, пропустить временные метки для этого обновления. Обратите внимание, что это позволяет перезаписывать временные метки. Ничего не делает, если временные метки на уровне схемы не установлены.
• [options.projection=null] «Объект, строка или массив строк» необязательные поля для возврата, см. Query.prototype.select()
• [options.sort] «Объект или строка» если по условиям найдено несколько документов, устанавливает порядок сортировки для выбора документа для обновления.
• [options.rawResult] «Булево значение» если true, возвращает исходный результат из драйвера MongoDB
• [options.select] «Объект или строка» задаёт поля документа для возврата.
• [options.maxTimeMS] «Число» устанавливает временной лимит на запрос — требует mongodb >= 2.6.0
• [options.translateAliases=null] «Булево значение» Если установлено true, переводит любые определённые схемой псевдонимы в filter, projection, update, и distinct. Выбрасывает ошибку, если существуют конфликты, где и псевдоним, и исходное свойство определены в одном объекте.

Возвращаемое значение:

• «Query»

A.findOneAndReplace(filter, replacement, options)  // return Query
A.findOneAndReplace(filter, replacement) // returns Query
A.findOneAndReplace()                    // returns Query

Model.findOneAndUpdate()

Параметры:

• [conditions] «Объект»
• [update] «Объект»
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.returnDocument='before'] «Строка» Имеет два возможных значения, 'before' и 'after'. По умолчанию возвращает документ до применения обновления.
• [options.lean] «Объект» если имеет истинное значение, mongoose вернёт документ как обычный JavaScript-объект, а не как документ mongoose. См. Query.lean() и учебник по Mongoose lean.
• [options.session=null] «ClientSession» Сессия, связанная с этим запросом. См. документацию по транзакциям.
• [options.strict] «Булево значение или строка» перезаписывает опцию строгого режима схемы опцию строгого режима
• [options.timestamps=null] «Булево значение» Если установлено false и включены временные метки на уровне схемы, пропустить временные метки для этого обновления. Обратите внимание, что это позволяет перезаписывать временные метки. Ничего не делает, если временные метки на уровне схемы не установлены.
• [options.overwrite=false] «Булево значение» По умолчанию, если вы не включаете операторы обновления в update, Mongoose обернёт update в $set за вас. Это предотвращает случайное перезаписывание документа. Эта опция сообщает Mongoose пропустить добавление $set. Альтернативой этому было бы использование Model.findOneAndReplace(conditions, update, options, callback).
• [options.upsert=false] «Булево значение» если true, и документы не найдены, вставить новый документ
• [options.projection=null] «Объект, строка или массив строк» необязательные поля для возврата, см. Query.prototype.select()
• [options.new=false] «Булево значение» если true, вернуть изменённый документ вместо исходного
• [options.fields] «Объект или строка» Выбор полей. Эквивалентно .select(fields).findOneAndUpdate()
• [options.maxTimeMS] «Число» устанавливает временной лимит на запрос — требует mongodb >= 2.6.0
• [options.sort] «Объект или строка» если по условиям найдено несколько документов, устанавливает порядок сортировки для выбора документа для обновления.
• [options.runValidators] «Булево значение» если true, запускает валидаторы обновления для этой команды. Валидаторы обновления проверяют операцию обновления по схеме модели
• [options.setDefaultsOnInsert=true] «Булево значение» Если setDefaultsOnInsert и upsert true, mongoose применит значения по умолчанию, указанные в схеме модели, если создаётся новый документ
• [options.rawResult] «Булево значение» если true, возвращает исходный результат из драйвера MongoDB
• [options.translateAliases=null] «Булево значение» Если установлено true, переводит любые определённые схемой псевдонимы в filter, projection, update, и distinct. Выбрасывает ошибку, если существуют конфликты, где и псевдоним, и исходное свойство определены в одном объекте.

Возвращаемое значение:

• «Запрос»

См.:

• Учебник
• mongodb

A.findOneAndUpdate(conditions, update, options)  // returns Query
A.findOneAndUpdate(conditions, update)           // returns Query
A.findOneAndUpdate()                             // returns Query

const query = { name: 'borne' };
Model.findOneAndUpdate(query, { name: 'jason bourne' }, options)

// is sent as
Model.findOneAndUpdate(query, { $set: { name: 'jason bourne' }}, options)

const doc = await Model.findById(id);
doc.name = 'jason bourne';
await doc.save();

Model.hydrate()

Параметры:

• obj «Объект»
• [projection] «Объект|Строка|Массив[Строка]» необязательная проекция, содержащая поля, которые должны быть выбраны для этого документа
• [options] «Объект» необязательные параметры
• [options.setters=false] «Булево» если true, применять установщики схемы при гидратации

Возвращает:

• «Документ» экземпляр документа

// hydrate previous data into a Mongoose document
const mongooseCandy = Candy.hydrate({ _id: '54108337212ffb6d459f854c', type: 'jelly bean' });

Model.init()

const eventSchema = new Schema({ thing: { type: 'string', unique: true } })
// This calls `Event.init()` implicitly, so you don't need to call
// `Event.init()` on your own.
const Event = mongoose.model('Event', eventSchema);

await Event.init();
console.log('Indexes are done building!');

Model.insertMany()

Параметры:

• doc(s) «Массив|Объект|[объект Объект]»
• [options] «Объект» см. параметры драйвера mongodb
• [options.ordered=true] «Булево» если true, немедленно завершит выполнение при обнаружении первой ошибки. Если false, вставит все возможные документы и сообщит об ошибках позже. insertMany() с ordered = false называется "неупорядоченным" insertMany().
• [options.rawResult=false] «Булево» если false, возвращаемое обещание разрешается на документы, прошедшие валидацию mongoose. Если true, вернет исходный результат драйвера MongoDB с свойством mongoose, содержащим validationErrors и results , если это неупорядоченный insertMany.
• [options.lean=false] «Булево» если true, пропускает гидратацию и валидацию документов. Эта опция полезна для повышения производительности, но Mongoose не будет проверять документы перед вставкой.
• [options.limit=null] «Число» ограничивает количество обрабатываемых документов (валидация/преобразование) mongoose параллельно, это **НЕ** отправляет документы порциями в MongoDB. Используйте эту опцию, если вы обрабатываете большое количество документов и у вашего приложения заканчивается память.
• [options.populate=null] «Строка|Объект|Массив» заполняет результирующие документы. Эта опция является бесполезной, если rawResult установлено.
• [options.throwOnValidationError=false] «Булево» Если true и ordered: false, выбросить ошибку, если одна из операций не прошла валидацию, но все валидные операции завершились успешно.

Возвращает:

• «Обещание» разрешающее исходный результат драйвера MongoDB, если options.rawResult было true, или документы, прошедшие валидацию, в противном случае

await Movies.insertMany([
  { name: 'Star Wars' },
  { name: 'The Empire Strikes Back' }
]);

Model.inspect()

const MyModel = mongoose.model('Test', Schema({ name: String }));
MyModel.inspect(); // 'Model { Test }'
console.log(MyModel); // Prints 'Model { Test }'

Model.listIndexes()

Возвращает:

• «Обещание»

Model.populate()

Параметры:

• docs «Документ|Массив» Либо один документ, либо массив документов для заполнения.
• options «Объект|Строка» Либо пути для заполнения, либо объект, определяющий все параметры
• [options.path=null] «строка» Путь для заполнения.
• [options.populate=null] «строка|PopulateOptions» Рекурсивное заполнение путей в заполненных документах. См. документацию по глубокому заполнению.
• [options.retainNullValues=false] «логическое значение» По умолчанию Mongoose удаляет значения null и undefined из заполненных массивов. Используйте этот параметр, чтобы populate() сохранили null и undefined элементы массива.
• [options.getters=false] «логическое значение» Если true, Mongoose вызовет любые геттеры, определенные в localField. По умолчанию Mongoose получает исходное значение localField. Например, вам нужно будет установить этот параметр в true , если вы хотите добавить lowercase геттер к вашей localField.
• [options.clone=false] «логическое значение» Когда вы делаете BlogPost.find().populate('author'), статьи блога с одним автором будут использовать 1 копию author документа. Включите этот параметр, чтобы Mongoose клонировал заполненные документы перед их назначением.
• [options.match=null] «Объект|Функция» Добавляет дополнительный фильтр к запросу заполнения. Может быть объектом фильтра, содержащим синтаксис запросов MongoDB, или функцией, возвращающей объект фильтра.
• [options.skipInvalidIds=false] «логическое значение» По умолчанию Mongoose выбрасывает ошибку преобразования, если localField и foreignField схемы не совпадают. Если вы включите этот параметр, Mongoose вместо этого отфильтрует любые localField свойства, которые не могут быть преобразованы в тип схемы foreignField.
• [options.perDocumentLimit=null] «Число» По соображениям обратной совместимости, limit с populate() могут давать неверные результаты, поскольку он выполняет только один запрос для каждого заполняемого документа. Если вы установите perDocumentLimit, Mongoose гарантирует правильное limit на документ, выполняя отдельный запрос для каждого документа, чтобы populate(). Например, .find().populate({ path: 'test', perDocumentLimit: 2 }) выполнит 2 дополнительных запроса, если .find() вернет 2 документа.
• [options.strictPopulate=true] «логическое значение» Установите в false, чтобы разрешить заполнение путей, которые не определены в схеме данной модели.
• [options.options=null] «Объект» Дополнительные параметры, такие как limit и lean.
• [options.transform=null] «Функция» Функция, которую Mongoose будет вызывать для каждого заполненного документа, позволяющая преобразовать заполненный документ.
• [callback(err,doc)] «Функция» Необязательный обратный вызов, выполняемый по завершении. Принимает err и doc(s).

Возвращает:

• «Обещание»

const Dog = mongoose.model('Dog', new Schema({ name: String, breed: String }));
const Person = mongoose.model('Person', new Schema({
  name: String,
  pet: { type: mongoose.ObjectId, ref: 'Dog' }
}));

const pets = await Pet.create([
  { name: 'Daisy', breed: 'Beagle' },
  { name: 'Einstein', breed: 'Catalan Sheepdog' }
]);

// populate many plain objects
const users = [
  { name: 'John Wick', dog: pets[0]._id },
  { name: 'Doc Brown', dog: pets[1]._id }
];
await User.populate(users, { path: 'dog', select: 'name' });
users[0].dog.name; // 'Daisy'
users[0].dog.breed; // undefined because of `select`

Model.prototype.$model()

Параметры:

• name «Строка» имя модели

Возвращает:

• «Модель»

const doc = new Tank;
await doc.model('User').findById(id);

Model.prototype.$where

Тип:

• «свойство»

Model.prototype.base

Тип:

• «свойство»

Model.prototype.baseModelName

Тип:

• «свойство»

Model.prototype.collection

Тип:

• «свойство»

Model.prototype.collection

Тип:

• «свойство»

Model.prototype.db

Тип:

• «свойство»

Model.prototype.deleteOne()

Возвращает:

• «Promise» Promise

product = await product.deleteOne();
await Product.findById(product._id); // null

Model.prototype.discriminators

Тип:

• «свойство»

Model.prototype.increment()

См.:

• versionKeys

const doc = await Model.findById(id);
doc.increment();
await doc.save();

Model.prototype.model()

Параметры:

• name «Строка» имя модели

Возвращает:

• «Модель»

const doc = new Tank;
await doc.model('User').findById(id);

Model.prototype.modelName

Тип:

• «свойство»

Model.prototype.save()

Параметры:

• [options] «Объект» необязательные параметры
• [options.session=null] «Сессия» сессия, связанная с этой операцией сохранения. Если не указано, по умолчанию используется связанная с документом сессия.
• [options.safe] «Объект» (УСТЕРЕЖЕННО) переопределяет параметр безопасной схемы. Используйте параметр w вместо этого.
• [options.validateBeforeSave] «Булево» установите в false для сохранения без валидации.
• [options.validateModifiedOnly=false] «Булево» если true, Mongoose будет валидировать только измененные пути, а не измененные пути и required пути.
• [options.w] «Число/Строка» задайте уровень обеспечения записи. Переопределяет параметр writeConcern на уровне схемы
• [options.j] «Булево» установите в true, чтобы MongoDB ожидал, пока эта save() была записана в журнал перед разрешением возвращенного обещания. Переопределяет параметр writeConcern на уровне схемы
• [options.wtimeout] «Число» устанавливает таймаут для обеспечения записи. Переопределяет параметр writeConcern на уровне схемы.
• [options.checkKeys=true] «Булево» по умолчанию драйвер MongoDB предотвращает сохранение ключей, начинающихся с '$' или содержащих '.', Установите этот параметр в false , чтобы пропустить проверку. См. ограничения на имена полей
• [options.timestamps=true] «Булево» если false и временные метки включены, пропустите временные метки для этой save().

Возвращает:

• «Promise»

См.:

• middleware

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

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

Model.replaceOne()

Параметры:

• filter «Объект»
• doc «Объект»
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.strict] «Булево/Строка» переопределяет параметр strict mode схемы
• [options.upsert=false] «Булево» если true, и документы не найдены, вставьте новый документ
• [options.writeConcern=null] «Объект» задает уровень обеспечения записи для реплицированных наборов. Переопределяет уровень обеспечения записи схемы
• [options.timestamps=null] «Булево» Если установлено false и временные метки на уровне схемы включены, пропустите временные метки для этого обновления. Не делает ничего, если временные метки на уровне схемы не установлены.
• [options.translateAliases=null] «Булево» Если установлено true, преобразует любые определения псевдонимов схемы в filter, projection, update, и distinct. Выбрасывает ошибку, если есть конфликты, где псевдоним и исходное свойство определены в одном объекте.

Возвращает:

• «Запрос»

См.:

• Документы запроса
• UpdateResult

const res = await Person.replaceOne({ _id: 24601 }, { name: 'Jean Valjean' });
res.matchedCount; // Number of documents matched
res.modifiedCount; // Number of documents modified
res.acknowledged; // Boolean indicating everything went smoothly.
res.upsertedId; // null or an id containing a document that had to be upserted.
res.upsertedCount; // Number indicating how many documents had to be upserted. Will either be 0 or 1.

Model.schema

Тип:

• «свойство»

Model.startSession()

Параметры:

• [options] «Объект» см. параметры драйвера mongodb
• [options.causalConsistency=true] «Булево» установите в false, чтобы отключить согласованность событий

Возвращает:

• «Promise<ClientSession>» обещание, которое разрешается в драйвер MongoDB ClientSession

const session = await Person.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' });

Model.syncIndexes()

Параметры:

• [options] «Объект» параметры для передачи в ensureIndexes()
• [options.background=null] «Булево» если указано, переопределяет свойство background каждого индекса

Возвращает:

• «Обещание»

const schema = new Schema({ name: { type: String, unique: true } });
const Customer = mongoose.model('Customer', schema);
await Customer.collection.createIndex({ age: 1 }); // Index is not in schema
// Will drop the 'age' index and create an index on `name`
await Customer.syncIndexes();

Model.translateAliases()

Параметры:

• fields «Объект» поля/условия, которые могут содержать псевдонимы ключей
• [errorOnDuplicates] «Булево» если true, выбросить ошибку, если для ключа есть и ключ, и псевдоним в fields

Возвращает:

• «Объект» переведённые «чистые» поля/условия

await Character.find(Character.translateAliases({
   '名': 'Eddard Stark' // Alias for 'name'
});

Model.updateMany()

Параметры:

• filter «Объект»
• update «Объект или массив»
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.strict] «Булево или строка» переопределяет опцию режима строгости схемы строгий режим
• [options.upsert=false] «Булево» если true, и нет документов, вставить новый документ
• [options.writeConcern=null] «Объект» устанавливает уровень соблюдения для реплицируемых наборов. Переопределяет уровень соблюдения на уровне схемы
• [options.timestamps=null] «Булево» Если установлено значение false, и включены временные метки на уровне схемы, пропустить временные метки для этого обновления. Не делает ничего, если временные метки на уровне схемы не установлены.
• [options.translateAliases=null] «Булево» Если установлено значение true, переводит любые псевдонимы, определённые в схеме, в filter, projection, update, и distinct. Вызывает ошибку, если есть конфликты, где и алиас, и исходное свойство определены в одном объекте.

Возвращает:

• «Запрос»

См.:

• Документы запросов
• Документация MongoDB
• UpdateResult

const res = await Person.updateMany({ name: /Stark$/ }, { isDeleted: true });
res.matchedCount; // Number of documents matched
res.modifiedCount; // Number of documents modified
res.acknowledged; // Boolean indicating everything went smoothly.
res.upsertedId; // null or an id containing a document that had to be upserted.
res.upsertedCount; // Number indicating how many documents had to be upserted. Will either be 0 or 1.

Model.updateOne()

Параметры:

• filter «Объект»
• update «Объект или массив»
• [options] «Объект» необязательно, см. Query.prototype.setOptions()
• [options.strict] «Булево или строка» переопределяет опцию режима строгости схемы строгий режим
• [options.upsert=false] «Булево» если true, и нет документов, вставить новый документ
• [options.writeConcern=null] «Объект» устанавливает уровень соблюдения для реплицируемых наборов. Переопределяет уровень соблюдения на уровне схемы
• [options.timestamps=null] «Булево» Если установлено значение false, и включены временные метки на уровне схемы, пропустить временные метки для этого обновления. Примечание: это позволяет перезаписать временные метки. Не делает ничего, если временные метки на уровне схемы не установлены.
• [options.translateAliases=null] «Булево» Если установлено значение true, переводит любые псевдонимы, определённые в схеме, в filter, projection, update, и distinct. Вызывает ошибку, если есть конфликты, где и алиас, и исходное свойство определены в одном объекте.

Возвращает:

• «Запрос»

См.:

• Документы запросов
• Документация MongoDB
• UpdateResult

const res = await Person.updateOne({ name: 'Jean-Luc Picard' }, { ship: 'USS Enterprise' });
res.matchedCount; // Number of documents matched
res.modifiedCount; // Number of documents modified
res.acknowledged; // Boolean indicating everything went smoothly.
res.upsertedId; // null or an id containing a document that had to be upserted.
res.upsertedCount; // Number indicating how many documents had to be upserted. Will either be 0 or 1.

Model.validate()

Параметры:

• obj «Объект»
• pathsToValidate «Массив или строка»
• [context] «Объект»

Возвращает:

• «Обещание, неопределено, пусто»

const Model = mongoose.model('Test', Schema({
  name: { type: String, required: true },
  age: { type: Number, required: true }
});

try {
  await Model.validate({ name: null }, ['name'])
} catch (err) {
  err instanceof mongoose.Error.ValidationError; // true
  Object.keys(err.errors); // ['name']
}

Model.watch()

Параметры:

• [pipeline] «Массив»
• [options] «Объект» см. опции драйвера MongoDB
• [options.hydrate=false] «Булево» если true и fullDocument: 'updateLookup' установлено, Mongoose автоматически закрепит fullDocument в полноценный документ Mongoose

Возвращает:

• «Поток изменений» оболочка потока изменений, специфичная для Mongoose, наследуется от EventEmitter

const doc = await Person.create({ name: 'Ned Stark' });
const changeStream = Person.watch().on('change', change => console.log(change));
// Will print from the above `console.log()`:
// { _id: { _data: ... },
//   operationType: 'delete',
//   ns: { db: 'mydb', coll: 'Person' },
//   documentKey: { _id: 5a51b125c5500f5aa094c7bd } }
await doc.remove();

Model.where()

Параметры:

• path «Строка»
• [val] «Объект» необязательное значение

Возвращает:

• «Запрос»