From 804331d0e3a09afc76987880a53f57663de15a74 Mon Sep 17 00:00:00 2001
From: Hannes Magnusson <bjori@php.net>
Date: Fri, 18 Apr 2014 23:17:28 +0000
Subject: [PATCH] Document new connection options - 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
---
 reference/mongo/mongoclient/construct.xml | 82 +++++++++++++++++++++++
 1 file changed, 82 insertions(+)

diff --git a/reference/mongo/mongoclient/construct.xml b/reference/mongo/mongoclient/construct.xml
index 951654d79b..fae203dcd4 100644
--- a/reference/mongo/mongoclient/construct.xml
+++ b/reference/mongo/mongoclient/construct.xml
@@ -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>