Skip to content

Commit f2237b0

Browse files
DOCSP-50017 Remove EOL versions (#220) (#221) (#223)
* DOCSP-50017 Remove EOL versions * auth * auth suggestion NR * NR comments * get rid of font on headings (cherry picked from commit 94fd075) (cherry picked from commit 7046a65) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 57a5c3f commit f2237b0

File tree

12 files changed

+37
-193
lines changed

12 files changed

+37
-193
lines changed

source/fundamentals/auth.txt

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

26-
* :ref:`Default <default-auth-mechanism>`
2726
* :ref:`SCRAM-SHA-256 <scram-sha-256-auth-mechanism>`
28-
* :ref:`SCRAM-SHA-1 <scram-sha-1-auth-mechanism>`
29-
* :ref:`MONGODB-CR <mongodb-cr-auth-mechanism>`
3027
* :ref:`MONGODB-AWS <mongodb-aws-auth-mechanism>`
3128
* :ref:`X.509 <x509-auth-mechanism>`
3229

@@ -45,38 +42,31 @@ Mechanisms
4542
----------
4643

4744
.. _default-auth-mechanism:
45+
.. _scram-sha-256-auth-mechanism:
4846

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

59-
Server versions 3.6 and earlier use ``MONGODB-CR`` as the default
60-
mechanism. Newer versions of the server use one of the mechanisms for
61-
which they advertise support.
50+
``SCRAM-SHA-256`` is a salted challenge-response authentication mechanism
51+
(SCRAM) that uses your username and password, encrypted with the ``SHA-256``
52+
algorithm, to authenticate your user. This is the default authentication
53+
mechanism.
6254

6355
The following code snippets show how to specify the authentication mechanism,
6456
using the following placeholders:
6557

66-
* ``db_username`` - your MongoDB database username
67-
* ``db_password`` - your MongoDB database user's password
68-
* ``hostname`` - network address of your MongoDB server, accessible by your client
69-
* ``port`` - port number of your MongoDB server
58+
* ``db_username`` - your MongoDB database username.
59+
* ``db_password`` - your MongoDB database user's password.
60+
* ``hostname`` - network address of your MongoDB server, accessible by your client.
61+
* ``port`` - port number of your MongoDB server.
7062
* ``authenticationDb`` - MongoDB database that contains your user's
7163
authentication data. If you omit this parameter, the driver uses the
7264
default value ``admin``.
7365

7466
Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
75-
tab below for instructions and sample code for specifying this authentication
67+
tab below for instructions and sample code to specify this default authentication
7668
mechanism:
7769

78-
.. _mongo-client-setting-with-mongo-credential-example:
79-
8070
.. tabs::
8171

8272
.. tab::
@@ -99,38 +89,10 @@ mechanism:
9989
.. literalinclude:: /examples/generated/AuthTest.snippet.default-mongo-cred.kt
10090
:language: kotlin
10191

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

13597
.. tabs::
13698

@@ -156,76 +118,10 @@ mechanism:
156118
.. literalinclude:: /examples/generated/AuthTest.snippet.scram-sha-256-cred.kt
157119
:language: kotlin
158120

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

227-
``MONGODB-AWS``
228-
~~~~~~~~~~~~~~~
123+
MONGODB-AWS
124+
~~~~~~~~~~~
229125

230126
.. note::
231127

@@ -448,8 +344,8 @@ method:
448344

449345
.. _x509-auth-mechanism:
450346

451-
``X.509``
452-
~~~~~~~~~
347+
X.509
348+
~~~~~
453349

454350
The ``X.509`` authentication mechanism uses
455351
: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

@@ -895,13 +894,6 @@ Use the ``searchMeta()`` method to create a
895894
pipeline stage which returns only the metadata part of the results from
896895
Atlas full-text search queries.
897896

898-
.. tip:: Only Available on Atlas for MongoDB v4.4.11 and later
899-
900-
This aggregation pipeline operator is only available
901-
on :atlas:`MongoDB Atlas </>` clusters running v4.4.11 and later. For a
902-
detailed list of version availability, see the MongoDB Atlas documentation
903-
on :atlas:`$searchMeta </atlas-search/query-syntax/#-searchmeta>`.
904-
905897
The following example shows the ``count`` metadata for an Atlas search
906898
aggregation stage:
907899

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
@@ -230,7 +230,7 @@ to improve performance.
230230
LDAP (PLAIN)
231231
~~~~~~~~~~~~
232232

233-
*Available in MongoDB Enterprise Edition 3.4 and later.*
233+
*Available in MongoDB Enterprise Edition.*
234234

235235
You can authenticate to a Lightweight Directory Access Protocol (LDAP)
236236
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
@@ -97,8 +97,8 @@ your application uses indexes:
9797
operation updates an indexed field, MongoDB updates the related index.
9898

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

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

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

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

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

593592
.. 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
@@ -11,13 +11,6 @@
1111
:depth: 1
1212
:class: singlecol
1313

14-
.. note::
15-
16-
The {+stable-api+} feature requires MongoDB Server 5.0 or later.
17-
18-
You should only use the {+stable-api+} feature if all the MongoDB
19-
servers you are connecting to support this feature.
20-
2114
Overview
2215
--------
2316

source/fundamentals/time-series.txt

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

53-
.. important::
54-
55-
Versions prior to MongoDB 5.0 cannot create a time series collection.
56-
5753
To check if you successfully created the collection, send the
5854
``"listCollections"`` command to the `runCommand() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-database/run-command.html>`__ method.
5955

@@ -90,8 +86,7 @@ and :ref:`aggregating data <kotlin-aggregation>`.
9086

9187
.. note:: Window Functions
9288

93-
MongoDB version 5.0 introduces window functions into the aggregation
94-
pipeline. You can use window functions to perform operations on a
89+
You can use window functions to perform operations on a
9590
contiguous span of time series data.
9691

9792
For more information, see our

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

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +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

1611
* - 5.2 to 5.3
1712
- ✓
1813
- ✓
1914
- ✓
20-
- ✓
21-
- ✓
22-
- ✓
23-
- ✓
24-
-
2515

2616
* - 4.10 to 5.1
2717
- ⊛
2818
- ✓
2919
- ✓
30-
- ✓
31-
- ✓
32-
- ✓
33-
- ✓
34-
- ✓

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

source/usage-examples/count.txt

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,6 @@ When you call the ``countDocuments()`` method, you can optionally pass a
3636
**query filter** parameter. You cannot pass any parameters when you call
3737
``estimatedDocumentCount()``.
3838

39-
.. important:: Stable API V1 and MongoDB Server Issue
40-
41-
If you are using the Stable API ``V1`` with the "strict" option and a
42-
MongoDB server version between 5.0.0 and 5.0.8 inclusive, method calls to
43-
``estimatedDocumentCount()`` may error due to a server bug.
44-
45-
Upgrade to MongoDB server 5.0.9 or set the Stable API "strict" option to
46-
``false`` to avoid this issue.
47-
4839
You can also pass an optional parameter to either of these methods to
4940
specify the behavior of the call:
5041

0 commit comments

Comments
 (0)