Skip to content

Commit 2296609

Browse files
mongoKartmongoKart
committed
make one column
1 parent 8f5a381 commit 2296609

File tree

1 file changed

+63
-90
lines changed

1 file changed

+63
-90
lines changed

‎source/connect/connection-options.txt

Lines changed: 63 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -118,17 +118,16 @@ Timeout Options
118118
:stub-columns: 1
119119

120120
* - Connection Option
121-
- Data Type
122-
- Syntax
121+
- Description
123122

124123
* - :manual:`connectTimeoutMS </reference/connection-string/#mongodb-urioption-urioption.connecttimeoutms>`
125-
- {+int-data-type+}
124+
- | **Data Type**: {+int-data-type+}
126125
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'connectTimeoutMS' => 20000 ];``
127126
| **Connection URI Example**: ``connectTimeoutMS=20000``
128127

129128
* - :manual:`socketTimeoutMS </reference/connection-string/#mongodb-urioption-urioption.sockettimeoutms>`
130-
- {+int-data-type+}
131-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'socketTimeoutMS' => 400000 ];``
129+
- | **Data Type**: {+int-data-type+}
130+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'socketTimeoutMS' => 400000 ];``
132131
| **Connection URI Example**: ``socketTimeoutMS=400000``
133132

134133
.. _php-compression-options:
@@ -141,17 +140,16 @@ Compression Options
141140
:stub-columns: 1
142141

143142
* - Connection Option
144-
- Data Type
145-
- Syntax
143+
- Description
146144

147145
* - :manual:`compressors </reference/connection-string/#mongodb-urioption-urioption.compressors>`
148-
- {+string-data-type+}
149-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'compressors' => 'snappy,zstd,zlib' ];``
146+
- | **Data Type**: {+string-data-type+}
147+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'compressors' => 'snappy,zstd,zlib' ];``
150148
| **Connection URI Example**: ``compressors=snappy,zstd,zlib``
151149

152150
* - :manual:`zlibCompressionLevel </reference/connection-string/#mongodb-urioption-urioption.zlibcompressionlevel>`
153-
- {+int-data-type+}
154-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'zlibCompressionLevel' => 3 ];``
151+
- | **Data Type**: {+int-data-type+}
152+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'zlibCompressionLevel' => 3 ];``
155153
| **Connection URI Example**: ``zlibCompressionLevel=3``
156154

157155
Connection Pool Options
@@ -162,17 +160,16 @@ Connection Pool Options
162160
:stub-columns: 1
163161

164162
* - Connection Option
165-
- Data Type
166-
- Syntax
163+
- Description
167164

168165
* - :manual:`maxPoolSize </reference/connection-string/#mongodb-urioption-urioption.maxpoolsize>`
169-
- {+int-data-type+}
170-
- | **MongoDB\\Client Example**: N/A
166+
- | **Data Type**: {+int-data-type+}
167+
| **MongoDB\\Client Example**: N/A
171168
| **Connection URI Example**: ``maxPoolSize=75``
172169

173170
* - :manual:`waitQueueTimeoutMS </reference/connection-string/#mongodb-urioption-urioption.waitqueuetimeoutms>`
174-
- {+int-data-type+}
175-
- | **MongoDB\\Client Example**: N/A
171+
- | **Data Type**: {+int-data-type+}
172+
| **MongoDB\\Client Example**: N/A
176173
| **Connection URI Example**: ``waitQueueTimeoutMS=10000``
177174

178175
Write Concern Options
@@ -183,22 +180,21 @@ Write Concern Options
183180
:stub-columns: 1
184181

185182
* - Connection Option
186-
- Data Type
187-
- Syntax
183+
- Description
188184

189185
* - :manual:`w </reference/connection-string/#mongodb-urioption-urioption.w>`
190-
- {+string-data-type+}
191-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'w' => 'majority' ];``
186+
- | **Data Type**: {+string-data-type+}
187+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'w' => 'majority' ];``
192188
| **Connection URI Example**: ``w=majority``
193189

194190
* - :manual:`wTimeoutMS </reference/connection-string/#mongodb-urioption-urioption.wtimeoutms>`
195-
- {+int-data-type+}
196-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'wTimeoutMS' => 10000 ];``
191+
- | **Data Type**: {+int-data-type+}
192+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'wTimeoutMS' => 10000 ];``
197193
| **Connection URI Example**: ``wTimeoutMS=10000``
198194

199195
* - :manual:`journal </reference/connection-string/#mongodb-urioption-urioption.journal>`
200-
- {+bool-data-type+}
201-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'journal' => true ];``
196+
- | **Data Type**: {+bool-data-type+}
197+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'journal' => true ];``
202198
| **Connection URI Example**: ``journal=true``
203199

204200
Read Concern Options
@@ -209,12 +205,11 @@ Read Concern Options
209205
:stub-columns: 1
210206

211207
* - Connection Option
212-
- Data Type
213-
- Syntax
208+
- Description
214209

215210
* - :manual:`readConcernLevel </reference/connection-string/#mongodb-urioption-urioption.readconcernlevel>`
216-
- {+string-data-type+}
217-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'readConcernLevel' => 'majority' ];``
211+
- | **Data Type**: {+string-data-type+}
212+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'readConcernLevel' => 'majority' ];``
218213
| **Connection URI Example**: ``readConcernLevel=majority``
219214

220215
Read Preference Options
@@ -223,68 +218,49 @@ Read Preference Options
223218
.. list-table::
224219
:header-rows: 1
225220
:stub-columns: 1
226-
:width: 20 20 60
227221

228222
* - Connection Option
229-
- Data Type
230-
- Syntax
223+
- Description
231224

232225
* - :manual:`readPreference </reference/connection-string/#mongodb-urioption-urioption.readpreference>`
233-
- ``int`` or ``string``
234-
- **MongoDB\\Client Example**: ``$uriOptions = [ 'readPreference' => 'secondaryPreferred' ];``
235-
236-
**Connection URI Example**: ``readPreference=secondaryPreferred``
237-
238-
For a complete list of the available values for this option, see the
239-
`MongoDB\\Driver\\ReadPreference <https://www.php.net/manual/en/class.mongodb-driver-readpreference.php>`__
240-
API documentation.
226+
- | **Data Type**: `MongoDB\\Driver\\ReadPreference <https://www.php.net/manual/en/class.mongodb-driver-readpreference.php>`__
227+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'readPreference' => 'secondaryPreferred' ];``
228+
|
229+
| **Connection URI Example**: ``readPreference=secondaryPreferred``
241230

242231
* - :manual:`maxStalenessSeconds </reference/connection-string/#mongodb-urioption-urioption.maxstalenessseconds>`
243-
- {+int-data-type+}
244-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'maxStalenessSeconds' => 30 ];``
232+
- | **Data Type**: {+int-data-type+}
233+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'maxStalenessSeconds' => 30 ];``
245234
| **Connection URI Example**: ``maxStalenessSeconds=30``
246235

247236
* - :manual:`readPreferenceTags </reference/connection-string/#mongodb-urioption-urioption.readpreferencetags>`
248-
- ``array``
249-
- **MongoDB\\Client Example**:
250-
251-
.. code-block::
252-
:copyable: false
253-
254-
$uriOptions = [
255-
'readPreferenceTags' => [
256-
[ 'region' => 'east' ],
257-
[ 'region' => 'west']
258-
]
259-
];
260-
261-
**Connection URI Example**: ``readPreferenceTags=region:east,region:west``
237+
- | **Data Type**: ``array``
238+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'readPreferenceTags' => [ [ 'region' => 'east' ], [ 'region' => 'west'] ] ];``
239+
| **Connection URI Example**: ``readPreferenceTags=region:east,region:west``
262240

263241
Authentication Options
264242
~~~~~~~~~~~~~~~~~~~~~~
265243

266244
.. list-table::
267245
:header-rows: 1
268246
:stub-columns: 1
269-
:widths: 30 10 60
270247

271248
* - Connection Option
272-
- Data Type
273-
- Syntax
249+
- Description
274250

275251
* - :manual:`authMechanism </reference/connection-string/#mongodb-urioption-urioption.authmechanism>`
276-
- {+string-data-type+}
277-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'authMechanism' => 'MONGODB-X509' ];``
252+
- | **Data Type**: {+string-data-type+}
253+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'authMechanism' => 'MONGODB-X509' ];``
278254
| **Connection URI Example**: ``authMechanism=MONGODB-X509``
279255

280256
* - :manual:`authMechanismProperties </reference/connection-string/#mongodb-urioption-urioption.authmechanismproperties>`
281-
- {+string-data-type+}
282-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'authMechanism' => 'MONGODB-AWS', 'authMechanismProperties' => 'AWS_SESSION_TOKEN:12345' ];``
257+
- | **Data Type**: {+string-data-type+}
258+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'authMechanism' => 'MONGODB-AWS', 'authMechanismProperties' => 'AWS_SESSION_TOKEN:12345' ];``
283259
| **Connection URI Example**: ``authMechanism=MONGODB-AWS&authMechanismProperties=AWS_SESSION_TOKEN:12345``
284260

285261
* - :manual:`authSource </reference/connection-string/#mongodb-urioption-urioption.authsource>`
286-
- {+string-data-type+}
287-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'authSource' => 'admin' ];``
262+
- | **Data Type**: {+string-data-type+}
263+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'authSource' => 'admin' ];``
288264
| **Connection URI Example**: ``authSource=admin``
289265

290266
Server Selection and Discovery Options
@@ -293,35 +269,33 @@ Server Selection and Discovery Options
293269
.. list-table::
294270
:header-rows: 1
295271
:stub-columns: 1
296-
:widths: 35 10 55
297272

298273
* - Connection Option
299-
- Data Type
300-
- Syntax
274+
- Description
301275

302276
* - :manual:`localThresholdMS </reference/connection-string/#mongodb-urioption-urioption.localthresholdms>`
303-
- {+int-data-type+}
304-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'localThresholdMS' => 20 ];``
277+
- | **Data Type**: {+int-data-type+}
278+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'localThresholdMS' => 20 ];``
305279
| **Connection URI Example**: ``localThresholdMS=20``
306280

307281
* - :manual:`serverSelectionTimeoutMS </reference/connection-string/#mongodb-urioption-urioption.serverselectiontimeoutms>`
308-
- {+int-data-type+}
309-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'serverSelectionTimeoutMS' => 40000 ];``
282+
- | **Data Type**: {+int-data-type+}
283+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'serverSelectionTimeoutMS' => 40000 ];``
310284
| **Connection URI Example**: ``serverSelectionTimeoutMS=40000``
311285

312286
* - :manual:`serverSelectionTryOnce </reference/connection-string/#mongodb-urioption-urioption.serverselectiontryonce>`
313-
- {+bool-data-type+}
314-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'serverSelectionTryOnce' => false ];``
287+
- | **Data Type**: {+bool-data-type+}
288+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'serverSelectionTryOnce' => false ];``
315289
| **Connection URI Example**: ``serverSelectionTryOnce=false``
316290

317291
* - :manual:`heartbeatFrequencyMS </reference/connection-string/#mongodb-urioption-urioption.heartbeatfrequencyms>`
318-
- {+int-data-type+}
319-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'heartbeatFrequencyMS' => 50000 ];``
292+
- | **Data Type**: {+int-data-type+}
293+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'heartbeatFrequencyMS' => 50000 ];``
320294
| **Connection URI Example**: ``heartbeatFrequencyMS=50000``
321295

322296
* - :manual:`socketCheckIntervalMS </reference/connection-string/#mongodb-urioption-urioption.socketcheckintervalms>`
323-
- {+int-data-type+}
324-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'socketCheckIntervalMS' => 4000 ];``
297+
- | **Data Type**: {+int-data-type+}
298+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'socketCheckIntervalMS' => 4000 ];``
325299
| **Connection URI Example**: ``socketCheckIntervalMS=4000``
326300

327301
Miscellaneous Configuration
@@ -332,32 +306,31 @@ Miscellaneous Configuration
332306
:stub-columns: 1
333307

334308
* - Connection Option
335-
- Data Type
336-
- Syntax
309+
- Description
337310

338311
* - :manual:`appName </reference/connection-string/#mongodb-urioption-urioption.appname>`
339-
- {+string-data-type+}
340-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'appName' => 'myApp' ];``
312+
- | **Data Type**: {+string-data-type+}
313+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'appName' => 'myApp' ];``
341314
| **Connection URI Example**: ``appName=myApp``
342315

343316
* - :manual:`retryReads </reference/connection-string/#mongodb-urioption-urioption.retryreads>`
344-
- {+bool-data-type+}
345-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'retryReads' => false ];``
317+
- | **Data Type**: {+bool-data-type+}
318+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'retryReads' => false ];``
346319
| **Connection URI Example**: ``retryReads=false``
347320

348321
* - :manual:`retryWrites </reference/connection-string/#mongodb-urioption-urioption.retrywrites>`
349-
- {+bool-data-type+}
350-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'retryWrites' => false ];``
322+
- | **Data Type**: {+bool-data-type+}
323+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'retryWrites' => false ];``
351324
| **Connection URI Example**: ``retryWrites=false``
352325

353326
* - :manual:`loadBalanced </reference/connection-string/#mongodb-urioption-urioption.loadbalanced>`
354-
- {+bool-data-type+}
355-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'loadBalanced' => true ];``
327+
- | **Data Type**: {+bool-data-type+}
328+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'loadBalanced' => true ];``
356329
| **Connection URI Example**: ``loadBalanced=false``
357330

358331
* - :manual:`srvMaxHosts </reference/connection-string/#mongodb-urioption-urioption.srvmaxhosts>`
359-
- {+int-data-type+}
360-
- | **MongoDB\\Client Example**: ``$uriOptions = [ 'srvMaxHosts' => 5 ];``
332+
- | **Data Type**: {+int-data-type+}
333+
| **MongoDB\\Client Example**: ``$uriOptions = [ 'srvMaxHosts' => 5 ];``
361334
| **Connection URI Example**: ``srvMaxHosts=5``
362335

363336
API Documentation

0 commit comments

Comments
 (0)