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 或非分片 distinct）获取时间戳。然后，会话中的后续读操作将使用 "snapshot" 读关注级别从该时间戳读取多数提交的数据。设置为 false 以禁用快照读取。

    快照读取需要 MongoDB 5.0+，不能与因果一致性、事务或写操作一起使用。如果 "snapshot" 为 true，"causalConsistency" 将默认为 false。

    有关更多信息，请参阅 MongoDB 手册中的 » 读关注 "snapshot"。

    		 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