Skip to content

Commit a460fec

Browse files
authored
DOCSP-26498 - Standardize MongoDB Server Naming (#399)
1 parent b9dfe26 commit a460fec

20 files changed

+76
-71
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ driver-long = "MongoDB Java Driver"
2121
driver-short = "Java Driver"
2222
version = "4.9"
2323
full-version = "{+version+}.1"
24-
mdb-server = "MongoDB server"
24+
mdb-server = "MongoDB Server"
2525
package-name-org = "mongodb-org"
2626
api = "https://mongodb.github.io/mongo-java-driver/{+version+}"
2727
stable-api = "Stable API"

source/fundamentals/aggregation-expression-operations.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ that is both more compact and more naturally readable.
2323
The operations in this guide use methods from the
2424
`com.mongodb.client.model.mql <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/mql/package-summary.html>`__ package.
2525
These methods provide an idiomatic way to use the Query API,
26-
the mechanism by which the driver interacts with the {+mdb-server+}. To learn more
26+
the mechanism by which the driver interacts with a MongoDB deployment. To learn more
2727
about the Query API, see the :manual:`Server manual documentation </query-api/>`.
2828

2929
How to Use Operations

source/fundamentals/auth.txt

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Overview
1919

2020
In this guide, you can learn how to authenticate with MongoDB using each
2121
**authentication mechanism** available in the MongoDB Community Edition.
22-
Authentication mechanisms are processes by which the driver and server
22+
Authentication mechanisms are processes by which the driver and MongoDB deployment
2323
confirm identity and establish trust to ensure security.
2424

2525
The mechanisms that you can use with the latest version of MongoDB Community
@@ -51,23 +51,24 @@ Default
5151
~~~~~~~
5252

5353
The default authentication mechanism setting uses one of the following
54-
authentication mechanisms depending on what your MongoDB server supports:
54+
authentication mechanisms depending on what your version of {+mdb-server+}
55+
supports:
5556

5657
#. ``SCRAM-SHA-256``
5758
#. ``SCRAM-SHA-1``
5859
#. ``MONGODB-CR``
5960

6061
Server versions 3.6 and earlier use ``MONGODB-CR`` as the default
61-
mechanism. Newer versions of the server use one of the mechanisms for
62+
mechanism. Newer versions of {+mdb-server+} use one of the mechanisms for
6263
which they advertise support.
6364

6465
The following code snippets show how to specify the authentication mechanism,
6566
using the following placeholders:
6667

6768
* ``username`` - your MongoDB username
6869
* ``password`` - your MongoDB user's password
69-
* ``hostname`` - network address of your MongoDB server, accessible by your client
70-
* ``port`` - port number of your MongoDB server
70+
* ``hostname`` - network address of your MongoDB deployment, accessible by your client
71+
* ``port`` - port number of your MongoDB deployment
7172
* ``authenticationDb`` - MongoDB database that contains your user's
7273
authentication data. If you omit this parameter, the driver uses the
7374
default value ``admin``.
@@ -102,7 +103,8 @@ mechanism:
102103

103104
For more information on the challenge-response (CR) and salted
104105
challenge-response authentication mechanisms (SCRAM) that MongoDB supports,
105-
see the :manual:`SCRAM </core/security-scram/>` section of the server manual.
106+
see the :manual:`SCRAM </core/security-scram/>` section of the {+mdb-server+}
107+
manual.
106108

107109
.. _scram-sha-256-auth-mechanism:
108110

@@ -123,8 +125,8 @@ using the following placeholders:
123125

124126
* ``username`` - your MongoDB username.
125127
* ``password`` - your MongoDB user's password.
126-
* ``hostname`` - network address of your MongoDB server, accessible by your client.
127-
* ``port`` - port number of your MongoDB server.
128+
* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
129+
* ``port`` - port number of your MongoDB deployment.
128130
* ``authenticationDb`` - MongoDB database that contains your user's
129131
authentication data. If you omit this parameter, the driver uses the
130132
default value ``admin``.
@@ -175,8 +177,8 @@ using the following placeholders:
175177

176178
* ``username`` - your MongoDB username.
177179
* ``password`` - your MongoDB user's password.
178-
* ``hostname`` - network address of your MongoDB server, accessible by your client.
179-
* ``port`` - port number of your MongoDB server.
180+
* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
181+
* ``port`` - port number of your MongoDB deployment.
180182
* ``authenticationDb`` - MongoDB database that contains your user's
181183
authentication data. If you omit this parameter, the driver uses the
182184
default value ``admin``.
@@ -509,8 +511,8 @@ the subject name of the client certificate.
509511
The following code snippets show how to specify the authentication mechanism,
510512
using the following placeholders:
511513

512-
* ``hostname`` - network address of your MongoDB server, accessible by your client.
513-
* ``port`` - port number of your MongoDB server.
514+
* ``hostname`` - network address of your MongoDB deployment, accessible by your client.
515+
* ``port`` - port number of your MongoDB deployment.
514516
* ``authenticationDb`` - MongoDB database that contains your user's
515517
authentication data. If you omit this parameter, the driver uses the
516518
default value ``admin``.

source/fundamentals/connection/connect.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ method. Chain the ``applyConnectionString()`` method to the builder to specify y
9797
connection URI.
9898

9999
You can set the {+stable-api+} version client option to avoid
100-
breaking changes when you upgrade to a new server version. To
100+
breaking changes when you upgrade to a new version of {+mdb-server+}. To
101101
learn more about the {+stable-api+} feature, see the :ref:`{+stable-api+} page
102102
<stable-api-java>`.
103103

@@ -114,18 +114,18 @@ deployment on Atlas and verify that the connection is successful:
114114
Other Ways to Connect to MongoDB
115115
--------------------------------
116116

117-
If you are connecting to a single MongoDB server instance or replica set
117+
If you are connecting to a single MongoDB deployment or replica set
118118
that is not hosted on Atlas, see the following sections to find out how to
119119
connect.
120120

121121
.. _connect-local-java-driver:
122122

123-
Connect to a MongoDB Server on Your Local Machine
124-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123+
Connect to a MongoDB Deployment on Your Local Machine
124+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125125

126126
.. include:: /includes/fundamentals/localhost-connection.rst
127127

128-
To test whether you can connect to your server, replace the connection
128+
To test whether you can connect to your deployment, replace the connection
129129
string in the :ref:`Connect to MongoDB Atlas <connect-atlas-java-driver>` code
130130
example and run it.
131131

source/fundamentals/connection/mongoclientsettings.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ settings to modify the driver's behavior:
234234
- Uses the cluster settings specified in a ``ClusterSettings`` object.
235235

236236
* - ``hosts()``
237-
- Sets all the specified locations of a Mongo server.
237+
- Sets all the specified locations of a Mongo deployment.
238238

239239
* - ``localThreshold()``
240240
- | Sets the amount of time that a server’s round trip can take and still
@@ -243,7 +243,7 @@ settings to modify the driver's behavior:
243243
| **Default**: ``15 milliseconds``
244244

245245
* - ``mode()``
246-
- Sets how to connect to a MongoDB server.
246+
- Sets how to connect to a MongoDB deployment.
247247

248248
* - ``requiredClusterType()``
249249
- Sets the type of cluster required for the cluster.
@@ -434,7 +434,7 @@ Server Settings
434434

435435
Chain the `applyToServerSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToServerSettings(com.mongodb.Block)>`__
436436
method to modify the driver's behavior when monitoring each MongoDB
437-
server.
437+
deployment.
438438

439439
The following table describes the methods you can chain to your
440440
settings to modify the driver's behavior:
@@ -471,7 +471,7 @@ settings to modify the driver's behavior:
471471
Example
472472
~~~~~~~
473473

474-
This example specifies the following driver behavior in a MongoDB server:
474+
This example specifies the following driver behavior in a MongoDB deployment:
475475

476476
- The minimum interval for server monitoring checks to be at least
477477
``700 MILLISECONDS``
@@ -491,7 +491,7 @@ Socket Settings
491491

492492
Chain the `applyToSocketSettings() <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.Builder.html#applyToSocketSettings(com.mongodb.Block)>`__
493493
method to modify the driver's behavior when connecting and communicating
494-
with your MongoDB server.
494+
with your MongoDB deployment.
495495

496496
The following table describes the methods you can chain to your settings
497497
to modify the driver's behavior:

source/fundamentals/connection/tls.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ genuine and secure from tampering by third parties.
144144

145145
An application that initiates TLS/SSL requests needs to set two JVM system
146146
properties to ensure that the client presents a TLS/SSL certificate to
147-
the MongoDB server:
147+
the MongoDB deployment:
148148

149149
- ``javax.net.ssl.keyStore``: the path to a key store containing the client's
150150
TLS/SSL certificates

source/fundamentals/crud/read-operations/change-streams.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ To open a change stream, call the ``watch()`` method on an instance of a
4646

4747
Standalone MongoDB deployments don't support change streams because
4848
the feature requires a replica set oplog. To learn more about the oplog,
49-
see the :ref:`<replica-set-oplog>` server manual page.
49+
see the :ref:`<replica-set-oplog>` {+mdb-server+} manual page.
5050

5151
The object on which you call the ``watch()`` method on determines the scope of
5252
events that the change stream listens for.
@@ -151,7 +151,7 @@ must connect to a MongoDB v6.0 or later deployment and set up the following:
151151

152152
To learn how to enable these on your deployment, see the
153153
:manual:`Change Streams with Document Pre- and Post-Images </changeStreams/#change-streams-with-document-pre--and-post-images>`
154-
MongoDB server manual page.
154+
{+mdb-server+} manual page.
155155

156156
To learn how to instruct the driver to create a collection with pre-images
157157
and post-images enabled, see the :ref:`<java-change-stream-pre-post-collection>`
@@ -186,7 +186,7 @@ and call the ``createCollection()`` method as shown in the following example:
186186
You can change the pre-image and post-image option in an existing collection
187187
by running the ``collMod`` command from the MongoDB Shell. To learn how to
188188
perform this operation, see the :manual:`collMod </reference/command/collMod#change-streams-with-document-pre--and-post-images>`
189-
server manual documentation.
189+
{+mdb-server+} manual.
190190

191191
.. warning::
192192

@@ -211,7 +211,7 @@ include the pre-image and output the results:
211211
The preceding example configures the change stream to use the
212212
``FullDocumentBeforeChange.REQUIRED`` option. This configures the change
213213
stream to return pre-images for replace, update, and delete change events and
214-
for the server to raise an error if the pre-image is unavailable.
214+
for the MongoDB deployment to raise an error if the pre-image is unavailable.
215215

216216
Suppose an application updated the ``latestVersion`` field of a document in a
217217
collection of software library dependencies from the value of ``2.0.0`` to

source/fundamentals/crud/read-operations/cursor.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ to see by setting parameters through methods.
4141
Terminal Methods
4242
----------------
4343

44-
Terminal methods execute an operation on the MongoDB server after
44+
Terminal methods execute an operation on the MongoDB deployment after
4545
configuring all parameters of an ``Iterable`` instance controlling the
4646
operation.
4747

@@ -212,9 +212,9 @@ Cursor Cleanup
212212
Close
213213
~~~~~
214214

215-
Use the ``close()`` method in a finally block to free up a cursor's
215+
Use the ``close()`` method in a ``finally`` block to free up a cursor's
216216
consumption of resources in both the client application and the MongoDB
217-
server:
217+
deployment:
218218

219219
.. literalinclude:: /includes/fundamentals/code-snippets/Cursor.java
220220
:language: java
@@ -227,7 +227,7 @@ Try with Resources Statement
227227

228228
Use a try-with-resources statement
229229
to automatically free up a cursor's consumption of resources in both the
230-
client application and the MongoDB server:
230+
client application and the MongoDB deployment:
231231

232232
.. literalinclude:: /includes/fundamentals/code-snippets/Cursor.java
233233
:language: java

source/fundamentals/crud/read-operations/geo.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ For more information on the ``Indexes`` builder, see our
134134
:doc:`guide on the Indexes builder </fundamentals/builders/indexes>`.
135135

136136
For more information on legacy coordinate pairs, see the
137-
:manual:`MongoDB server manual page on legacy coordinate pairs </geospatial-queries/#legacy-coordinate-pairs>`.
137+
:manual:`{+mdb-server+} manual page on legacy coordinate pairs </geospatial-queries/#legacy-coordinate-pairs>`.
138138

139139
.. external resource
140140

@@ -301,6 +301,6 @@ For more information on the ``$geoWithin`` operator, see the
301301
.. external resource
302302

303303
For more information on the operators you can use in your query, see the
304-
:manual:`MongoDB server manual page on geospatial query operators </geospatial-queries/index.html>`
304+
:manual:`{+mdb-server+} manual page on geospatial query operators </geospatial-queries/index.html>`
305305

306306
.. external resource

source/fundamentals/crud/read-operations/retrieve.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ After the owner runs the aggregation, they find that "green" is the most
134134
purchased color.
135135

136136
For more information on how to construct an aggregation pipeline, see
137-
the MongoDB server manual page on :manual:`Aggregation </aggregation>`.
137+
the {+mdb-server+} manual page on :manual:`Aggregation </aggregation>`.
138138

139139
For additional information on the methods mentioned on this page, see
140140
the following API Documentation:

0 commit comments

Comments
 (0)