MongoDB\Driver\Manager::startSession
(mongodb >=1.4.0)
MongoDB\Driver\Manager::startSession — Запускает новый клиентский сеанс для использования с этим клиентом
Описание
Создает 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+.
[]
Возвращаемые значения
Возвращает MongoDB\Driver\Session.
Ошибки
- При ошибке парсинга аргумента бросает исключение MongoDB\Driver\Exception\InvalidArgumentException.
- Выдает исключение MongoDB\Driver\Exception\RuntimeException если сеанс не может быть создан (например, libmongoc не поддерживает шифрование).
Список изменений
Версия | Описание |
---|---|
PECL mongodb 1.6.0 |
Параметр |
PECL mongodb 1.5.0 |
Добавлена опция |
Смотрите также
- MongoDB\Driver\Session
- » Причинная согласованность в руководстве MongoDB