MongoDB\Driver\Manager::startSession

    (mongodb >=1.4.0)

    MongoDB\Driver\Manager::startSession — Запускает новый клиентский сеанс для использования с этим клиентом

    Описание

    final public MongoDB\Driver\Manager::startSession(?array $options = null): MongoDB\Driver\Session

    Создаёт MongoDB\Driver\Session для указанных параметров. Сеанс затем может быть указан при выполнении команд, запросов и операций записи.

    Замечание: MongoDB\Driver\Session может использоваться только с MongoDB\Driver\Manager, из которого он был создан.

    Список параметров

    options

    options
    Опция Тип Описание По умолчанию
    causalConsistency bool

    Настраивает причинную согласованность в сеансе. Если true, каждая операция в сеансе будет причинно упорядочена после предыдущей операции чтения или записи. Установите на false, чтобы отключить причинную согласованность.

    Смотрите » Причинную согласованность в руководстве MongoDB для получения дополнительной информации.

    		true
    defaultTransactionOptions array

    Параметры по умолчанию для применения к вновь создаваемым транзакциям. Эти параметры используются, если они не переопределяются, когда транзакция запускается с различным значением для каждого параметра.

    options
    Опция Тип Описание
    maxCommitTimeMS integer

    Максимальный период времени в миллисекундах, в течение которого выполняется одна команда commitTransaction.

    Опция принимает maxCommitTimeMS 32-разрядное целое число со знаком, которое больше или равно нулю.

    readConcern MongoDB\Driver\ReadConcern

    Гарантия чтения для применения к операции.

    Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во время выполнения, если указана для более старой версии сервера.

    readPreference MongoDB\Driver\ReadPreference

    Предпочтение чтения, используемая для выбора сервера для выполнения операции.

    writeConcern MongoDB\Driver\WriteConcern

    Гарантия записи для применения к операции.

    Эта опция доступна в MongoDB 4.0+.

    		[]
    snapshot bool

    Опция настраивает чтение моментальных снимков в сессии. Если true, временная метка будет получена из первой поддерживаемой операции чтения в сессии (т.е. find, aggregate или unsharded distinct). Последующие операции чтения в рамках сессии будут затем использовать уровень гарантии чтения "snapshot" для чтения данных, подтверждённых большинством, из этой временной метки. Установите значение false для отключения чтения моментальных снимков.

    Для чтения моментальных снимков требуется MongoDB 5.0+, и их нельзя использовать с причинно-согласованной связью, транзакциями или операциями записи. Если "snapshot" равен true, "causalConsistency" по умолчанию будет false.

    Смотрите » гарантию чтения "snapshot" в руководстве MongoDB для получения дополнительной информации.

    		false

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

    Возвращает MongoDB\Driver\Session.

    Ошибки

    Список изменений

    Версия Описание
    PECL mongodb 1.11.0

    Добавлен параметр "snapshot".

    PECL mongodb 1.6.0

    Параметр "maxCommitTimeMS" добавлен в "defaultTransactionOptions".

    PECL mongodb 1.5.0

    Добавлена опция "defaultTransactionOptions".

    Смотрите также

    Улучшение страницы

    Инструкция • Исправление • Сообщение об ошибке
    ＋Добавить

    Примечания пользователей

    Пользователи ещё не добавляли примечания для страницы
    To Top