Document mongodb.mock_service_id INI option

https://jira.mongodb.org/browse/PHPC-1978
This commit is contained in:
Jeremy Mikola 2021-10-28 21:22:42 -04:00
parent 7c5379029e
commit d587d7ea33
No known key found for this signature in database
GPG key ID: 826DE44395E8A8FC

View file

@ -23,6 +23,12 @@
<entry>PHP_INI_ALL</entry>
<entry></entry>
</row>
<row>
<entry><link linkend="ini.mongodb.mock_service_id">mongodb.mock_service_id</link></entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
<entry>Available as of mongodb 1.11.0.</entry>
</row>
</tbody>
</tgroup>
</table>
@ -73,6 +79,35 @@
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mongodb.mock_service_id">
<term>
<parameter>mongodb.mock_service_id</parameter>
<type>string</type>
</term>
<listitem>
<para>
This option can be used to enable or disable mocking of the
<literal>serviceId</literal> field in <literal>hello</literal> command
responses.
</para>
<para>
Specify an empty string, <literal>"0"</literal>,
<literal>"off"</literal>, <literal>"no"</literal>, or
<literal>"false"</literal> to disable mocking.
</para>
<para>
Specify <literal>"1"</literal>, <literal>"on"</literal>,
<literal>"yes"</literal>, or <literal>"true"</literal> to enable
mocking.
</para>
<note>
<para>
This option is primarily intended for internal testing of load balancers
and should not be used under normal circumstances.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</article>