Skip to content

Commit 8dc9a92

Browse files
jocelyn-mendez1Jocelyn Mendez
andauthored
DOCSP-22135 FCV page update: add v6.0 and remove EOL versions (#1094)
* DOCSP-22135 add v6.0 and remove EOL versions * DOCSP-22135 relocating warning & fixing ref * DOCSP-22135 removing eol versions from list * DOCSP-22135 removed include * DOCSP-22135 removed include * DOCSP-22135 add include file back Co-authored-by: Jocelyn Mendez <[email protected]>
1 parent 3e13f86 commit 8dc9a92

File tree

4 files changed

+80
-216
lines changed

4 files changed

+80
-216
lines changed

source/includes/featureCompatibility-caveat.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Enabling these backwards-incompatible features can complicate the
2+
downgrade process since you must remove any persisted backwards-incompatible
3+
features before you downgrade.
4+
5+
It is recommended that after upgrading, you allow your deployment to run
6+
without enabling these features for a burn-in period to ensure the
7+
likelihood of downgrade is minimal. When you are confident that the
8+
likelihood of downgrade is minimal, enable these features.

source/includes/list-table-featureCompatibilityVersion-defaults.rst

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@
55
* - Deployments
66
- ``featureCompatibilityVersion``
77

8+
* - For new 6.0 deployments
9+
- ``"6.0"``
10+
11+
* - For 6.0 deployments :ref:`upgraded from 5.0 <6.0-upgrade>`
12+
13+
- ``"5.0"`` until you :dbcommand:`setFeatureCompatibilityVersion` to ``"6.0"``.
14+
815
* - For new 5.0 deployments
916
- ``"5.0"``
1017

@@ -25,26 +32,3 @@
2532
* - For 4.2 deployments :ref:`upgraded from 4.0 <4.2-upgrade>`
2633

2734
- ``"4.0"`` until you :dbcommand:`setFeatureCompatibilityVersion` to ``"4.2"``.
28-
29-
* - For new 4.0 deployments
30-
- ``"4.0"``
31-
32-
* - For 4.0 deployments :ref:`upgraded from 3.6 <4.0-upgrade>`
33-
34-
- ``"3.6"`` until you :dbcommand:`setFeatureCompatibilityVersion` to ``"4.0"``.
35-
36-
* - For new 3.6 deployments
37-
- ``"3.6"``
38-
39-
* - For 3.6 deployments :ref:`upgraded from 3.4 <3.6-upgrade>`
40-
41-
- ``"3.4"`` until you :dbcommand:`setFeatureCompatibilityVersion`
42-
to ``"3.6"``.
43-
44-
* - For new 3.4 deployments
45-
- ``"3.4"``
46-
47-
* - For 3.4 deployments :ref:`upgraded from 3.2 <3.4-upgrade>`
48-
49-
- ``"3.2"`` until you :dbcommand:`setFeatureCompatibilityVersion`
50-
to ``"3.4"``.

source/reference/command/setFeatureCompatibilityVersion.txt

Lines changed: 65 additions & 185 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ Definition
2020
:dbcommand:`setFeatureCompatibilityVersion` against the ``admin``
2121
database.
2222

23+
.. warning::
24+
25+
Enabling backwards-incompatible features can complicate the
26+
downgrade process since you must remove any persisted
27+
backwards-incompatible features before you downgrade.
28+
29+
It is recommended that after upgrading, you allow your deployment to
30+
run without enabling backwards-incompatible features for a burn-in period
31+
to ensure the likelihood of downgrade is minimal. When you are confident
32+
that the likelihood of downgrade is minimal, enable these features.
33+
2334
Syntax
2435
------
2536

@@ -41,97 +52,39 @@ The values for the ``version`` are:
4152
* - Version
4253
- Description
4354

44-
* - ``"5.0"``
55+
* - ``"6.0"``
56+
57+
- *Available on MongoDB 6.0 Deployments*
4558

59+
Enables the :ref:`6.0 features that persist data incompatible
60+
with MongoDB 5.0 <6.0-downgrade-considerations>`.
61+
62+
* - ``"5.0"``
4663

4764
- *Available on MongoDB 5.0 Deployments*
4865

4966
Enables the :ref:`5.0 features that persist data incompatible
5067
with MongoDB 4.4 <5.0-compatibility-enabled>`.
5168

52-
.. include:: /includes/featureCompatibility-caveat.rst
53-
5469
* - ``"4.4"``
5570

56-
5771
- *Available on MongoDB 4.4 and 5.0 Deployments*
5872

5973
Enables the :ref:`4.4 features that persist data incompatible
6074
with MongoDB 4.2 <4.4-compatibility-enabled>`.
6175

62-
.. include:: /includes/featureCompatibility-caveat.rst
63-
64-
6576
* - ``"4.2"``
6677

67-
6878
- *Available on MongoDB 4.2 and 4.4 Deployments*
6979

7080
Enables the :ref:`4.2 features that persist data incompatible
7181
with MongoDB 4.0 <4.2-compatibility-enabled>`.
7282

73-
.. include:: /includes/featureCompatibility-caveat.rst
74-
7583
- If set on MongoDB 4.4 deployments,
7684
Disables the :ref:`4.4 features that persist data
7785
incompatible with MongoDB 4.2
7886
<4.4-compatibility-enabled>`.
7987

80-
* - ``"4.0"``
81-
82-
- *Available on MongoDB 4.0 and 4.2 Deployments*
83-
84-
- If set on MongoDB 4.0 deployments,
85-
Enables the :ref:`4.0 features that persist data incompatible
86-
with MongoDB 3.6 <4.0-compatibility-enabled>`.
87-
88-
.. include:: /includes/featureCompatibility-caveat.rst
89-
90-
- If set on MongoDB 4.2 deployments,
91-
Disables the :ref:`4.2 features that persist data
92-
incompatible with MongoDB 4.0
93-
<4.2-compatibility-enabled>`.
94-
95-
* - ``"3.6"``
96-
97-
- *Available on MongoDB 3.6 and 4.0 Deployments*
98-
99-
- If set on MongoDB 3.6 deployments,
100-
Enables the :ref:`3.6 features that persist data
101-
incompatible with MongoDB 3.4
102-
<3.6-compatibility-enabled>`.
103-
104-
.. include:: /includes/featureCompatibility-caveat.rst
105-
106-
- If set on MongoDB 4.0 deployments,
107-
Disables the :ref:`4.0 features that persist data
108-
incompatible with MongoDB 3.6
109-
<4.0-compatibility-enabled>`.
110-
111-
112-
* - ``"3.4"``
113-
114-
- *Available on MongoDB 3.4 and MongoDB 3.6 Deployments*
115-
116-
- If set on MongoDB 3.4 deployments,
117-
Enables the :ref:`3.4 features that persist data
118-
incompatible with MongoDB 3.2
119-
<3.4-compatibility-enabled>`.
120-
121-
.. include:: /includes/3.4-featureCompatibility-caveat.rst
122-
123-
- If set on MongoDB 3.6 deployments,
124-
Disables the :ref:`3.6 features that persist data
125-
incompatible with MongoDB 3.4
126-
<3.6-compatibility-enabled>`.
127-
128-
* - ``"3.2"``
129-
130-
- *Available on MongoDB 3.4 Deployments*
131-
132-
Disables the :ref:`3.4 features that persist data
133-
incompatible with MongoDB 3.2 <3.4-compatibility-enabled>`.
134-
13588
The optional ``writeConcern`` specifies the write concern
13689
:ref:`wc-wtimeout` value in milliseconds:
13790

@@ -257,6 +210,53 @@ depending on the current state of the :binary:`~bin.mongod`:
257210

258211
.. _set-fcv:
259212

213+
Set Feature Compatibility Version on MongoDB 6.0 Deployments
214+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
215+
216+
Enable 6.0 Backwards Incompatible Features
217+
``````````````````````````````````````````
218+
219+
To enable the :ref:`6.0 features that persist data incompatible with
220+
MongoDB 5.0 <6.0-downgrade-considerations>`, set the feature compatibility
221+
to ``"6.0"`` on the MongoDB 6.0 deployment:
222+
223+
.. note::
224+
225+
Run the :dbcommand:`setFeatureCompatibilityVersion` command against
226+
the ``admin`` database.
227+
228+
.. include:: /includes/list-run-command-targets.rst
229+
230+
.. code-block:: javascript
231+
232+
db.adminCommand( { setFeatureCompatibilityVersion: "6.0" } )
233+
234+
Disable 6.0 Backwards Incompatible Features
235+
```````````````````````````````````````````
236+
237+
To disable the :ref:`6.0 features that persist data incompatible with
238+
MongoDB 5.0 <6.0-downgrade-considerations>`, set the feature compatibility
239+
to ``"5.0"`` on the MongoDB 6.0 deployment:
240+
241+
.. note::
242+
243+
Run the :dbcommand:`setFeatureCompatibilityVersion` command against
244+
the ``admin`` database.
245+
246+
.. include:: /includes/list-run-command-targets.rst
247+
248+
- ``"5.0"`` featureCompatibilityVersion is supported on MongoDB
249+
5.0 and MongoDB 6.0 deployments only.
250+
251+
.. code-block:: javascript
252+
253+
db.adminCommand( { setFeatureCompatibilityVersion: "5.0" } )
254+
255+
If run as part of the downgrade process from MongoDB 6.0 to MongoDB
256+
5.0, you must also remove all persisted features that are
257+
:ref:`incompatible <6.0-downgrade-considerations>` with 5.0. See the
258+
appropriate downgrade procedures.
259+
260260
Set Feature Compatibility Version on MongoDB 5.0 Deployments
261261
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
262262

@@ -372,126 +372,6 @@ to ``"4.2"`` on the MongoDB 4.2 deployment:
372372

373373
db.adminCommand( { setFeatureCompatibilityVersion: "4.2" } )
374374

375-
Disable 4.2 Backwards Incompatible Features
376-
```````````````````````````````````````````
377-
378-
To disable the :ref:`4.2 features that persist data incompatible with
379-
MongoDB 4.0 <4.2-compatibility-enabled>`, set the feature compatibility
380-
to ``"4.0"`` on the MongoDB 4.2 deployment:
381-
382-
.. note::
383-
384-
Run the :dbcommand:`setFeatureCompatibilityVersion` command against
385-
the ``admin`` database.
386-
387-
.. include:: /includes/list-run-command-targets.rst
388-
389-
- ``"4.0"`` featureCompatibilityVersion is supported on MongoDB
390-
4.0 and MongoDB 4.2 deployments only.
391-
392-
.. code-block:: javascript
393-
394-
db.adminCommand( { setFeatureCompatibilityVersion: "4.0" } )
395-
396-
If run as part of the downgrade process from MongoDB 4.2 to MongoDB
397-
4.0, you must also remove all persisted features that are
398-
:ref:`incompatible <4.2-compatibility-enabled>` with 4.0. See the
399-
appropriate downgrade procedures.
400-
401-
Set Feature Compatibility Version on MongoDB 4.0 Deployments
402-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
403-
404-
Enable 4.0 Backwards Incompatible Features
405-
``````````````````````````````````````````
406-
407-
To enable the :ref:`4.0 features that persist data incompatible with
408-
MongoDB 3.6 <4.0-compatibility-enabled>`, set the feature compatibility
409-
to ``"4.0"`` on the MongoDB 4.0 deployment:
410-
411-
.. note::
412-
413-
Run the :dbcommand:`setFeatureCompatibilityVersion` command against
414-
the ``admin`` database.
415-
416-
.. include:: /includes/list-run-command-targets.rst
417-
418-
.. code-block:: javascript
419-
420-
db.adminCommand( { setFeatureCompatibilityVersion: "4.0" } )
421-
422-
Disable 4.0 Backwards Incompatible Features
423-
```````````````````````````````````````````
424-
425-
To disable the :ref:`4.0 features that persist data incompatible with
426-
MongoDB 3.6 <4.0-compatibility-enabled>`, set the feature compatibility
427-
to ``"3.6"`` on the MongoDB 4.0 deployment:
428-
429-
.. note::
430-
431-
Run the :dbcommand:`setFeatureCompatibilityVersion` command against
432-
the ``admin`` database.
433-
434-
.. include:: /includes/list-run-command-targets.rst
435-
436-
- ``"3.6"`` featureCompatibilityVersion is supported on MongoDB
437-
3.6 and MongoDB 4.0 Deployments Only.
438-
439-
.. code-block:: javascript
440-
441-
db.adminCommand( { setFeatureCompatibilityVersion: "3.6" } )
442-
443-
If run as part of the downgrade process from MongoDB 4.0 to MongoDB
444-
3.6, you must also remove all persisted features that are
445-
:ref:`incompatible <4.0-compatibility-enabled>` with 3.6. See the
446-
appropriate downgrade procedures.
447-
448-
Set Feature Compatibility Version on MongoDB 3.6 Deployments
449-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
450-
451-
Enable 3.6 Backwards Incompatible Features
452-
``````````````````````````````````````````
453-
454-
To enable the :ref:`3.6 features that persist data incompatible with
455-
MongoDB 3.4 <3.6-compatibility-enabled>`, set the feature compatibility
456-
to ``"3.6"`` on the MongoDB 3.6 deployment:
457-
458-
.. note::
459-
460-
Run the :dbcommand:`setFeatureCompatibilityVersion` command against
461-
the ``admin`` database.
462-
463-
.. include:: /includes/list-run-command-targets.rst
464-
465-
.. code-block:: javascript
466-
467-
db.adminCommand( { setFeatureCompatibilityVersion: "3.6" } )
468-
469-
Disable 3.6 Backwards Incompatible Features
470-
```````````````````````````````````````````
471-
472-
To disable the :ref:`3.6 features that persist data incompatible with
473-
MongoDB 3.4 <3.6-compatibility-enabled>`, set the feature compatibility
474-
to ``"3.4"`` on the MongoDB 3.6 deployment:
475-
476-
.. note::
477-
478-
Run the :dbcommand:`setFeatureCompatibilityVersion` command against
479-
the ``admin`` database.
480-
481-
.. include:: /includes/list-run-command-targets.rst
482-
483-
- ``"3.4"`` featureCompatibilityVersion is supported on MongoDB
484-
3.6 and MongoDB 3.4 Deployments Only.
485-
486-
.. code-block:: javascript
487-
488-
db.adminCommand( { setFeatureCompatibilityVersion: "3.4" } )
489-
490-
If run as part of the downgrade process from MongoDB 3.6 to MongoDB
491-
3.4, you must also remove all persisted features that are
492-
:ref:`incompatible <3.6-compatibility-enabled>` with 3.4. See the
493-
appropriate downgrade procedures.
494-
495375
Set Write Concern Timeout
496376
~~~~~~~~~~~~~~~~~~~~~~~~~
497377

0 commit comments

Comments
 (0)