Document limits for heartbeatFrequencyMS and maxStalenessSeconds MongoDB URI options

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@341907 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jeremy Mikola 2017-02-16 16:03:27 +00:00
parent e650d676f4
commit d6fe182e3b

View file

@ -172,6 +172,11 @@ mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][
until the beginning of the next one. Defaults to 60,000
milliseconds.
</para>
<para>
Per the
<link xlink:href="&url.mongodb.sdam;#heartbeatfrequencyms">Server Discovery and Monitoring Specification</link>,
this value cannot be less than 500 milliseconds.
</para>
</entry>
</row>
<row>
@ -201,13 +206,21 @@ mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][
<entry>maxStalenessSeconds</entry>
<entry><type>integer</type></entry>
<entry>
Corresponds to the read preference's
<literal>"maxStalenessSeconds"</literal>. Specifies, in seconds, how
stale a secondary can be before the client stops using it for read
operations. By default, there is no maximum staleness and clients
will not consider a secondarys lag when choosing where to direct a
read operation. For details, see
<classname>MongoDB\Driver\ReadPreference</classname>.
<para>
Corresponds to the read preference's
<literal>"maxStalenessSeconds"</literal>. Specifies, in seconds, how
stale a secondary can be before the client stops using it for read
operations. By default, there is no maximum staleness and clients
will not consider a secondarys lag when choosing where to direct a
read operation. For details, see
<classname>MongoDB\Driver\ReadPreference</classname>.
</para>
<para>
If specified, the max staleness must be a signed 32-bit integer
greater than or equal to
<constant>MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS</constant>
(i.e. 90 seconds).
</para>
</entry>
</row>
<row>