Skip to content

Commit 98a6a91

Browse files
committed
format
1 parent e064ebb commit 98a6a91

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

source/connect/connection-options.txt

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ connection options:
5555
Connection Options
5656
------------------
5757

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+}.
5959

6060
Network Compression
6161
~~~~~~~~~~~~~~~~~~~
@@ -69,8 +69,8 @@ Network Compression
6969

7070
* - **:compressors**
7171
- | 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``.
7474
|
7575
| **Data Type**: ``Array<String>``
7676
| **Default**: none
@@ -79,15 +79,15 @@ Network Compression
7979

8080
* - **:zlib_compression_level**
8181
- | 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``:
8383
|
8484
| - **-1:** zlib uses its default compression level (usually ``6``).
8585
| - **0:** No compression.
8686
| - **1:** Fastest speed but lowest compression.
8787
| - **9:** Best compression but slowest speed.
8888
|
8989
| 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.
9191
|
9292
| **Data Type**: ``Integer``
9393
| **Default**: ``None``
@@ -106,12 +106,12 @@ Timeouts
106106

107107
* - **:connect_timeout**
108108
- | 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.
111111
|
112112
| ``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).
115115
|
116116
| **Data Type**: ``Float``
117117
| **Default**: 10
@@ -120,11 +120,11 @@ Timeouts
120120

121121
* - **:socket_timeout**
122122
- | 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.
124124
|
125125
| ``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).
128128
|
129129
| **Data Type**: ``Float``
130130
| **Default**: none
@@ -133,7 +133,7 @@ Timeouts
133133

134134
* - **:wait_queue_timeout**
135135
- | The number of seconds to wait for a connection in the
136-
| connection pool to become available.
136+
connection pool to become available.
137137
|
138138
| **Data Type**: ``Float``
139139
| **Default**: 10
@@ -152,8 +152,8 @@ Server Selection
152152

153153
* - **:server_selector**
154154
- | 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.
157157
|
158158
| **Data Type**: ``ServerSelector``
159159
| **Default**: none
@@ -162,7 +162,7 @@ Server Selection
162162

163163
* - **:server_selection_timeout**
164164
- | 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.
166166
|
167167
| **Data Type**: ``Integer``
168168
| **Default**: ``30``
@@ -190,7 +190,7 @@ Authentication
190190

191191
* - **:auth_mech_properties**
192192
- | Options specific to the authentication mechanism. This option
193-
| isn't needed for all authentication mechanisms.
193+
isn't needed for all authentication mechanisms.
194194
|
195195
| **Data Type**: ``Hash``
196196
| **Default**: When you use the GSSAPI authentication mechanism,
@@ -209,7 +209,7 @@ Authentication
209209

210210
* - **:user**
211211
- | 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.
213213
|
214214
| **Data Type**: ``String``
215215
| **Default**: none
@@ -218,7 +218,7 @@ Authentication
218218

219219
* - **:password**
220220
- | 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.
222222
|
223223
| **Data Type**: ``String``
224224
| **Default**: none
@@ -253,7 +253,7 @@ Read and Write Operations
253253

254254
* - **:read**
255255
- | 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.
257257
|
258258
| **Data Type**: ``Hash``
259259
| **Default**: ``{ :mode: :primary }``
@@ -262,7 +262,7 @@ Read and Write Operations
262262

263263
* - **:read_concern**
264264
- | 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.
266266
|
267267
| **Data Type**: ``Hash``
268268
| **Default**: none
@@ -271,7 +271,7 @@ Read and Write Operations
271271

272272
* - **:write_concern**
273273
- | 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.
275275
|
276276
| **Data Type**: ``Hash``
277277
| **Default**: ``write_concern: { w: 1 }``
@@ -280,9 +280,9 @@ Read and Write Operations
280280

281281
* - **:local_threshold**
282282
- | 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.
286286
|
287287
| **Data Type**: ``Float``
288288
| **Default**: ``0.015``

0 commit comments

Comments
 (0)