Skip to content

Commit 71f211e

Browse files
(DOCSP-9298): Highlighting compass connection string options
1 parent b83d0f9 commit 71f211e

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

source/connect.txt

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,30 @@ deployment information in specific fields.
5656
.. tab:: Paste Connection String
5757
:tabid: paste-connection-string
5858

59+
When you provide a connection string, |compass-short| supports
60+
most :manual:`Connection String Options
61+
</reference/connection-string/#connection-string-options>`
62+
supported by MongoDB.
63+
64+
By default, |compass-short|'s default
65+
:manual:`socketTimeoutMS </reference/connection-string/#urioption.socketTimeoutMS>`
66+
value is 60000, or 60 seconds. If you are frequently experiencing
67+
timeouts in |compass-short|, consider setting this option to a
68+
higher value in your connection string.
69+
70+
For a complete list of the connection string options which
71+
|compass-short| supports, see the
72+
`Compass Connection README
73+
<https://github.com/mongodb-js/connection-model/blob/master/README.md#properties>`__
74+
on GitHub.
75+
5976
.. include:: /includes/steps/starting-compass-paste-string.rst
6077

6178
.. tab:: Fill in Individual Fields
6279
:tabid: individual-fields
6380

6481
.. include:: /includes/steps/starting-compass-individual-fields.rst
6582

66-
For MongoDB permissions required to access |compass-short|,
67-
see :ref:`required-access`.
68-
6983
.. note::
7084

7185
|compass| securely stores sensitive information entered in the
@@ -96,4 +110,3 @@ connection dialog.
96110

97111
/connect/required-access
98112
/connect/favorite-connections
99-

0 commit comments

Comments
 (0)