DOCSP-45614-connection-string-examples (#726)

* DOCSP-45614-connection-string-examples

* reviewer changes

* reviewer updates

* address feedback

Author: amalhotra-mdb

source/connect.txt

@@ -101,14 +101,32 @@ Use Advanced Connection Options
 
 .. include:: /includes/intro-advanced-connection-options.rst
 
-For details, see :ref:`advanced-connection-options`.
+For details on how to specify connection options using Compass, 
+see :ref:`advanced-connection-options`.
 
 Connect to Compass from the Command Line
 ----------------------------------------
 
 .. include:: /includes/intro-command-line-connection.rst
 
-For details, see :ref:`comp-command-line-connect`.
+To connect to Compass using the command line, you can include your connection 
+options directly in your connection string or as command line arguments.
+
+To specify connection options in your connection string, use the following format: 
+
+.. code-block::
+
+   mongodb-compass 'mongodb://username:password@hostname:port/database?ssl=true&replicaSet=myReplicaSet'
+
+For more connection string options, see :ref:`connections-connection-options`.
+
+To specify connection options as command line arguments, use the following format:
+
+.. code-block::
+
+   <path/to/compass/executable> <connection string> --username <username> --password <password>
+
+For more command line argument connection options, see :ref:`comp-command-line-connect`.
 
 .. seealso::
 
@@ -123,3 +141,90 @@ For details, see :ref:`comp-command-line-connect`.
    Favorite Connections </connect/favorite-connections>
    Required Access </connect/required-access>
    Disconnect </connect/disconnect>
+
+Connection String Examples
+--------------------------
+
+The following examples highlight some advanced connection string options.
+For information on all connection string options, see :ref:`connections-connection-options`.  
+
+TLS Options
+~~~~~~~~~~~
+
+The following connection string enables TLS using the ``tls`` URI option. 
+``tlsCertificateKeyFile`` specifies the path to the client certificate and 
+private key. Specifying the ``tlsCertificateKeyFile`` in your connection string
+is optional, unless the server requires client certificates, or if 
+you are using X.509 authentication.
+
+.. code-block:: 
+
+   mongodb://myDatabaseUser:D1fficultP%[email protected]/?directConnection=true&tls=true&tlsCAFile=path/to/rootCA.crt&tlsCertificateKeyFile=path/to/server_certificate.pem
+
+To enable SSL, use the equivalent ``ssl=true`` option in place of ``tls=true``. 
+
+X.509 Authentication
+````````````````````
+
+The following example demonstrates how to specify X.509 authentication in your connection string
+using the :urioption:`authMechanism` connection string option:
+
+.. code-block:: 
+
+   mongodb://myDatabaseUser:D1fficultP%[email protected]/?authMechanism=MONGODB-X509&tls=true&tlsCertificateKeyFile=/path/to/client_certificate.pem
+
+LDAP
+~~~~
+
+The following example specifies LDAP authentication. It sets :urioption:`authMechanism` to ``plain`` 
+to specify the use of the LDAP authentication mechanism and sets ``authSource`` to ``$external``
+to indicate that the authentication database is ``$external``.
+
+.. code-block:: 
+
+   mongodb://myDatabaseUser:D1fficultP%[email protected]/?authMechanism=PLAIN&authSource=$external
+
+Kerberos
+~~~~~~~~
+
+The following example specifies Kerberos authentication. It sets :urioption:`authMechanism` to
+``GSSAPI`` to use the Kerberos authentication mechanism and sets ``authSource`` to ``$external``
+to indicate that the authentication database is ``$external``.
+
+.. code-block:: 
+
+   mongodb://[email protected]/?authMechanism=GSSAPI&authSource=$external
+
+Read/Write Preferences
+~~~~~~~~~~~~~~~~~~~~~~
+
+To enable read/write preferences in your connection string, you can use the 
+``readPreference`` option for read preferences and the ``w`` option for write concerns.
+
+The following connection string sets both read and write preferences. 
+``readPreference=secondary`` specifies that read operations should be directed to secondary 
+members of the replica set and ``w=majority`` ensures that write operations are 
+acknowledged by the majority of the replica set members.
+
+.. code-block::
+
+   mongodb://myDatabaseUser:D1fficultP%[email protected]/database?readPreference=secondary&w=majority
+
+Analytic Nodes
+~~~~~~~~~~~~~~
+
+To specify an ``analytics`` node type in your connection string: 
+
+- Set your ``readPreference`` to ``secondary`` to specify that the read operations 
+  should be directed to secondary nodes.
+- Set ``readPreferenceTags`` to ``nodeType:ANALYTICS`` to ensure that the read operations 
+  are directed specifically to the analytic nodes. 
+
+The following connection string demonstrates how to specify an ``analytics`` node type in your
+connection string: 
+
+.. code-block:: 
+
+   mongodb+srv://myDatabaseUser:D1fficultP%[email protected]/myDatabase?readPreference=secondary&readPreferenceTags=nodeType:ANALYTICS
+
+For more information on using analytics nodes to isolate workloads, see :ref:`replica-set-tags`.