sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document new connection options

Browse source 
- authMechanism
- authSource
- gssapiServiceName
- secondaryAcceptableLatencyMS

https://jira.mongodb.org/browse/PHP-1042


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@333380 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2014-04-18 23:17:28 +00:00
parent 350e29c7e3
commit 804331d0e3
1 changed files with 82 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

82
reference/mongo/mongoclient/construct.xml
View file

@ -90,6 +90,55 @@ mongodb://[username:password@]host1[:port1][,host2[:port2:],...]/db
An array of options for the connection. Currently available options
include:
<itemizedlist>
<listitem>
<para>
<literal>"authMechanism"</literal>
</para>
<para>
Available mechanisms are:
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry>authMechanism</entry>
<entry>Description</entry>
<entry>Availability</entry>
</row>
</thead>
<tbody>
<row>
<entry>MONGODB-CR</entry>
<entry>Authenticate using Challenge Response mechanism. This is the default value.</entry>
<entry>All MongoDB versions</entry>
</row>
<row>
<entry>X509</entry>
<entry>Authenticates using X509 certificates</entry>
<entry>MongoDB 2.6. Only available when <xref linkend="book.openssl" /> is enabled</entry>
</row>
<row>
<entry>PLAIN</entry>
<entry>Authenticates using unencrypted plain username+password. Must be used over SSL connections. Generally used by MongoDB to login via 3rd party LDAP server</entry>
<entry>MongoDB Enterprise 2.4. The Driver must be compiled against CyrusSASL2</entry>
</row>
<row>
<entry>GSSAPI</entry>
<entry>Authenticates via kerberos systems</entry>
<entry>MongoDB Enterprise 2.4. The Driver must be compiled against CyrusSASL2</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
<listitem>
<para>
<literal>"authSource"</literal>
</para>
<para>
Should be set to the database name where the user is defined it.
</para>
</listitem>
<listitem>
<para>
<literal>"connect"</literal>
@ -172,6 +221,14 @@ mongodb://[username:password@]host1[:port1][,host2[:port2:],...]/db
</simpara>
</note>
</listitem>
<listitem>
<para>
<literal>"gssapiServiceName"</literal>
</para>
<para>
Sets the <link xlink:href="&url.mongodb.docs.kerberos.service-principal;">Kerberos service principal</link>. Only applicable when authMechanism=GSSAPI. Defaults to "mongodb".
</para>
</listitem>
<listitem>
<para>
<literal>"password"</literal>
@ -227,6 +284,15 @@ mongodb://[username:password@]host1[:port1][,host2[:port2:],...]/db
See the replica set example below for details.
</para>
</listitem>
<listitem>
<para>
<literal>"secondaryAcceptableLatencyMS"</literal>
</para>
<para>
When reading from a secondary (using ReadPreferences), do not read from secondaries known to be more then
<literal>secondaryAcceptableLatencyMS</literal> away from us. Defaults to <literal>15</literal>
</para>
</listitem>
<listitem>
<para>
<literal>"socketTimeoutMS"</literal>
@ -604,6 +670,14 @@ $m = new MongoClient(
</row>
</thead>
<tbody>
<row>
<entry>1.5.0</entry>
<entry>
<para>
Added <literal>"authMechanism"</literal>, <literal>"gssapiServiceName"</literal>, and <literal>"secondaryAcceptableLatencyMS"</literal>.
</para>
</entry>
</row>
<row>
<entry>1.4.0</entry>
<entry>
@ -617,6 +691,14 @@ $m = new MongoClient(
</para>
</entry>
</row>
<row>
<entry>1.5.0</entry>
<entry>
<para>
Added <literal>"authSource"</literal>.
</para>
</entry>
</row>
<row>
<entry>1.3.4</entry>
<entry>