Skip to content

Commit daf2f8d

Browse files
committed
more edits
1 parent 9e1a086 commit daf2f8d

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

source/connect/connection-options.txt

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,6 @@ Connection Options
5656
------------------
5757

5858
The following sections describe the connection options available in {+driver-short+}.
59-
If a ``Mongo::Client`` parameter maps to more than one
60-
option in the connection string, the **Connection URI Example** shows all
61-
relevant options.
6259

6360
Network Compression
6461
~~~~~~~~~~~~~~~~~~~
@@ -160,14 +157,14 @@ Server Selection
160157
|
161158
| **Data Type**: ``ServerSelector``
162159
| **Default**: none
163-
| **Client Example**: ``server_selector: { mode: :secondary_preferred }`` NOT SURE ABOUT THIS ONE
160+
| **Client Example**: ``server_selector: { mode: :secondary_preferred }``
164161
| **Connection URI Example**: N/A
165162

166163
* - **:server_selection_timeout**
167164
- | The number of seconds to wait for an appropriate server to
168165
| be selected for an operation to be executed before raising an exception.
169166
|
170-
| **Data Type**:
167+
| **Data Type**: ``Integer``
171168
| **Default**: ``30``
172169
| **Client Example**: ``server_selection_timeout: 30``
173170
| **Connection URI Example**: ``serverSelectionTimeoutMS=30000``
@@ -186,23 +183,19 @@ Authentication
186183
- | The mechanism that the {+driver-short+} uses to authenticate the application.
187184
|
188185
| **Data Type**: ``Symbol``
189-
| **Default**: If user credentials are not supplied, ``nil``. If user credentials
190-
| are supplied, the default depends on server version.
191-
| MongoDB 4.0 and later: ``:scram256`` if user credentials correspond
192-
| to a user which supports SCRAM-SHA-256 authentication, otherwise
193-
| ``:scram``.
194-
| MongoDB 3.0-3.6: ``:scram``.
195-
| MongoDB 2.6: ``:mongodb_cr``
196-
| **Client Example**: ``auth_mech: :scram256`` UNSUREEEEEE
186+
| **Default**: ``nil`` if user credentials are not supplied.
187+
| ``:scram256`` when connecting to MongoDB v4.0 or later.
188+
| **Client Example**: ``auth_mech: :scram256``
197189
| **Connection URI Example**: ``authMechanism=SCRAM-SHA-256``
198190

199191
* - **:auth_mech_properties**
200192
- | Options specific to the authentication mechanism. This option
201193
| isn't needed for all authentication mechanisms.
202194
|
203195
| **Data Type**: ``Hash``
204-
| **Default**: When you use the GSSAPI authentication mechanism, the default properties
205-
| are ``{service_name: "mongodb"}``. Otherwise the default is ``nil``.
196+
| **Default**: When you use the GSSAPI authentication mechanism,
197+
| the default properties are ``{service_name: "mongodb"}``.
198+
| Otherwise, the default is ``nil``.
206199
| **Client Example**: ``auth_mech_properties: {aws_session_token: '12345'}``
207200
| **Connection URI Example**: ``authMechanismProperties=AWS_SESSION_TOKEN:12345``
208201

@@ -215,8 +208,8 @@ Authentication
215208
| **Connection URI Example**: ``authSource=admin``
216209

217210
* - **:user**
218-
- | The username for authentication. When this option is included in a
219-
| connection URI, you must percent-encode it.
211+
- | The username for authentication. When this option is included
212+
| in a connection URI, you must percent-encode it.
220213
|
221214
| **Data Type**: ``String``
222215
| **Default**: none
@@ -260,8 +253,7 @@ Read and Write Operations
260253

261254
* - **:read**
262255
- | The read preference options. For more information,
263-
| see :manual:`Read Preference </core/read-preference/>` in the
264-
| Server manual.
256+
| see :manual:`Read Preference </core/read-preference/>` in the Server manual.
265257
|
266258
| **Data Type**: ``Hash``
267259
| **Default**: ``{ :mode: :primary }``
@@ -270,8 +262,7 @@ Read and Write Operations
270262

271263
* - **:read_concern**
272264
- | Specifies the read concern options. For more information, see
273-
| :manual:`Read Concern </reference/read-concern/>` in the Server
274-
| manual.
265+
| :manual:`Read Concern </reference/read-concern/>` in the Server manual.
275266
|
276267
| **Data Type**: ``Hash``
277268
| **Default**: none

0 commit comments

Comments
 (0)