Подключение

Конструктор подключения

По практическим соображениям, подключение равно Db.

Возвращает промис, который выполняется успешно, когда это подключение успешно подключается к MongoDB, или отклоняется, если это подключение не удалось подключиться.

Пример:

const conn = await mongoose.createConnection('mongodb://127.0.0.1:27017/test').
  asPromise();
conn.readyState; // 1, means Mongoose is connected

Экземпляр MongoClient, используемый этим подключением для связи с MongoDB. Mongoose автоматически устанавливает это свойство при открытии подключения.

Закрывает подключение

Возвращает экземпляр коллекции, создавая её, если она не кэширована. Этот метод возвращает тонкий обёртку над [коллекцией драйвера MongoDB Node.js](коллекцией драйвера MongoDB Node.js). Использование коллекции обходит 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 MongoClient, используемый этим подключением для связи с MongoDB.

Пример:

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

Определяет или извлекает модель.

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. Этот метод склоняет имя к множественному числу. Если вам это не нравится, либо передайте имя коллекции, либо установите параметр схемы collection name.

Пример:

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"

Открывает подключение по URI с использованием MongoClient.connect().

Пароль, указанный в 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 MongoClient, используемый для взаимодействия с MongoDB. Это полезно, если у вас уже есть экземпляр 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().

Этот метод не запускает никакие middleware. В частности, он не запускает агрегатные middleware.

Объект 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' });