Skip to content

Commit d3b41b1

Browse files
committed
options
1 parent 2f5d92b commit d3b41b1

File tree

6 files changed

+8
-144
lines changed

6 files changed

+8
-144
lines changed

snooty.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ intersphinx = [
77
]
88

99
toc_landing_pages = [
10-
"/get-started",
1110
"/connection",
1211
"/connection/specify-connection-options",
1312
"/crud",

source/connection/mongoclient.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ Use the ``MongoClients.create()`` method to construct a ``MongoClient``.
4545
``MongoClient`` instances.
4646

4747
To learn about the different settings you can use to control the
48-
behavior of your ``MongoClient``, see the guide on
49-
:ref:`MongoClient Settings <specify-mongoclient-settings>`.
48+
behavior of your ``MongoClient``, see the
49+
:ref:`Specify MongoClient Settings <specify-mongoclient-settings>` guide.
5050

5151
.. tip::
5252

source/connection/specify-connection-options/connection-options.txt

Lines changed: 0 additions & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -17,92 +17,6 @@ parameters of the connection URI to specify the behavior of the client.
1717
- Type
1818
- Description
1919

20-
.. * - **minPoolSize**
21-
.. - integer
22-
.. - Specifies the minimum number of connections that must exist at
23-
.. any moment in a single connection pool.
24-
25-
.. | **Default**: ``0``
26-
27-
.. * - **maxPoolSize**
28-
.. - integer
29-
.. - Specifies the maximum number of connections that a connection
30-
.. pool can have at a given time.
31-
32-
.. | **Default**: ``100``
33-
34-
.. * - **waitQueueTimeoutMS**
35-
.. - integer
36-
.. - Specifies the maximum amount of time, in milliseconds that a
37-
.. thread can wait for a connection to become available.
38-
39-
.. | **Default**: ``120000`` (120 seconds)
40-
41-
* - **serverSelectionTimeoutMS**
42-
- integer
43-
- Specifies the maximum amount of time, in milliseconds, the driver
44-
will wait for server selection to succeed before throwing an
45-
exception.
46-
47-
| **Default**: ``30000`` (30 seconds)
48-
49-
* - **localThresholdMS**
50-
- integer
51-
- When communicating with multiple instances of MongoDB in a replica
52-
set, the driver will only send requests to a server whose
53-
response time is less than or equal to the server with the fastest
54-
response time plus the local threshold, in milliseconds.
55-
56-
| **Default**: ``15``
57-
58-
* - **heartbeatFrequencyMS**
59-
- integer
60-
- Specifies the frequency, in milliseconds that the driver will
61-
wait between attempts to determine the current state of each
62-
server in the cluster.
63-
64-
| **Default**: ``10000`` (10 seconds)
65-
66-
* - **replicaSet**
67-
- string
68-
- Specifies that the :ref:`connection string <connection-uri>`
69-
provided includes multiple hosts. When specified, the driver
70-
attempts to find all members of that set.
71-
72-
| **Default**: ``null``
73-
74-
* - **ssl**
75-
- boolean
76-
- Specifies that all communication with MongoDB instances must
77-
use TLS/SSL. Superseded by the **tls** option.
78-
79-
| **Default**: ``false``
80-
81-
* - **tls**
82-
- boolean
83-
- Specifies that all communication with MongoDB instances must
84-
use TLS. Supersedes the **ssl** option.
85-
86-
| **Default**: ``false``
87-
88-
* - **tlsInsecure**
89-
- boolean
90-
- Specifies that the driver must allow invalid hostnames for TLS
91-
connections. Has the same effect as setting
92-
**tlsAllowInvalidHostnames** to ``true``. To configure TLS security
93-
constraints in other ways, use a
94-
:ref:`custom SSLContext <tls-custom-sslContext>`.
95-
96-
| **Default**: ``false``
97-
98-
* - **tlsAllowInvalidHostnames**
99-
- boolean
100-
- Specifies that the driver must allow invalid hostnames in the
101-
certificate for TLS connections. Supersedes
102-
**sslInvalidHostNameAllowed**.
103-
104-
| **Default**: ``false``
105-
10620
* - **connectTimeoutMS**
10721
- integer
10822
- Specifies the maximum amount of time, in milliseconds, the Java
@@ -112,24 +26,6 @@ parameters of the connection URI to specify the behavior of the client.
11226

11327
| **Default**: ``10000`` (10 seconds)
11428

115-
* - **socketTimeoutMS**
116-
- integer
117-
- Specifies the maximum amount of time, in milliseconds, the Java
118-
driver will wait to send or receive a request before timing out.
119-
A value of ``0`` instructs the driver to never time out while waiting
120-
to send or receive a request.
121-
122-
| **Default**: ``0``
123-
124-
.. * - **maxIdleTimeMS**
125-
.. - integer
126-
.. - Specifies the maximum amount of time, in milliseconds, that the driver
127-
.. allows a pooled connection to idle before closing the
128-
.. connection. A value of ``0`` indicates that there is no upper bound
129-
.. on how long the driver allows a pooled connection to be idle.
130-
131-
.. | **Default**: ``0``
132-
13329
* - **maxLifeTimeMS**
13430
- integer
13531
- Specifies the maximum amount of time, in milliseconds, the Java
@@ -253,7 +149,6 @@ parameters of the connection URI to specify the behavior of the client.
253149

254150
| **Default**: ``true``
255151

256-
257152
* - **retryReads**
258153
- boolean
259154
- Specifies that the driver must retry supported read operations
@@ -279,33 +174,6 @@ parameters of the connection URI to specify the behavior of the client.
279174

280175
| **Default**: ``unspecified``
281176

282-
* - **directConnection**
283-
- boolean
284-
- Specifies that the driver must connect to the host directly.
285-
286-
| **Default**: ``false``
287-
288-
.. * - **maxConnecting**
289-
.. - integer
290-
.. - Specifies the maximum number of connections a pool can establish
291-
.. concurrently.
292-
293-
.. | **Default**: ``2``
294-
295-
* - **srvServiceName**
296-
- string
297-
- Specifies the service name of the
298-
`SRV resource records <https://www.rfc-editor.org/rfc/rfc2782>`__
299-
the driver retrieves to construct your
300-
:manual:`seed list </reference/glossary/#std-term-seed-list>`.
301-
You must use the
302-
:manual:`DNS Seed List Connection Format </reference/connection-string/#dns-seed-list-connection-format>`
303-
in your
304-
:ref:`connection URI <connection-uri>`
305-
to use this option.
306-
307-
| **Default**: ``mongodb``
308-
309177
* - **proxyHost**
310178
- string
311179
- Specifies the SOCKS5 proxy IPv4 address, IPv6 address, or hostname.

source/connection/specify-connection-options/connection-pools.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.. _java-connection-pools:
2+
.. _connection-pools:
23
.. _mcs-connectionpool-settings:
34

45
================

source/connection/specify-connection-options/socket-settings.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,11 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
3737
- Type
3838
- Description
3939

40-
* -
40+
* - **socketTimeoutMS**
41+
- integer
42+
- | Specifies the maximum amount of time, in milliseconds, the Java driver will wait to send or receive a request before timing out. A value of ``0`` instructs the driver to never time out while waiting to send or receive a request.
43+
|
44+
| **Default**: ``0``
4145

4246
.. tab:: Connection String
4347
:tabid: uri

source/get-started.txt

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,6 @@ Get Started with the Java Driver
1212
:description: Learn how to create an app to connect to MongoDB deployment by using the {+driver-short+}.
1313
:keywords: quick start, tutorial, basics
1414

15-
.. toctree::
16-
17-
Download & Install </get-started/download-and-install/>
18-
Create a Deployment </get-started/create-deployment/>
19-
Create a Connection String </get-started/connection-string/>
20-
Connect to MongoDB </get-started/connect-to-mongodb/>
21-
Next Steps </get-started/next-steps/>
22-
2315
Overview
2416
--------
2517

0 commit comments

Comments
 (0)