@@ -12,3 +12,100 @@ Advanced Connection Tab
12
12
:depth: 1
13
13
:class: singlecol
14
14
15
+
16
+ The :guilabel:`Advanced` connection tab provides additional connection options
17
+ for your deployment. These options can be used with the
18
+ :ref:`General <general-connection-tab>`, :ref:`Authentication
19
+ <authentication-connection-tab>`, :ref:`TLS / SSL <tls-ssl-tab>`, and
20
+ :ref:`Proxy / SSH Tunnel <ssh-connection>` connection options.
21
+
22
+ Procedure
23
+ ---------
24
+
25
+ .. procedure::
26
+ :style: normal
27
+
28
+ .. step:: Click :guilabel:`Advanced Connection Options`.
29
+
30
+ .. figure:: /images/compass/advanced-connection-options.png
31
+ :figwidth: 690px
32
+ :alt: New Advanced Connection Options
33
+
34
+ .. step:: Click the :guilabel:`Advanced` tab.
35
+
36
+ (Optional) Select a :guilabel:`Read Preference` from the following
37
+ options:
38
+
39
+ .. list-table::
40
+ :header-rows: 1
41
+ :widths: 50 50
42
+
43
+ * - Read Preference
44
+ - Description
45
+
46
+ * - Primary
47
+ - Default mode. All operations read from the current replica set primary.
48
+ If the primary is unavailable, the operation fails.
49
+
50
+ * - Primary Preferred
51
+ - Operations read from the primary unless the primary is unavailable.
52
+ If the primary is unavailable, operations read from secondary members.
53
+
54
+ * - Secondary
55
+ - All operations read from the secondary members of the replica set.
56
+ If the secondary is unavailable, the operation fails.
57
+
58
+ * - Secondary Preferred
59
+ - Operations read from the secondary unless the secondary is unavailable.
60
+ If the secondary is unavailable, operations read from the primary
61
+ on sharded clusters.
62
+
63
+ * - Nearest
64
+ - Operations read from a random eligible replica set member,
65
+ irrespective of whether that member is a primary or secondary, based
66
+ on a specified latency threshold. The operation considers the following
67
+ when calculating latency:
68
+
69
+ - The :manual:`localThresholdMS
70
+ </reference/connection-string/#mongodb-urioption-urioption.localThresholdMS>`
71
+ connection string option.
72
+ - The :manual:`maxStalenessSeconds
73
+ </core/read-preference-staleness/#read-preference-maxstalenessseconds>`
74
+ read preference option.
75
+ - Any specified tag sets.
76
+
77
+ .. seealso::
78
+
79
+ - :manual:`Read Preferrence </core/read-preference/#read-preference>`.
80
+ - :manual:`Read Preferrence Use Cases </core/read-preference-use-cases/#read-preference-use-cases>`.
81
+
82
+ Additional Optional Fields
83
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~
84
+
85
+ .. list-table::
86
+ :header-rows: 1
87
+ :widths: 50 50
88
+
89
+ * - Field
90
+ - Description
91
+
92
+ * - Replica Set Name
93
+ - (Optional) Name of replica set.
94
+
95
+ * - Default Authentication Database
96
+ - (Optional) Authentication database used when authSource is not specified.
97
+ For more information, see :manual:`Authentication Options
98
+ </reference/connection-string/#authentication-options>`.
99
+
100
+ * - URI Options
101
+ - Additional options to customize your connection. You
102
+ specify these options as key-value pairs, and |compass-short|
103
+ automatically adds the key-value pairs to the connection string.
104
+ For more information, see :manual:`Connection String Options
105
+ </reference/connection-string/#connection-string-options>`.
106
+
107
+ .. step:: Click Connect.
108
+
109
+ .. seealso::
110
+
111
+ To disconnect from your deployment, see :ref:`<disconnect-tab>`.
0 commit comments