PHP - Manual: MongoDB\Driver\ReadPreference

2025-10-23

MongoDB\Driver\ReadPreference::bsonSerialize »

« MongoDB\Driver\WriteConcern::unserialize

The MongoDB\Driver\ReadPreference class

(mongodb >=1.0.0)

简介

类摘要

final class MongoDB\Driver\ReadPreference implements MongoDB\BSON\Serializable, Serializable {

/* 常量 */

const int RP_PRIMARY = 1;

const int RP_PRIMARY_PREFERRED = 5;

const int RP_SECONDARY = 2;

const int RP_SECONDARY_PREFERRED = 6;

const int RP_NEAREST = 10;

const string PRIMARY = primary;

const string PRIMARY_PREFERRED = primaryPreferred;

const string SECONDARY = secondary;

const string SECONDARY_PREFERRED = secondaryPreferred;

const string NEAREST = nearest;

const int NO_MAX_STALENESS = -1;

const int SMALLEST_MAX_STALENESS_SECONDS = 90;

/* 方法 */

final public bsonSerialize(): stdClass

final public __construct(string|int $mode, ?array $tagSets = null, ?array $options = null)

final public getHedge(): ?object

final public getMaxStalenessSeconds(): int

final public getMode(): int

final public getModeString(): string

final public getTagSets(): array

final public serialize(): string

final public unserialize(string $data): void

}

预定义常量

MongoDB\Driver\ReadPreference::RP_PRIMARY: All operations read from the current replica set primary. This is the default read preference for MongoDB.

警告
This constant has been DEPRECATED as of extension version 1.20.0 and will be removed in 2.0. Applications should use MongoDB\Driver\ReadPreference::PRIMARY instead.
MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED: In most situations, operations read from the primary but if it is unavailable, operations read from secondary members.

警告
This constant has been DEPRECATED as of extension version 1.20.0 and will be removed in 2.0. Applications should use MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED instead.
MongoDB\Driver\ReadPreference::RP_SECONDARY: All operations read from the secondary members of the replica set.

警告
This constant has been DEPRECATED as of extension version 1.20.0 and will be removed in 2.0. Applications should use MongoDB\Driver\ReadPreference::SECONDARY instead.
MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED: In most situations, operations read from secondary members but if no secondary members are available, operations read from the primary.

警告
This constant has been DEPRECATED as of extension version 1.20.0 and will be removed in 2.0. Applications should use MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED instead.
MongoDB\Driver\ReadPreference::RP_NEAREST: Operations read from member of the replica set with the least network latency, irrespective of the member's type.

警告
This constant has been DEPRECATED as of extension version 1.20.0 and will be removed in 2.0. Applications should use MongoDB\Driver\ReadPreference::NEAREST instead.
MongoDB\Driver\ReadPreference::PRIMARY: All operations read from the current replica set primary. This is the default read preference for MongoDB.
MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED: In most situations, operations read from the primary but if it is unavailable, operations read from secondary members.
MongoDB\Driver\ReadPreference::SECONDARY: All operations read from the secondary members of the replica set.
MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED: In most situations, operations read from secondary members but if no secondary members are available, operations read from the primary.
MongoDB\Driver\ReadPreference::NEAREST: Operations read from member of the replica set with the least network latency, irrespective of the member's type.
MongoDB\Driver\ReadPreference::NO_MAX_STALENESS: The default value for the "maxStalenessSeconds" option is to specify no limit on maximum staleness, which means that the driver will not consider a secondary's lag when choosing where to direct a read operation.
MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS: The minimum value for the "maxStalenessSeconds" option is 90 seconds. The driver estimates secondaries' staleness by periodically checking the latest write date of each replica set member. Since these checks are infrequent, the staleness estimate is coarse. Thus, the driver cannot enforce a max staleness value of less than 90 seconds.

更新日志

版本说明

PECL mongodb 1.20.0

版本	说明
PECL mongodb 1.20.0	Deprecated the `MongoDB\Driver\ReadPreference::RP_PRIMARY`, `MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED`, `MongoDB\Driver\ReadPreference::RP_SECONDARY`, `MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED`, and `MongoDB\Driver\ReadPreference::RP_NEAREST` constants.
PECL mongodb 1.7.0	Added the `MongoDB\Driver\ReadPreference::PRIMARY`, `MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED`, `MongoDB\Driver\ReadPreference::SECONDARY`, `MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED`, and `MongoDB\Driver\ReadPreference::NEAREST` constants. Implements Serializable.
PECL mongodb 1.2.0	Added the `MongoDB\Driver\ReadPreference::NO_MAX_STALENESS` and `MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS` constants. Implements MongoDB\BSON\Serializable.

Deprecated the MongoDB\Driver\ReadPreference::RP_PRIMARY, MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED, MongoDB\Driver\ReadPreference::RP_SECONDARY, MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED, and MongoDB\Driver\ReadPreference::RP_NEAREST constants.

PECL mongodb 1.7.0

Added the MongoDB\Driver\ReadPreference::PRIMARY, MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED, MongoDB\Driver\ReadPreference::SECONDARY, MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED, and MongoDB\Driver\ReadPreference::NEAREST constants.

Implements Serializable.

PECL mongodb 1.2.0

Added the MongoDB\Driver\ReadPreference::NO_MAX_STALENESS and MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS constants.

Implements MongoDB\BSON\Serializable.

MongoDB\Driver\ReadPreference::bsonSerialize — Returns an object for BSON serialization
MongoDB\Driver\ReadPreference::__construct — Create a new ReadPreference
MongoDB\Driver\ReadPreference::getHedge — Returns the ReadPreference's "hedge" option
MongoDB\Driver\ReadPreference::getMaxStalenessSeconds — Returns the ReadPreference's "maxStalenessSeconds" option
MongoDB\Driver\ReadPreference::getMode — Returns the ReadPreference's "mode" option
MongoDB\Driver\ReadPreference::getModeString — Returns the ReadPreference's "mode" option
MongoDB\Driver\ReadPreference::getTagSets — Returns the ReadPreference's "tagSets" option
MongoDB\Driver\ReadPreference::serialize — Serialize a ReadPreference
MongoDB\Driver\ReadPreference::unserialize — Unserialize a ReadPreference

发现了问题？

了解如何改进此页面 • 提交拉取请求 • 报告一个错误

＋添加备注

用户贡献的备注

此页面尚无用户贡献的备注。

官方地址：https://www.php.net/manual/en/class.mongodb-driver-readpreference.php

有任何技术问题请点击这里网站运营推广招聘

IT PHP 编程语言开发编程 Linux 科技 Elasticsearch HTML/CSS/XML 面试数据库网络 JAVA NoSQL C/C++ Golang 操作系统 Git 算法正则表达式 Redis 互联网 MySql 软件运维 JavaScript 国际架构设计 Mac OS Excel TCP/IP Windows Oracle Socket Vim VR 运营 MongoDB Python MemCache 商业硬件电子娱乐设计摄影 nginx WordPress 游戏 HTTP 团建数码电器 Docker

略微加速

PHP官方手册 - 互联网笔记

The MongoDB\Driver\ReadPreference class

简介

类摘要

预定义常量

更新日志

目录

发现了问题？

用户贡献的备注