Skip to content

Commit a15a2c9

Browse files
authored
DOCSP-50022: remove eol server version mentions (#253)
* DOCSP-50022: remove eol server version mentions * consolidate compat table rows
1 parent c614e24 commit a15a2c9

File tree

53 files changed

+120
-244
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+120
-244
lines changed

source/connect/stable-api.txt

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

2020
.. note::
2121

22-
The {+stable-api+} feature requires {+mdb-server+} 5.0 or later.
22+
The {+stable-api+} feature requires {+mdb-server+} 6.0 or later.
2323

2424
Overview
2525
--------
@@ -116,4 +116,4 @@ API documentation:
116116
For more information about the ``MongoDB\Driver\ServerApi`` class, see the following
117117
{+extension-short+} API documentation:
118118

119-
- :php:`MongoDB\Driver\ServerApi <mongodb-driver-serverapi>`
119+
- :php:`MongoDB\Driver\ServerApi <mongodb-driver-serverapi>`

source/connect/tls.txt

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -127,17 +127,11 @@ to check whether a server's certificate has been revoked.
127127
OCSP
128128
~~~~
129129

130-
The Online Certificate Status Protocol (OCSP) process varies depending on the version of
131-
{+mdb-server+} you're connecting to:
132-
133-
- **MongoDB v4.4 or later:** The server staples a
134-
time-stamped OCSP response to its certificate. The {+library-short+} validates the certificate
135-
against the OCSP response. If the CA has revoked the certificate, or if the OCSP response
136-
is otherwise invalid, the TLS handshake fails.
137-
- **MongoDB v4.3 or earlier:** The server supplies an OCSP endpoint, which the {+library-short+}
138-
contacts directly. The {+library-short+} then validates the certificate against the OCSP
139-
response. If the CA hasn't revoked the certificate, the TLS handshake continues, even if
140-
the OCSP response is invalid or malformed.
130+
The Online Certificate Status Protocol (OCSP) process specifies that the
131+
server staples a time-stamped OCSP response to its certificate. The
132+
{+library-short+} validates the certificate against the OCSP response.
133+
If the CA has revoked the certificate, or if the OCSP response is
134+
otherwise invalid, the TLS handshake fails.
141135

142136
To stop the {+library-short+} from contacting the OCSP endpoint, set the
143137
``tlsDisableOCSPEndpointCheck`` connection option to ``true``.
@@ -265,4 +259,4 @@ API Documentation
265259
To learn more about configuring TLS for the {+library-short+},
266260
see the following API documentation:
267261

268-
- :phpclass:`MongoDB\Client`
262+
- :phpclass:`MongoDB\Client`

source/databases-collections/time-series.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Create a Time Series Collection
6060
.. important:: Server Version for Time Series Collections
6161

6262
To create and interact with time series collections, you must be
63-
connected to a deployment running {+mdb-server+} 5.0 or later.
63+
connected to a deployment running {+mdb-server+} 6.0 or later.
6464

6565
You can create a time series collection to store time series data.
6666
To create a time series collection, pass an options array to the

source/includes/extracts-common-option.yaml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ content: |
1818
:manual:`currentOp </reference/command/currentOp>` output, and
1919
:manual:`logs </reference/log-messages>`.
2020
---
21-
ref: common-option-comment-string-before-4.4
21+
ref: common-option-comment-string-before-6.0
2222
content: |
23-
The comment can be any valid BSON type since MongoDB 4.4. Earlier server
23+
The comment can be any valid BSON type starting in MongoDB 6.0. Earlier server
2424
versions only support string values.
2525
---
2626
ref: common-option-hint
@@ -35,8 +35,8 @@ content: |
3535
expressions that do not reference document fields. Parameters can then be
3636
accessed as variables in an aggregate expression context (e.g. ``$$var``).
3737
38-
This is not supported for server versions prior to 5.0 and will result in an
39-
exception at execution time if used.
38+
This feature is not supported for MongoDB server versions 6.0 and
39+
earlier. If used, the server returns an exception at execution time.
4040
---
4141
ref: common-option-maxTimeMS
4242
content: |
@@ -88,4 +88,3 @@ content: |
8888
It is not possible to specify a write concern for individual operations as
8989
part of a transaction. Instead, set the ``writeConcern`` option when
9090
:php:`starting the transaction <mongodb-driver-session.starttransaction>`.
91-
...
Lines changed: 4 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,8 @@
11
ref: _option-requires-version
22
content: |
3-
This option is available since MongoDB {{version}} and will result in an
4-
exception at execution time if specified for an older server version.
5-
---
6-
ref: option-requires-4.2
7-
source:
8-
file: extracts-option-requires.yaml
9-
ref: _option-requires-version
10-
replacement:
11-
version: "4.2"
12-
---
13-
ref: option-requires-4.4
14-
source:
15-
file: extracts-option-requires.yaml
16-
ref: _option-requires-version
17-
replacement:
18-
version: "4.4"
19-
---
20-
ref: option-requires-5.0
21-
source:
22-
file: extracts-option-requires.yaml
23-
ref: _option-requires-version
24-
replacement:
25-
version: "5.0"
26-
---
27-
ref: option-requires-5.3
28-
source:
29-
file: extracts-option-requires.yaml
30-
ref: _option-requires-version
31-
replacement:
32-
version: "5.3"
3+
To use this option, you must connect to MongoDB {{version}} or later.
4+
If you are connected to an earlier version, the server returns an
5+
exception at execution time.
336
---
347
ref: option-requires-6.0
358
source:
@@ -44,5 +17,5 @@ source:
4417
ref: _option-requires-version
4518
replacement:
4619
version: "7.0"
47-
...
20+
---
4821

source/includes/extracts-watch-option.yaml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ content: |
2424
Specify "updateLookup" to return the current majority-committed version of the
2525
updated document.
2626
27-
MongoDB 6.0+ allows returning the post-image of the modified document if the
27+
Starting in MongoDB 6.0, you can access the post-image of the modified document if the
2828
collection has ``changeStreamPreAndPostImages`` enabled. Specify
29-
"whenAvailable" to return the post-image if available or a null value if not.
29+
``whenAvailable`` to return the post-image if available or a null value if not.
3030
Specify "required" to return the post-image if available or raise an error if
3131
not.
3232
@@ -105,8 +105,9 @@ content: |
105105
``startAtOperationTime`` will result in a server error. The options are
106106
mutually exclusive.
107107
108-
This is not supported for server versions prior to 4.2 and will result in an
109-
exception at execution time if used.
108+
To use this option, you must connect to MongoDB 6.0 or later.
109+
If you are connected to an earlier version, the server returns an
110+
exception at execution time.
110111
111112
This is an option of the ``$changeStream`` pipeline stage.
112113
@@ -115,15 +116,14 @@ content: |
115116
ref: watch-option-startAtOperationTime
116117
content: |
117118
If specified, the change stream will only provide changes that occurred at or
118-
after the specified timestamp. Command responses from a MongoDB 4.0+ server
119-
include an ``operationTime`` that can be used here. By default, the
120-
``operationTime`` returned by the initial ``aggregate`` command will be used
121-
if available.
119+
after the specified timestamp. By default, the ``operationTime``
120+
returned by the initial ``aggregate`` command will be used if available.
122121
123122
Using this option in conjunction with ``resumeAfter`` and/or ``startAfter``
124123
will result in a server error. The options are mutually exclusive.
125124
126-
This is not supported for server versions prior to 4.0 and will result in an
127-
exception at execution time if used.
125+
To use this option, you must connect to MongoDB 6.0 or later.
126+
If you are connected to an earlier version, the server returns an
127+
exception at execution time.
128128
129129
This is an option of the ``$changeStream`` pipeline stage.

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

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,50 +7,18 @@
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-
* - ext + lib 1.21 to 2.0
11+
* - ext + lib 1.20 to 2.0
1712
- ✓
1813
- ✓
1914
- ✓
20-
- ✓
21-
- ✓
22-
- ✓
23-
- ✓ [#deprecation-note]_
24-
-
25-
26-
* - ext + lib 1.20
27-
- ✓
28-
- ✓
29-
- ✓
30-
- ✓
31-
- ✓
32-
- ✓
33-
- ✓
34-
-
3515

3616
* - ext + lib 1.16 to 1.19
3717
- ⊛
3818
- ✓
3919
- ✓
40-
- ✓
41-
- ✓
42-
- ✓
43-
- ✓
44-
- ✓
4520

4621
* - ext + lib 1.15
4722
- ⊛
4823
- ⊛
4924
- ✓
50-
- ✓
51-
- ✓
52-
- ✓
53-
- ✓
54-
- ✓
55-
56-
.. [#deprecation-note] Support for this MongoDB version is deprecated and will be removed in a future release.

source/reference/method/MongoDBClient-dropDatabase.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Parameters
4343
- mixed
4444
- .. include:: /includes/extracts/common-option-comment.rst
4545

46-
.. include:: /includes/extracts/option-requires-4.4.rst
46+
.. include:: /includes/extracts/option-requires-6.0.rst
4747

4848
.. versionadded:: 1.13
4949

source/reference/method/MongoDBClient-listDatabaseNames.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,18 +42,18 @@ Parameters
4242
* - authorizedDatabases
4343
- boolean
4444
- A flag that determines which databases are returned based on the user
45-
privileges when access control is enabled. For more information, see the
46-
`listDatabases command documentation <https://mongodb.com/docs/manual/reference/command/listDatabases/>`_.
47-
48-
For servers < 4.0.5, this option is ignored.
45+
privileges when access control is enabled. To learn more, see the
46+
:manual:`listDatabases command
47+
</reference/command/listDatabases/>` reference in the
48+
{+mdb-server+} manual.
4949

5050
.. versionadded:: 1.7
5151

5252
* - comment
5353
- mixed
5454
- .. include:: /includes/extracts/common-option-comment.rst
5555

56-
.. include:: /includes/extracts/option-requires-4.4.rst
56+
.. include:: /includes/extracts/option-requires-6.0.rst
5757

5858
.. versionadded:: 1.13
5959

source/reference/method/MongoDBClient-listDatabases.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,18 @@ Parameters
3939
* - authorizedDatabases
4040
- boolean
4141
- A flag that determines which databases are returned based on the user
42-
privileges when access control is enabled. For more information, see the
43-
`listDatabases command documentation <https://mongodb.com/docs/manual/reference/command/listDatabases/>`_.
44-
45-
For servers < 4.0.5, this option is ignored.
42+
privileges when access control is enabled. To learn more, see the
43+
:manual:`listDatabases command
44+
</reference/command/listDatabases/>` reference in the
45+
{+mdb-server+} manual.
4646

4747
.. versionadded:: 1.7
4848

4949
* - comment
5050
- mixed
5151
- .. include:: /includes/extracts/common-option-comment.rst
5252

53-
.. include:: /includes/extracts/option-requires-4.4.rst
53+
.. include:: /includes/extracts/option-requires-6.0.rst
5454

5555
.. versionadded:: 1.13
5656

source/reference/method/MongoDBClient-watch.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Parameters
6464
- mixed
6565
- .. include:: /includes/extracts/common-option-comment.rst
6666

67-
.. include:: /includes/extracts/common-option-comment-string-before-4.4.rst
67+
.. include:: /includes/extracts/common-option-comment-string-before-6.0.rst
6868

6969
.. versionadded:: 1.13
7070

source/reference/method/MongoDBCollection-aggregate.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,7 @@ Parameters
8787
- mixed
8888
- .. include:: /includes/extracts/common-option-comment.rst
8989

90-
The comment can be any valid BSON type for server versions 4.4 and
91-
above. Earlier server versions only support string values.
90+
.. include:: /includes/extracts/common-option-comment-string-before-6.0.rst
9291

9392
.. versionadded:: 1.3
9493

source/reference/method/MongoDBCollection-bulkWrite.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Parameters
9292
- mixed
9393
- .. include:: /includes/extracts/common-option-comment.rst
9494

95-
.. include:: /includes/extracts/option-requires-4.4.rst
95+
.. include:: /includes/extracts/option-requires-6.0.rst
9696

9797
.. versionadded:: 1.13
9898

source/reference/method/MongoDBCollection-count.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Parameters
5353
- mixed
5454
- .. include:: /includes/extracts/common-option-comment.rst
5555

56-
.. include:: /includes/extracts/option-requires-4.4.rst
56+
.. include:: /includes/extracts/option-requires-6.0.rst
5757

5858
.. versionadded:: 1.13
5959

source/reference/method/MongoDBCollection-countDocuments.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Parameters
5050
- mixed
5151
- .. include:: /includes/extracts/common-option-comment.rst
5252

53-
.. include:: /includes/extracts/common-option-comment-string-before-4.4.rst
53+
.. include:: /includes/extracts/common-option-comment-string-before-6.0.rst
5454

5555
* - hint
5656
- string|array|object

source/reference/method/MongoDBCollection-createIndex.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Parameters
9393
- mixed
9494
- .. include:: /includes/extracts/common-option-comment.rst
9595

96-
.. include:: /includes/extracts/option-requires-4.4.rst
96+
.. include:: /includes/extracts/option-requires-6.0.rst
9797

9898
.. versionadded:: 1.13
9999

@@ -107,8 +107,7 @@ Parameters
107107
concern plus ``"votingMembers"``, which indicates all voting
108108
data-bearing nodes.
109109

110-
This is not supported for server versions prior to 4.4 and will result
111-
in an exception at execution time if used.
110+
.. include:: /includes/extracts/option-requires-6.0.rst
112111

113112
.. versionadded:: 1.7
114113

source/reference/method/MongoDBCollection-createIndexes.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Parameters
5656
- mixed
5757
- .. include:: /includes/extracts/common-option-comment.rst
5858

59-
.. include:: /includes/extracts/option-requires-4.4.rst
59+
.. include:: /includes/extracts/option-requires-6.0.rst
6060

6161
.. versionadded:: 1.13
6262

@@ -70,8 +70,7 @@ Parameters
7070
concern plus ``"votingMembers"``, which indicates all voting
7171
data-bearing nodes.
7272

73-
This is not supported for server versions prior to 4.4 and will result
74-
in an exception at execution time if used.
73+
.. include:: /includes/extracts/option-requires-6.0.rst
7574

7675
.. versionadded:: 1.7
7776

source/reference/method/MongoDBCollection-deleteMany.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,15 +51,15 @@ Parameters
5151
- mixed
5252
- .. include:: /includes/extracts/common-option-comment.rst
5353

54-
.. include:: /includes/extracts/option-requires-4.4.rst
54+
.. include:: /includes/extracts/option-requires-6.0.rst
5555

5656
.. versionadded:: 1.13
5757

5858
* - hint
5959
- string|array|object
6060
- .. include:: /includes/extracts/common-option-hint.rst
6161

62-
.. include:: /includes/extracts/option-requires-4.4.rst
62+
.. include:: /includes/extracts/option-requires-6.0.rst
6363

6464
.. versionadded:: 1.7
6565

0 commit comments

Comments
 (0)