Skip to content

Commit 7046a65

Browse files
DOCSP-50017 Remove EOL versions (#220) (#221)
* DOCSP-50017 Remove EOL versions * auth * auth suggestion NR * NR comments * get rid of font on headings (cherry picked from commit 94fd075) Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com>
1 parent cfbc38f commit 7046a65

File tree

12 files changed

+38
-204
lines changed

12 files changed

+38
-204
lines changed

source/fundamentals/auth.txt

Lines changed: 20 additions & 124 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,7 @@ confirm identity and establish trust to ensure security.
2626
The mechanisms that you can use with the latest version of MongoDB Community
2727
Edition are as follows:
2828

29-
* :ref:`Default <default-auth-mechanism>`
3029
* :ref:`SCRAM-SHA-256 <scram-sha-256-auth-mechanism>`
31-
* :ref:`SCRAM-SHA-1 <scram-sha-1-auth-mechanism>`
32-
* :ref:`MONGODB-CR <mongodb-cr-auth-mechanism>`
3330
* :ref:`MONGODB-AWS <mongodb-aws-auth-mechanism>`
3431
* :ref:`X.509 <x509-auth-mechanism>`
3532

@@ -48,38 +45,31 @@ Mechanisms
4845
----------
4946

5047
.. _default-auth-mechanism:
48+
.. _scram-sha-256-auth-mechanism:
5149

52-
Default
53-
~~~~~~~
54-
55-
The default authentication mechanism setting uses one of the following
56-
authentication mechanisms depending on what your MongoDB server supports:
57-
58-
#. ``SCRAM-SHA-256``
59-
#. ``SCRAM-SHA-1``
60-
#. ``MONGODB-CR``
50+
SCRAM-SHA-256
51+
~~~~~~~~~~~~~
6152

62-
Server versions 3.6 and earlier use ``MONGODB-CR`` as the default
63-
mechanism. Newer versions of the server use one of the mechanisms for
64-
which they advertise support.
53+
``SCRAM-SHA-256`` is a salted challenge-response authentication mechanism
54+
(SCRAM) that uses your username and password, encrypted with the ``SHA-256``
55+
algorithm, to authenticate your user. This is the default authentication
56+
mechanism.
6557

6658
The following code snippets show how to specify the authentication mechanism,
6759
using the following placeholders:
6860

69-
* ``db_username`` - your MongoDB database username
70-
* ``db_password`` - your MongoDB database user's password
71-
* ``hostname`` - network address of your MongoDB server, accessible by your client
72-
* ``port`` - port number of your MongoDB server
61+
* ``db_username`` - your MongoDB database username.
62+
* ``db_password`` - your MongoDB database user's password.
63+
* ``hostname`` - network address of your MongoDB server, accessible by your client.
64+
* ``port`` - port number of your MongoDB server.
7365
* ``authenticationDb`` - MongoDB database that contains your user's
7466
authentication data. If you omit this parameter, the driver uses the
7567
default value ``admin``.
7668

7769
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
78-
tab below for instructions and sample code for specifying this authentication
70+
tab below for instructions and sample code to specify this default authentication
7971
mechanism:
8072

81-
.. _mongo-client-setting-with-mongo-credential-example:
82-
8373
.. tabs::
8474

8575
.. tab::
@@ -102,38 +92,10 @@ mechanism:
10292
.. literalinclude:: /examples/generated/AuthTest.snippet.default-mongo-cred.kt
10393
:language: kotlin
10494

105-
For more information on the challenge-response (CR) and salted
106-
challenge-response authentication mechanisms (SCRAM) that MongoDB supports,
107-
see the :manual:`SCRAM </core/security-scram/>` section of the Server manual.
108-
109-
.. _scram-sha-256-auth-mechanism:
110-
111-
``SCRAM-SHA-256``
112-
~~~~~~~~~~~~~~~~~
113-
114-
.. note::
115-
116-
``SCRAM-SHA-256`` is the default authentication method for MongoDB starting
117-
in MongoDB 4.0.
118-
119-
``SCRAM-SHA-256`` is a salted challenge-response authentication mechanism
120-
(SCRAM) that uses your username and password, encrypted with the ``SHA-256``
121-
algorithm, to authenticate your user.
122-
123-
The following code snippets show how to specify the authentication mechanism,
124-
using the following placeholders:
125-
126-
* ``db_username`` - your MongoDB database username.
127-
* ``db_password`` - your MongoDB database user's password.
128-
* ``hostname`` - network address of your MongoDB server, accessible by your client.
129-
* ``port`` - port number of your MongoDB server.
130-
* ``authenticationDb`` - MongoDB database that contains your user's
131-
authentication data. If you omit this parameter, the driver uses the
132-
default value ``admin``.
133-
134-
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
135-
tab below for instructions and sample code for specifying this authentication
136-
mechanism:
95+
You can also explicitly specify the ``SCRAM-SHA-256`` authentication mechanism,
96+
as shown in the following code snippets. Select the :guilabel:`Connection String`
97+
or the :guilabel:`MongoCredential` tab below for instructions and sample code for
98+
specifying this authentication mechanism:
13799

138100
.. tabs::
139101

@@ -159,76 +121,10 @@ mechanism:
159121
.. literalinclude:: /examples/generated/AuthTest.snippet.scram-sha-256-cred.kt
160122
:language: kotlin
161123

162-
.. _scram-sha-1-auth-mechanism:
163-
164-
``SCRAM-SHA-1``
165-
~~~~~~~~~~~~~~~
166-
167-
.. note::
168-
``SCRAM-SHA-1`` is the default authentication method for MongoDB versions
169-
3.0, 3.2, 3.4, and 3.6.
170-
171-
``SCRAM-SHA-1`` is a salted challenge-response mechanism (SCRAM) that uses your
172-
username and password, encrypted with the ``SHA-1`` algorithm, to authenticate
173-
your user.
174-
175-
The following code snippets show how to specify the authentication mechanism,
176-
using the following placeholders:
177-
178-
* ``db_username`` - your MongoDB database username.
179-
* ``db_password`` - your MongoDB database user's password.
180-
* ``hostname`` - network address of your MongoDB server, accessible by your client.
181-
* ``port`` - port number of your MongoDB server.
182-
* ``authenticationDb`` - MongoDB database that contains your user's
183-
authentication data. If you omit this parameter, the driver uses the
184-
default value ``admin``.
185-
186-
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
187-
tab below for instructions and sample code for specifying this authentication
188-
mechanism:
189-
190-
.. tabs::
191-
192-
.. tab::
193-
:tabid: Connection String
194-
195-
To specify the ``SCRAM-SHA-1`` authentication mechanism using a
196-
connection string, assign the ``authMechanism`` parameter the value
197-
``SCRAM-SHA-1`` in your connection string. Your code to instantiate
198-
a ``MongoClient`` should resemble the following:
199-
200-
.. literalinclude:: /examples/generated/AuthTest.snippet.scram-sha-1-string.kt
201-
:language: kotlin
202-
203-
.. tab::
204-
:tabid: MongoCredential
205-
206-
To specify the default authentication mechanism using the
207-
``MongoCredential`` class, use the
208-
`createScramSha1Credential() <{+core-api+}/MongoCredential.html#createScramSha1Credential(java.lang.String,java.lang.String,char[])>`__
209-
method. Your code to instantiate a ``MongoClient`` should resemble the following:
210-
211-
.. literalinclude:: /examples/generated/AuthTest.snippet.scram-sha-1-cred.kt
212-
:language: kotlin
213-
214-
.. _mongodb-cr-auth-mechanism:
215-
216-
``MONGODB-CR``
217-
~~~~~~~~~~~~~~
218-
219-
``MONGODB-CR`` is a challenge-response authentication mechanism that uses your
220-
username and password to authenticate your user. This authentication
221-
mechanism was deprecated starting in MongoDB 3.6 and is no longer
222-
supported as of MongoDB 4.0.
223-
224-
You cannot specify this method explicitly; refer to the fallback provided
225-
by the :ref:`default authentication mechanism <default-auth-mechanism>` to
226-
connect using ``MONGODB-CR``.
227-
228124
.. _mongodb-aws-auth-mechanism:
229125

230-
``MONGODB-AWS``
231-
~~~~~~~~~~~~~~~
126+
MONGODB-AWS
127+
~~~~~~~~~~~
232128

233129
.. note::
234130

@@ -451,8 +347,8 @@ method:
451347

452348
.. _x509-auth-mechanism:
453349

454-
``X.509``
455-
~~~~~~~~~
350+
X.509
351+
~~~~~
456352

457353
The ``X.509`` authentication mechanism uses
458354
:wikipedia:`TLS <Transport_Layer_Security>` with X.509 certificates to

source/fundamentals/builders/aggregates.txt

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -870,11 +870,10 @@ Atlas Full-Text Search
870870
Use the ``search()`` method to create a :manual:`$search </reference/operator/aggregation/search/>`
871871
pipeline stage that specifies a full-text search of one or more fields.
872872

873-
.. tip:: Only Available on Atlas for MongoDB v4.2 and later
873+
.. tip:: Only Available on Collections with an Atlas Search Index
874874

875-
This aggregation pipeline operator is only available for collections hosted
876-
on :atlas:`MongoDB Atlas </>` clusters running v4.2 or later that are
877-
covered by an :atlas:`Atlas search index </reference/atlas-search/index-definitions/>`.
875+
This aggregation pipeline operator is only available for collections
876+
with an :atlas:`Atlas search index </reference/atlas-search/index-definitions/>`.
878877
Learn more about the required setup and the functionality of this operator
879878
from the :ref:`Atlas Search <fts-top-ref>` documentation.
880879

@@ -920,13 +919,6 @@ Use the ``searchMeta()`` method to create a
920919
pipeline stage which returns only the metadata part of the results from
921920
Atlas full-text search queries.
922921

923-
.. tip:: Only Available on Atlas for MongoDB v4.4.11 and later
924-
925-
This aggregation pipeline operator is only available
926-
on :atlas:`MongoDB Atlas </>` clusters running v4.4.11 and later. For a
927-
detailed list of version availability, see the MongoDB Atlas documentation
928-
on :atlas:`$searchMeta </atlas-search/query-syntax/#-searchmeta>`.
929-
930922
The following example shows the ``count`` metadata for an Atlas search
931923
aggregation stage:
932924

source/fundamentals/builders/projections.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -230,12 +230,6 @@ When you've specified matching criteria in the **query** portion of your operati
230230
variant to specify a :manual:`positional projection </reference/operator/projection/positional/#sorts-and-the-positional-operator>` to include
231231
the first element of an array. Only documents that match the query filter will be retrieved.
232232

233-
.. important::
234-
235-
In MongoDB version 4.4 and earlier, the specified array field must appear in the query filter. Beginning in MongoDB 4.4,
236-
you can use a positional project on an array field that does not appear in the query filter.
237-
238-
239233
The following example projects the first element of the ``temperatures`` array:
240234

241235
.. io-code-block::

source/fundamentals/connection/network-compression.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ and your application.
1717

1818
The driver supports the following algorithms:
1919

20-
1. `Snappy <https://google.github.io/snappy/>`__: available in MongoDB 3.4 and later.
21-
#. `Zlib <https://zlib.net/>`__: available in MongoDB 3.6 and later.
22-
#. `Zstandard <https://github.com/facebook/zstd/>`__: available in MongoDB 4.2 and later.
20+
1. `Snappy <https://google.github.io/snappy/>`__
21+
#. `Zlib <https://zlib.net/>`__
22+
#. `Zstandard <https://github.com/facebook/zstd/>`__
2323

2424
The driver tests against the following versions of these libraries:
2525

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -320,9 +320,9 @@ The data is modeled with the following Kotlin data class:
320320
OrderScore(id=5, description=one large vanilla and chocolate cake, score=0.6)
321321
OrderScore(id=2, description=two medium vanilla birthday cakes, score=0.6)
322322

323-
.. note:: Text Search Behavior in MongoDB 4.4 or Later
323+
.. note:: Text Search Behavior in MongoDB 6.0 or Later
324324

325-
The structure of text search has changed for MongoDB 4.4 or later. You no
325+
The structure of text search has changed for MongoDB 6.0 or later. You no
326326
longer need to project ``Projections.metaTextScore()`` into your
327327
``FindFlow`` instance in order to sort on the text score. In addition,
328328
the field name you specify in a ``$meta`` text score aggregation operation

source/fundamentals/enterprise-auth.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ to improve performance.
229229
LDAP (PLAIN)
230230
~~~~~~~~~~~~
231231

232-
*Available in MongoDB Enterprise Edition 3.4 and later.*
232+
*Available in MongoDB Enterprise Edition.*
233233

234234
You can authenticate to a Lightweight Directory Access Protocol (LDAP)
235235
server using your directory server username and password.

source/fundamentals/indexes.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,8 @@ your application uses indexes:
9898
operation updates an indexed field, MongoDB updates the related index.
9999

100100
Since MongoDB supports dynamic schemas, applications can query against fields whose names cannot be known in advance or
101-
are arbitrary. MongoDB 4.2 introduced :manual:`wildcard indexes </core/index-wildcard/>` to help support these queries.
102-
Wildcard indexes are not designed to replace workload-based index planning.
101+
are arbitrary with :manual:`wildcard indexes </core/index-wildcard/>`. Wildcard indexes are
102+
not designed to replace workload-based index planning.
103103

104104
For more information on designing your data model and choosing indexes appropriate for your application, see the MongoDB
105105
server documentation on :manual:`Indexing Strategies </applications/indexes>` and
@@ -453,9 +453,8 @@ created in the preceding code snippet:
453453
:language: kotlin
454454

455455
MongoDB also supports ``2d`` indexes for calculating distances on a
456-
Euclidean plane and for working with the "legacy coordinate pairs"
457-
syntax used in MongoDB 2.2 and earlier. To learn more, see
458-
:manual:`Geospatial Queries </geospatial-queries>` in the Server manual.
456+
Euclidean plane. To learn more, see :manual:`Geospatial Queries </geospatial-queries>`
457+
in the Server manual.
459458

460459
Unique Indexes
461460
~~~~~~~~~~~~~~
@@ -588,7 +587,7 @@ The following snippet removes the "title_text" index from the collection:
588587
Remove an Index Using a Wildcard Character
589588
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
590589

591-
Starting with MongoDB 4.2, you can drop all indexes by calling the
590+
You can drop all indexes by calling the
592591
``dropIndexes()`` method on your collection:
593592

594593
.. literalinclude:: /examples/generated/IndexesTest.snippet.drop-all-indexes.kt

source/fundamentals/stable-api.txt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,6 @@
1414
:depth: 1
1515
:class: singlecol
1616

17-
.. note::
18-
19-
The {+stable-api+} feature requires MongoDB Server 5.0 or later.
20-
21-
You should only use the {+stable-api+} feature if all the MongoDB
22-
servers you are connecting to support this feature.
23-
2417
Overview
2518
--------
2619

source/fundamentals/time-series.txt

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,6 @@ method:
5353
.. literalinclude:: /examples/generated/TimeSeriesTest.snippet.create-time-series-collection.kt
5454
:language: kotlin
5555

56-
.. important::
57-
58-
Versions prior to MongoDB 5.0 cannot create a time series collection.
59-
6056
To check if you successfully created the collection, send the
6157
``"listCollections"`` command to the `runCommand() <{+driver-api+}/-mongo-database/run-command.html>`__ method.
6258

@@ -93,8 +89,7 @@ and :ref:`aggregating data <kotlin-aggregation>`.
9389

9490
.. note:: Window Functions
9591

96-
MongoDB version 5.0 introduces window functions into the aggregation
97-
pipeline. You can use window functions to perform operations on a
92+
You can use window functions to perform operations on a
9893
contiguous span of time series data.
9994

10095
For more information, see our

source/includes/mongodb-compatibility-table-kotlin.rst

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,38 +7,13 @@
77
- MongoDB 8.0
88
- MongoDB 7.0
99
- MongoDB 6.0
10-
- MongoDB 5.0
11-
- MongoDB 4.4
12-
- MongoDB 4.2
13-
- MongoDB 4.0
14-
- MongoDB 3.6
1510

16-
* - 5.5
11+
* - 5.2 to 5.5
1712
- ✓
1813
- ✓
1914
- ✓
20-
- ✓
21-
- ✓
22-
- ✓
23-
-
24-
-
25-
26-
* - 5.2 to 5.4
27-
- ✓
28-
- ✓
29-
- ✓
30-
- ✓
31-
- ✓
32-
- ✓
33-
- ✓
34-
-
3515

3616
* - 4.10 to 5.1
3717
- ⊛
3818
- ✓
3919
- ✓
40-
- ✓
41-
- ✓
42-
- ✓
43-
- ✓
44-
- ✓

source/usage-examples/bulkWrite.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,8 @@ The ``bulkWrite()`` method accepts the following parameters:
3434

3535
.. note::
3636

37-
Retryable writes run on MongoDB server versions 3.6 or later in bulk
38-
write operations unless they include one or more instances of
39-
``UpdateManyModel`` or ``DeleteManyModel``.
37+
Retryable writes run in bulk write operations unless they include one or
38+
more instances of ``UpdateManyModel`` or ``DeleteManyModel``.
4039

4140
.. tip::
4241

0 commit comments

Comments
 (0)