Skip to content

Commit d2763fb

Browse files
committed
index updates
1 parent 13a57a6 commit d2763fb

File tree

9 files changed

+127
-87
lines changed

9 files changed

+127
-87
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ toc_landing_pages = [
1414
"/builders",
1515
"/data-formats",
1616
"/references",
17+
"/logging-monitoring",
1718
"/api-documentation",
1819
"/security",
1920
"/security/auth"

source/connection/specify-connection-options.txt

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,12 @@ Specify Connection Options
99
Stable API </connection/specify-connection-options/stable-api>
1010
Connection Pools </connection/specify-connection-options/connection-pools>
1111
Cluster Settings </connection/specify-connection-options/cluster-settings>
12+
Server Settings </connection/specify-connection-options/server-settings>
13+
Socket Settings </connection/specify-connection-options/socket-settings>
1214
Configure Client-level CRUD Settings </connection/specify-connection-options/configure-crud>
1315
Network Compression </connection/specify-connection-options/network-compression>
1416
JNDI Datasource </connection/specify-connection-options/jndi>
15-
AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
16-
Connection Security Settings </connection/specify-connection-options/security-connection-options>
17+
AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/
1718

1819
.. facet::
1920
:name: genre
@@ -27,4 +28,22 @@ Overview
2728

2829
This section describes the MongoDB connection and authentication options
2930
available in the {+driver-short+}. You can specify connection options in the
30-
following ways:
31+
following ways:
32+
33+
Security and Authentication
34+
---------------------------
35+
36+
MongoDB supports many options for securing your data before and during
37+
transportation. For information about security options, see the :ref:`Security
38+
section <java-security>`, which includes the following:
39+
40+
.. include:: /includes/security/security-pages.rst
41+
42+
Logging and Monitoring
43+
----------------------
44+
45+
You can learn how to using logging and monitoring with the {+driver-short+} in
46+
the :ref:`Logging and Monitoring section <java-logging-monitoring>`, which
47+
includes the following:
48+
49+
.. include:: /includes/security/logging-monitoring-pages.rst

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

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -37,45 +37,45 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
3737

3838
.. list-table::
3939
:header-rows: 1
40-
:widths: 20,20,60
40+
:widths: 25,20,60
4141

4242
* - Option Name
4343
- Type
4444
- Description
4545

46-
* - **serverSelectionTimeoutMS**
46+
* - ``serverSelectionTimeoutMS``
4747
- integer
4848
- Specifies the maximum amount of time, in milliseconds, the driver
4949
will wait for server selection to succeed before throwing an
5050
exception.
5151

52-
**Default**: ``30000`` (30 seconds)
52+
*Default*: ``30000`` (30 seconds)
5353

54-
* - **localThresholdMS**
54+
* - ``localThresholdMS``
5555
- integer
5656
- When communicating with multiple instances of MongoDB in a replica
5757
set, the driver will only send requests to a server whose response
5858
time is less than or equal to the server with the fastest response
5959
time plus the local threshold, in milliseconds.
6060

61-
**Default**: ``15``
62-
* - **replicaSet**
61+
*Default*: ``15``
62+
* - ``replicaSet``
6363
- string
6464
- Specifies that the :ref:`connection string <connection-uri>`
6565
provided includes multiple hosts. When specified, the driver
6666
attempts to find all members of that set.
6767

68-
**Default**: ``null``
68+
*Default*: ``null``
6969

70-
* - **directConnection**
70+
* - ``directConnection``
7171
- boolean
7272
- Specifies that the driver must connect to the host directly. This
7373
maps to applying ``mode(ClusterConnectionMode.SINGLE)`` to your
7474
``MongoClientSettings``.
7575

76-
**Default**: ``false``
76+
*Default*: ``false``
7777

78-
* - **srvServiceName**
78+
* - ``srvServiceName``
7979
- string
8080
- Specifies the service name of the `SRV resource records
8181
<https://www.rfc-editor.org/rfc/rfc2782>`__ the driver retrieves to
@@ -85,7 +85,7 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
8585
</reference/connection-string/#dns-seed-list-connection-format>` in
8686
your :ref:`connection URI <connection-uri>` to use this option.
8787

88-
**Default**: ``mongodb``
88+
*Default*: ``mongodb``
8989

9090
This example connects the driver directly to a server,
9191
regardless of the type of MongoDB cluster it's a part of:
@@ -132,9 +132,9 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
132132

133133
* - ``localThreshold()``
134134
- Sets the amount of time that a server’s round trip can take and
135-
still be eligible for server selection.
135+
still be eligible for server selection.
136136

137-
**Default**: ``15 milliseconds``
137+
*Default*: ``15 milliseconds``
138138

139139
* - ``mode()``
140140
- Sets how to connect to a MongoDB deployment.
@@ -149,7 +149,7 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
149149
- Sets the maximum time to select a primary node before throwing a
150150
timeout exception.
151151

152-
**Default**: ``30 seconds``
152+
*Default*: ``30 seconds``
153153

154154
* - ``serverSelector()``
155155
- Adds a server selector to apply before server selection.
@@ -170,8 +170,8 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
170170

171171
* - ``srvMaxHosts()``
172172
- Sets the maximum number of hosts the driver can connect to when
173-
using the DNS seedlist (SRV) connection protocol, identified by
174-
the ``mongodb+srv`` connection string prefix.
173+
using the DNS seedlist (SRV) connection protocol, identified by
174+
the ``mongodb+srv`` connection string prefix.
175175

176176
Throws an exception if you are not using the SRV connection protocol.
177177

@@ -187,10 +187,12 @@ String` or :guilabel:`MongoClientSettings` tab to see the options available:
187187

188188
.. tip::
189189

190-
This is analogous to the ``directConnection`` parameter you can specify
191-
in your connection URI. See :ref:`<connection-options>` for more
192-
information.
190+
This is analogous to the ``directConnection`` parameter you can specify
191+
in your connection URI. See :ref:`<connection-options>` for more
192+
information.
193193

194-
For more information, see the `MongoClientSettings.Builder
194+
For more information about the chained methods, see the `MongoClientSettings.Builder
195195
<{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__
196-
API documentation.
196+
API documentation.
197+
198+

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

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -44,54 +44,54 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
4444

4545
.. list-table::
4646
:header-rows: 1
47-
:widths: 20,20,60
47+
:widths: 25,20,60
4848

4949
* - Option Name
5050
- Type
5151
- Description
5252

53-
* - **journal**
53+
* - ``journal``
5454
- boolean
5555
- Specifies that the driver must wait for the connected MongoDB instance to group commit to the journal file on disk for all writes.
5656

57-
**Default**: ``false``
57+
*Default*: ``false``
5858

59-
* - **w**
59+
* - ``w``
6060
- string or integer
6161
- Specifies the write concern. For more information about values, see
6262
the server documentation for the :manual:`w option
6363
</reference/write-concern/#w-option>`.
6464

65-
**Default**: ``1``
65+
*Default*: ``1``
6666

67-
* - **wtimeoutMS**
67+
* - ``wtimeoutMS``
6868
- integer
6969
- Specifies a time limit, in milliseconds, for the write concern. For
7070
more information, see the server documentation for the
7171
:manual:`wtimeoutMS option
7272
</reference/connection-string/#write-concern-options>`. A value of
7373
``0`` instructs the driver to never time out write operations.
7474

75-
**Default**: ``0``
75+
*Default*: ``0``
7676

77-
* - **readPreference**
77+
* - ``readPreference``
7878
- string
7979
- Specifies the read preference. For more information about values, see
8080
the server documentation for the :manual:`readPreference option
8181
</reference/connection-string/#urioption.readPreference>`.
8282

83-
**Default**: ``primary``
83+
*Default*: ``primary``
8484

85-
* - **readPreferenceTags**
85+
* - ``readPreferenceTags``
8686
- string
8787
- Specifies the read preference tags. For more information about
8888
values, see the server documentation for the
8989
:manual:`readPreferenceTags option
9090
</reference/connection-string/#urioption.readPreferenceTags>`.
9191

92-
**Default**: ``null``
92+
*Default*: ``null``
9393

94-
* - **maxStalenessSeconds**
94+
* - ``maxStalenessSeconds``
9595
- integer
9696
- Specifies, in seconds, how stale a secondary can be before the driver
9797
stops communicating with that secondary. The minimum value is either
@@ -102,30 +102,30 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
102102
providing a parameter or explicitly specifying ``-1`` indicates that
103103
there must be no staleness check for secondaries.
104104

105-
**Default**: ``-1``
105+
*Default*: ``-1``
106106

107-
* - **uuidRepresentation**
107+
* - ``uuidRepresentation``
108108
- string
109109
- Specifies the UUID representation to use for read and write
110110
operations. For more information, see the driver documentation for
111111
the `MongoClientSettings.getUuidRepresentation() method
112112
<{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html#getUuidRepresentation()>`__.
113113

114-
**Default**: ``unspecified``
114+
*Default*: ``unspecified``
115115

116-
* - **retryWrites**
116+
* - ``retryWrites``
117117
- boolean
118118
- Specifies that the driver must retry supported write operations if
119119
they are unable to complete due to a network error.
120120

121-
**Default**: ``true``
121+
*Default*: ``true``
122122

123-
* - **retryReads**
123+
* - ``retryReads``
124124
- boolean
125125
- Specifies that the driver must retry supported read operations if
126126
they are unable to complete due to a network error.
127127

128-
**Default**: ``true``
128+
*Default*: ``true``
129129

130130
The following example sets the read preference to read from the nearest
131131
replica set member:
@@ -145,7 +145,6 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
145145
Chain the following methods to your ``MongoClientSettings`` constructor to modify the driver's read/write behavior:
146146

147147
.. list-table::
148-
:header-rows: 1
149148
:stub-columns: 1
150149
:widths: 40 60
151150

@@ -157,19 +156,19 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
157156
* - ``readPreference()``
158157
- Sets the :manual:`read preference </reference/read-preference/>`
159158

160-
**Default**: ``primary``
159+
*Default*: ``primary``
161160

162161
* - ``retryReads()``
163162
- Whether the driver performs :manual:`retry reads
164163
</core/retryable-reads/>` if a network error occurs.
165164

166-
**Default**: ``true``
165+
*Default*: ``true``
167166

168167
* - ``retryWrites()``
169168
- Whether the driver performs :manual:`retry writes
170169
</core/retryable-writes/>` if a network error occurs.
171170

172-
**Default**: ``true``
171+
*Default*: ``true``
173172

174173
* - ``uuidRepresentation()``
175174
- Sets the UUID representation to use when encoding instances of UUID
@@ -178,7 +177,7 @@ string <connection-uri>` or by passing a ``MongoClientSettings`` object to the
178177
* - ``writeConcern()``
179178
- Sets the :manual:`write concern </reference/write-concern/>`.
180179

181-
**Default**: ``WriteConcern#ACKNOWLEDGED``.
180+
*Default*: ``WriteConcern#ACKNOWLEDGED``.
182181
| For more information about the default value, see :manual:`Implicit Default Write Concern </reference/write-concern/#implicit-default-write-concern>`.
183182

184183
The following example sets the read preference to read from the nearest

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,30 +68,30 @@ tab to see the corresponding syntax:
6868

6969
.. list-table::
7070
:header-rows: 1
71-
:widths: 20,20,60
71+
:widths: 25,20,60
7272

7373
* - Option Name
7474
- Type
7575
- Description
7676

77-
* - **compressors**
77+
* - ``compressors``
7878
- string
7979
- Specifies one or more compression algorithms that the driver will
8080
attempt to use to compress requests sent to the connected MongoDB
8181
instance. Possible values include: ``zlib``, ``snappy``, and
8282
``zstd``.
8383

84-
**Default**: ``null``
84+
*Default*: ``null``
8585

86-
* - **zlibCompressionLevel**
86+
* - ``zlibCompressionLevel``
8787
- integer
8888
- Specifies the degree of compression that `Zlib <https://zlib.net/>`__
8989
uses to decrease the size of requests to the connected MongoDB
9090
instance. The level can range from ``-1`` to ``9``, with lower values
9191
compressing faster (but resulting in larger requests) and larger
9292
values compressing slower (but resulting in smaller requests).
9393

94-
**Default**: ``null``
94+
*Default*: ``null``
9595

9696
The following specifies the order in which the driver will attempt to
9797
compress requests before they are sent:
@@ -125,7 +125,9 @@ tab to see the corresponding syntax:
125125
:end-before: end-specify-client-settings
126126
:language: java
127127

128-
For more information, see the `MongoClientSettings.Builder <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__ API documentation.
128+
For more information about the chained methods, see the `MongoClientSettings.Builder
129+
<{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__
130+
API documentation.
129131

130132
.. _java-compression-dependencies:
131133

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Configuring Server Settings
3333

3434
.. list-table::
3535
:header-rows: 1
36-
:widths: 20,20,60
36+
:widths: 25,20,60
3737

3838
* - Option Name
3939
- Type
@@ -119,12 +119,14 @@ Configuring Server Settings
119119
- The cluster monitor to attempt reaching a server every ``15 SECONDS``
120120

121121
.. literalinclude:: /includes/fundamentals/code-snippets/MCSettings.java
122-
:start-after: begin ServerSettings
123-
:end-before: end ServerSettings
124-
:language: java
125-
:emphasize-lines: 3-5
126-
:dedent:
122+
:start-after: begin ServerSettings
123+
:end-before: end ServerSettings
124+
:language: java
125+
:emphasize-lines: 3-5
126+
:dedent:
127127

128-
For more information, see the `MongoClientSettings.Builder
128+
For more information about the chained methods, see the `MongoClientSettings.Builder
129129
<{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html>`__
130130
API documentation.
131+
132+

0 commit comments

Comments
 (0)