Skip to content

DOCSP-50022: remove eol server version mentions #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions source/connect/stable-api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

.. note::

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

Overview
--------
Expand Down Expand Up @@ -116,4 +116,4 @@ API documentation:
For more information about the ``MongoDB\Driver\ServerApi`` class, see the following
{+extension-short+} API documentation:

- :php:`MongoDB\Driver\ServerApi <mongodb-driver-serverapi>`
- :php:`MongoDB\Driver\ServerApi <mongodb-driver-serverapi>`
18 changes: 6 additions & 12 deletions source/connect/tls.txt
Original file line number Diff line number Diff line change
Expand Up @@ -127,17 +127,11 @@ to check whether a server's certificate has been revoked.
OCSP
~~~~

The Online Certificate Status Protocol (OCSP) process varies depending on the version of
{+mdb-server+} you're connecting to:

- **MongoDB v4.4 or later:** The server staples a
time-stamped OCSP response to its certificate. The {+library-short+} validates the certificate
against the OCSP response. If the CA has revoked the certificate, or if the OCSP response
is otherwise invalid, the TLS handshake fails.
- **MongoDB v4.3 or earlier:** The server supplies an OCSP endpoint, which the {+library-short+}
contacts directly. The {+library-short+} then validates the certificate against the OCSP
response. If the CA hasn't revoked the certificate, the TLS handshake continues, even if
the OCSP response is invalid or malformed.
The Online Certificate Status Protocol (OCSP) process specifies that the
server staples a time-stamped OCSP response to its certificate. The
{+library-short+} validates the certificate against the OCSP response.
If the CA has revoked the certificate, or if the OCSP response is
otherwise invalid, the TLS handshake fails.

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

- :phpclass:`MongoDB\Client`
- :phpclass:`MongoDB\Client`
2 changes: 1 addition & 1 deletion source/databases-collections/time-series.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Create a Time Series Collection
.. important:: Server Version for Time Series Collections

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

You can create a time series collection to store time series data.
To create a time series collection, pass an options array to the
Expand Down
9 changes: 4 additions & 5 deletions source/includes/extracts-common-option.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ content: |
:manual:`currentOp </reference/command/currentOp>` output, and
:manual:`logs </reference/log-messages>`.
---
ref: common-option-comment-string-before-4.4
ref: common-option-comment-string-before-6.0
content: |
The comment can be any valid BSON type since MongoDB 4.4. Earlier server
The comment can be any valid BSON type starting in MongoDB 6.0. Earlier server
versions only support string values.
---
ref: common-option-hint
Expand All @@ -35,8 +35,8 @@ content: |
expressions that do not reference document fields. Parameters can then be
accessed as variables in an aggregate expression context (e.g. ``$$var``).

This is not supported for server versions prior to 5.0 and will result in an
exception at execution time if used.
This feature is not supported for MongoDB server versions 6.0 and
earlier. If used, the server returns an exception at execution time.
---
ref: common-option-maxTimeMS
content: |
Expand Down Expand Up @@ -88,4 +88,3 @@ content: |
It is not possible to specify a write concern for individual operations as
part of a transaction. Instead, set the ``writeConcern`` option when
:php:`starting the transaction <mongodb-driver-session.starttransaction>`.
...
35 changes: 4 additions & 31 deletions source/includes/extracts-option-requires.yaml
Original file line number Diff line number Diff line change
@@ -1,35 +1,8 @@
ref: _option-requires-version
content: |
This option is available since MongoDB {{version}} and will result in an
exception at execution time if specified for an older server version.
---
ref: option-requires-4.2
source:
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "4.2"
---
ref: option-requires-4.4
source:
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "4.4"
---
ref: option-requires-5.0
source:
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "5.0"
---
ref: option-requires-5.3
source:
file: extracts-option-requires.yaml
ref: _option-requires-version
replacement:
version: "5.3"
To use this option, you must connect to MongoDB {{version}} or later.
If you are connected to an earlier version, the server returns an
exception at execution time.
---
ref: option-requires-6.0
source:
Expand All @@ -44,5 +17,5 @@ source:
ref: _option-requires-version
replacement:
version: "7.0"
...
---

20 changes: 10 additions & 10 deletions source/includes/extracts-watch-option.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ content: |
Specify "updateLookup" to return the current majority-committed version of the
updated document.

MongoDB 6.0+ allows returning the post-image of the modified document if the
Starting in MongoDB 6.0, you can access the post-image of the modified document if the
collection has ``changeStreamPreAndPostImages`` enabled. Specify
"whenAvailable" to return the post-image if available or a null value if not.
``whenAvailable`` to return the post-image if available or a null value if not.
Specify "required" to return the post-image if available or raise an error if
not.

Expand Down Expand Up @@ -105,8 +105,9 @@ content: |
``startAtOperationTime`` will result in a server error. The options are
mutually exclusive.

This is not supported for server versions prior to 4.2 and will result in an
exception at execution time if used.
To use this option, you must connect to MongoDB 6.0 or later.
If you are connected to an earlier version, the server returns an
exception at execution time.

This is an option of the ``$changeStream`` pipeline stage.

Expand All @@ -115,15 +116,14 @@ content: |
ref: watch-option-startAtOperationTime
content: |
If specified, the change stream will only provide changes that occurred at or
after the specified timestamp. Command responses from a MongoDB 4.0+ server
include an ``operationTime`` that can be used here. By default, the
``operationTime`` returned by the initial ``aggregate`` command will be used
if available.
after the specified timestamp. By default, the ``operationTime``
returned by the initial ``aggregate`` command will be used if available.

Using this option in conjunction with ``resumeAfter`` and/or ``startAfter``
will result in a server error. The options are mutually exclusive.

This is not supported for server versions prior to 4.0 and will result in an
exception at execution time if used.
To use this option, you must connect to MongoDB 6.0 or later.
If you are connected to an earlier version, the server returns an
exception at execution time.

This is an option of the ``$changeStream`` pipeline stage.
34 changes: 1 addition & 33 deletions source/includes/mongodb-compatibility-table-php.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,50 +7,18 @@
- MongoDB 8.0
- MongoDB 7.0
- MongoDB 6.0
- MongoDB 5.0
- MongoDB 4.4
- MongoDB 4.2
- MongoDB 4.0
- MongoDB 3.6

* - ext + lib 1.21 to 2.0
* - ext + lib 1.20 to 2.0
- ✓
- ✓
- ✓
- ✓
- ✓
- ✓
- ✓ [#deprecation-note]_
-

* - ext + lib 1.20
- ✓
- ✓
- ✓
- ✓
- ✓
- ✓
- ✓
-

* - ext + lib 1.16 to 1.19
- ⊛
- ✓
- ✓
- ✓
- ✓
- ✓
- ✓
- ✓

* - ext + lib 1.15
- ⊛
- ⊛
- ✓
- ✓
- ✓
- ✓
- ✓
- ✓

.. [#deprecation-note] Support for this MongoDB version is deprecated and will be removed in a future release.
2 changes: 1 addition & 1 deletion source/reference/method/MongoDBClient-dropDatabase.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Parameters
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.13

Expand Down
10 changes: 5 additions & 5 deletions source/reference/method/MongoDBClient-listDatabaseNames.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,18 @@ Parameters
* - authorizedDatabases
- boolean
- A flag that determines which databases are returned based on the user
privileges when access control is enabled. For more information, see the
`listDatabases command documentation <https://mongodb.com/docs/manual/reference/command/listDatabases/>`_.

For servers < 4.0.5, this option is ignored.
privileges when access control is enabled. To learn more, see the
:manual:`listDatabases command
</reference/command/listDatabases/>` reference in the
{+mdb-server+} manual.

.. versionadded:: 1.7

* - comment
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.13

Expand Down
10 changes: 5 additions & 5 deletions source/reference/method/MongoDBClient-listDatabases.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,18 @@ Parameters
* - authorizedDatabases
- boolean
- A flag that determines which databases are returned based on the user
privileges when access control is enabled. For more information, see the
`listDatabases command documentation <https://mongodb.com/docs/manual/reference/command/listDatabases/>`_.

For servers < 4.0.5, this option is ignored.
privileges when access control is enabled. To learn more, see the
:manual:`listDatabases command
</reference/command/listDatabases/>` reference in the
{+mdb-server+} manual.

.. versionadded:: 1.7

* - comment
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.13

Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/MongoDBClient-watch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Parameters
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.13

Expand Down
3 changes: 1 addition & 2 deletions source/reference/method/MongoDBCollection-aggregate.txt
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,7 @@ Parameters
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.3

Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/MongoDBCollection-bulkWrite.txt
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Parameters
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.13

Expand Down
2 changes: 1 addition & 1 deletion source/reference/method/MongoDBCollection-count.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Parameters
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.13

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Parameters
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

* - hint
- string|array|object
Expand Down
5 changes: 2 additions & 3 deletions source/reference/method/MongoDBCollection-createIndex.txt
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Parameters
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.13

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

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

.. versionadded:: 1.7

Expand Down
5 changes: 2 additions & 3 deletions source/reference/method/MongoDBCollection-createIndexes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Parameters
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.13

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

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

.. versionadded:: 1.7

Expand Down
4 changes: 2 additions & 2 deletions source/reference/method/MongoDBCollection-deleteMany.txt
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ Parameters
- mixed
- .. include:: /includes/extracts/common-option-comment.rst

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

.. versionadded:: 1.13

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

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

.. versionadded:: 1.7

Expand Down
Loading
Loading