@@ -55,7 +55,7 @@ connection options:
55
55
Connection Options
56
56
------------------
57
57
58
- The following sections describe the connection options available in {+driver-short+}.
58
+ The following sections describe the connection options available in the {+driver-short+}.
59
59
60
60
Network Compression
61
61
~~~~~~~~~~~~~~~~~~~
@@ -69,8 +69,8 @@ Network Compression
69
69
70
70
* - **:compressors**
71
71
- | A list of potential compressors to use, in order of preference.
72
- | The driver chooses the first compressor that is also supported
73
- | by the server. Currently the driver only supports ``zstd``, ``snappy``, and ``zlib``.
72
+ The driver chooses the first compressor that is also supported
73
+ by the server. Currently the driver only supports ``zstd``, ``snappy``, and ``zlib``.
74
74
|
75
75
| **Data Type**: ``Array<String>``
76
76
| **Default**: none
@@ -79,15 +79,15 @@ Network Compression
79
79
80
80
* - **:zlib_compression_level**
81
81
- | The Zlib compression level to use, if using compression.
82
- | This option accepts an integer value between ``-1`` and ``9``:
82
+ This option accepts an integer value between ``-1`` and ``9``:
83
83
|
84
84
| - **-1:** zlib uses its default compression level (usually ``6``).
85
85
| - **0:** No compression.
86
86
| - **1:** Fastest speed but lowest compression.
87
87
| - **9:** Best compression but slowest speed.
88
88
|
89
89
| For more information, see Ruby's `ZLib module <https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib.html>`__
90
- | documentation.
90
+ documentation.
91
91
|
92
92
| **Data Type**: ``Integer``
93
93
| **Default**: ``None``
@@ -106,12 +106,12 @@ Timeouts
106
106
107
107
* - **:connect_timeout**
108
108
- | The number of seconds to wait to establish a socket
109
- | connection before raising an exception. This
110
- | timeout is also used for SRV DNS record resolution.
109
+ connection before raising an exception. This
110
+ timeout is also used for SRV DNS record resolution.
111
111
|
112
112
| ``nil`` and ``0`` mean no timeout. Client creation will
113
- | fail with an error if an invalid timeout value
114
- | is passed (such as a negative value or a non-numeric value).
113
+ fail with an error if an invalid timeout value
114
+ is passed (such as a negative value or a non-numeric value).
115
115
|
116
116
| **Data Type**: ``Float``
117
117
| **Default**: 10
@@ -120,11 +120,11 @@ Timeouts
120
120
121
121
* - **:socket_timeout**
122
122
- | The number of seconds to wait for an operation to execute on
123
- | a socket before raising an exception.
123
+ a socket before raising an exception.
124
124
|
125
125
| ``nil`` and ``0`` mean no timeout. Client creation will fail
126
- | with an error if an invalid timeout value is passed
127
- | (such as a negative value or a non-numeric value).
126
+ with an error if an invalid timeout value is passed
127
+ (such as a negative value or a non-numeric value).
128
128
|
129
129
| **Data Type**: ``Float``
130
130
| **Default**: none
@@ -133,7 +133,7 @@ Timeouts
133
133
134
134
* - **:wait_queue_timeout**
135
135
- | The number of seconds to wait for a connection in the
136
- | connection pool to become available.
136
+ connection pool to become available.
137
137
|
138
138
| **Data Type**: ``Float``
139
139
| **Default**: 10
@@ -152,8 +152,8 @@ Server Selection
152
152
153
153
* - **:server_selector**
154
154
- | Get the server selector. It either uses the read preference
155
- | defined in the client options or defaults to a Primary
156
- | server selector.
155
+ defined in the client options or defaults to a Primary
156
+ server selector.
157
157
|
158
158
| **Data Type**: ``ServerSelector``
159
159
| **Default**: none
@@ -162,7 +162,7 @@ Server Selection
162
162
163
163
* - **:server_selection_timeout**
164
164
- | The maximum amount of time, in seconds, the driver waits
165
- | for server selection to succeed before throwing an exception.
165
+ for server selection to succeed before throwing an exception.
166
166
|
167
167
| **Data Type**: ``Integer``
168
168
| **Default**: ``30``
@@ -190,7 +190,7 @@ Authentication
190
190
191
191
* - **:auth_mech_properties**
192
192
- | Options specific to the authentication mechanism. This option
193
- | isn't needed for all authentication mechanisms.
193
+ isn't needed for all authentication mechanisms.
194
194
|
195
195
| **Data Type**: ``Hash``
196
196
| **Default**: When you use the GSSAPI authentication mechanism,
@@ -209,7 +209,7 @@ Authentication
209
209
210
210
* - **:user**
211
211
- | The username for authentication. When this option is included
212
- | in a connection URI, you must percent-encode it.
212
+ in a connection URI, you must percent-encode it.
213
213
|
214
214
| **Data Type**: ``String``
215
215
| **Default**: none
@@ -218,7 +218,7 @@ Authentication
218
218
219
219
* - **:password**
220
220
- | The password for authentication. When this option is included
221
- | in a connection URI, you must percent-encode it.
221
+ in a connection URI, you must percent-encode it.
222
222
|
223
223
| **Data Type**: ``String``
224
224
| **Default**: none
@@ -253,7 +253,7 @@ Read and Write Operations
253
253
254
254
* - **:read**
255
255
- | The read preference options. For more information,
256
- | see :manual:`Read Preference </core/read-preference/>` in the Server manual.
256
+ see :manual:`Read Preference </core/read-preference/>` in the Server manual.
257
257
|
258
258
| **Data Type**: ``Hash``
259
259
| **Default**: ``{ :mode: :primary }``
@@ -262,7 +262,7 @@ Read and Write Operations
262
262
263
263
* - **:read_concern**
264
264
- | Specifies the read concern options. For more information, see
265
- | :manual:`Read Concern </reference/read-concern/>` in the Server manual.
265
+ :manual:`Read Concern </reference/read-concern/>` in the Server manual.
266
266
|
267
267
| **Data Type**: ``Hash``
268
268
| **Default**: none
@@ -271,7 +271,7 @@ Read and Write Operations
271
271
272
272
* - **:write_concern**
273
273
- | Specifies the client's write concern. For more
274
- | information, see :manual:`Write Concern </reference/write-concern/>` in the Server manual.
274
+ information, see :manual:`Write Concern </reference/write-concern/>` in the Server manual.
275
275
|
276
276
| **Data Type**: ``Hash``
277
277
| **Default**: ``write_concern: { w: 1 }``
@@ -280,9 +280,9 @@ Read and Write Operations
280
280
281
281
* - **:local_threshold**
282
282
- | The latency window, in seconds, for a replica-set member's
283
- | eligibility. If a member's round trip ping takes longer
284
- | than the fastest server's round-trip ping time
285
- | plus this value, the server isn't eligible for selection.
283
+ eligibility. If a member's round trip ping takes longer
284
+ than the fastest server's round-trip ping time
285
+ plus this value, the server isn't eligible for selection.
286
286
|
287
287
| **Data Type**: ``Float``
288
288
| **Default**: ``0.015``
0 commit comments