Skip to content

Commit 6732b73

Browse files
kennethdyerkennethdyer
authored
DOCSP-25351 EOL Version Cleanup for Aggregation (#1891) (#1923)
* DOCSP-25351 Cleans version references on $merge * DOCSP-25351 Cleans references in $out * DOCSP-25351 Cleans references in $sample * DOCSP-25351 Cleans references in $unwind * DOCSP-25351 Cleans references in $lookup * DOCSP-25351 Cleans references in $currentOp * DOCSP-25351 Cleans references in $dateFromParts and $dateFromString * DOCSP-25351 Cleans EOL version references" * DOCSP-25351 Fixes per Jocelyn * DOCSP-25351 Fixes per Jocelyn * DOCSP-25351 Fixes per Kyle Suarz * DOCSP-25351 Fixes per Kyle Suarz * DOCSP-25351 Fixes per Kyle Suarz * DOCSP-25351 Fixes per Kyle Suarz * DOCSP-25351 Fixes per Kyle Suarz * DOCSP-25351 Fixes per Kyle Suarz * DOCSP-25351 Fixes per Kyle Suarz * DOCSP-25223 Fixes per Kyle Suarz
1 parent 0fff07a commit 6732b73

24 files changed

+27
-121
lines changed

‎source/reference/operator/aggregation/convert.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ Definition
2020

2121
.. expression:: $convert
2222

23-
.. versionadded:: 4.0
24-
2523
Converts a value to a specified type.
2624

2725
:expression:`$convert` has the following syntax:

‎source/reference/operator/aggregation/currentOp.txt

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,6 @@ Syntax
142142

143143
Defaults to ``true``.
144144

145-
.. versionadded:: 4.0
146-
147145
* - :ref:`localOps <currentOp-stage-localOps>`
148146

149147
- .. _currentOp-stage-localOps:
@@ -161,8 +159,6 @@ Syntax
161159

162160
Defaults to ``false``.
163161

164-
.. versionadded:: 4.0
165-
166162
* - :ref:`backtrace <currentOp-stage-backtrace>`
167163

168164
- .. _currentOp-stage-backtrace:
@@ -199,7 +195,6 @@ Pipeline
199195

200196
- :pipeline:`$currentOp` must be the first stage in the pipeline.
201197

202-
203198
- Pipelines that start with :pipeline:`$currentOp` can only be run on
204199
the ``admin`` database.
205200

@@ -979,17 +974,13 @@ relevant for the operation:
979974
Only present if the operation is part of a multi-document
980975
transaction.
981976

982-
.. versionadded:: 4.0
983-
984977
.. data:: $currentOp.transaction.parameters.txnNumber
985978

986979
The transaction number.
987980

988981
Only present if the operation is part of a multi-document
989982
transaction.
990983

991-
.. versionadded:: 4.0
992-
993984
.. data:: $currentOp.transaction.parameters.autocommit
994985

995986
A boolean flag that indicates if autocommit is on for the
@@ -998,8 +989,6 @@ relevant for the operation:
998989
Only present if the operation is part of a multi-document
999990
transaction.
1000991

1001-
.. versionadded:: 4.0.2
1002-
1003992
.. data:: $currentOp.transaction.parameters.readConcern
1004993

1005994
The :ref:`read concern <transactions-read-concern>` for the
@@ -1012,8 +1001,6 @@ relevant for the operation:
10121001
Only present if the operation is part of a multi-document
10131002
transaction.
10141003

1015-
.. versionadded:: 4.0.2
1016-
10171004
.. data:: $currentOp.transaction.globalReadTimestamp
10181005

10191006
The timestamp of the snapshot read by the operations in the
@@ -1047,17 +1034,13 @@ relevant for the operation:
10471034
Instead, :data:`$currentOp.transaction.globalReadTimestamp` is
10481035
returned.
10491036

1050-
.. versionadded:: 4.0.2
1051-
10521037
.. data:: $currentOp.transaction.startWallClockTime
10531038

10541039
The date and time (with time zone) of the transaction start.
10551040

10561041
Only present if the operation is part of a multi-document
10571042
transaction.
10581043

1059-
.. versionadded:: 4.0.2
1060-
10611044
.. data:: $currentOp.transaction.timeOpenMicros
10621045

10631046
The duration, in microseconds, for the transaction.
@@ -1071,8 +1054,6 @@ relevant for the operation:
10711054
Only present if the operation is part of a multi-document
10721055
transaction.
10731056

1074-
.. versionadded:: 4.0.2
1075-
10761057
.. data:: $currentOp.transaction.timeActiveMicros
10771058

10781059
The total amount of time that the transaction has been active;
@@ -1088,8 +1069,6 @@ relevant for the operation:
10881069
Only present if the operation is part of a multi-document
10891070
transaction.
10901071

1091-
.. versionadded:: 4.0.2
1092-
10931072
.. data:: $currentOp.transaction.timeInactiveMicros
10941073

10951074
The total amount of time that the transaction has been
@@ -1175,8 +1154,6 @@ relevant for the operation:
11751154
Only present if the operation is part of a multi-document
11761155
transaction.
11771156

1178-
.. versionadded:: 4.0.2
1179-
11801157

11811158
.. data:: $currentOp.op
11821159

‎source/reference/operator/aggregation/dateFromParts.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -188,9 +188,9 @@ Definition
188188
:ref:`aggregation-expressions`.
189189

190190
.. |outofrange| replace::
191-
Starting in MongoDB 4.0, if the number specified is outside this
192-
range, :expression:`$dateFromParts` incorporates the difference in
193-
the date calculation. See :ref:`dateFromParts-values` for examples.
191+
If the number specified is outside this range, :expression:`$dateFromParts`
192+
incorporates the difference in the date calculation.
193+
See :ref:`dateFromParts-values` for examples.
194194

195195
.. |outofrange-4.4| replace::
196196
If the number specified is outside this range,
@@ -211,10 +211,10 @@ Starting in MongoDB 4.4, the supported value range for ``year`` and
211211
bound for these values was ``0`` and the supported value range was
212212
``0-9999``.
213213

214-
Starting in MongoDB 4.0, if the value specified for fields other than
215-
``year``, ``isoWeekYear``, and ``timezone`` is outside the valid range,
216-
:expression:`$dateFromParts` carries or subtracts the difference from
217-
other date parts to calculate the date.
214+
If the value specified for fields other than ``year``, ``isoWeekYear``,
215+
and ``timezone`` is outside the valid range, :expression:`$dateFromParts`
216+
carries or subtracts the difference from other date parts to calculate
217+
the date.
218218

219219
Value is Greater than the Range
220220
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

‎source/reference/operator/aggregation/dateFromString.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,6 @@ Definition
6161
If unspecified, :expression:`$dateFromString` uses
6262
``"%Y-%m-%dT%H:%M:%S.%LZ"`` as the default format.
6363

64-
.. versionadded:: 4.0
65-
6664
* - ``timezone``
6765

6866
- Optional. The time zone to use to format the date.

‎source/reference/operator/aggregation/dateToString.txt

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,6 @@ Definition
5858
If unspecified, :expression:`$dateToString` uses
5959
``"%Y-%m-%dT%H:%M:%S.%LZ"`` as the default format.
6060

61-
.. versionchanged:: 4.0
62-
63-
The ``format`` field is optional if
64-
``featureCompatibilityVersion`` (fCV) is set to ``"4.0"`` or
65-
greater. For more information on fCV, see
66-
:dbcommand:`setFeatureCompatibilityVersion`.
67-
6861
* - ``timezone``
6962

7063
- .. include:: /includes/fact-timezone-description.rst
@@ -78,12 +71,6 @@ Definition
7871
If unspecified, :expression:`$dateToString` returns null if the
7972
``date`` is null or missing.
8073

81-
.. versionadded:: 4.0
82-
83-
Requires ``featureCompatibilityVersion`` (fCV) set to
84-
``"4.0"`` or greater. For more information on fCV, see
85-
:dbcommand:`setFeatureCompatibilityVersion`.
86-
8774
.. seealso::
8875

8976
- :expression:`$toString`

‎source/reference/operator/aggregation/geoNear.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,6 @@ Definition
9292
``2d`` index and/or only one ``2dsphere`` index, MongoDB looks first
9393
for a ``2d`` index to use. If a ``2d`` index does not exists, then
9494
MongoDB looks for a ``2dsphere`` index to use.
95-
96-
.. versionadded:: 4.0
9795

9896
* - ``maxDistance``
9997

@@ -428,8 +426,6 @@ The aggregation returns a document with:
428426
Specify Which Geospatial Index to Use
429427
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
430428

431-
.. versionadded:: 4.0
432-
433429
Consider a ``places`` collection that has a :doc:`2dsphere
434430
</core/2dsphere>` index on the ``location`` field and a
435431
:doc:`2d </core/2d>` index on the ``legacy`` field.

‎source/reference/operator/aggregation/lookup.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ See these examples:
131131
Join Conditions and Subqueries on a Joined Collection
132132
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133133

134-
MongoDB 3.6 adds support for:
134+
MongoDB supports:
135135

136136
- Executing a pipeline on a joined collection.
137137

@@ -742,17 +742,15 @@ The operation returns these documents:
742742
Perform Multiple Joins and a Correlated Subquery with ``$lookup``
743743
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
744744

745-
.. versionchanged:: 3.6
746-
747-
MongoDB 3.6 adds support for executing a pipeline on a joined collection
748-
and allows multiple join conditions.
745+
Pipelines can execute on a joined collection and include multiple join
746+
conditions.
749747

750748
A join condition can reference a field in the local collection on which
751749
the :method:`~db.collection.aggregate()` method was run and reference a
752750
field in the joined collection. This allows a correlated subquery
753751
between the two collections.
754752

755-
MongoDB 5.0 also supports :ref:`concise correlated subqueries
753+
MongoDB 5.0 supports :ref:`concise correlated subqueries
756754
<lookup-concise-correlated-subquery>`.
757755

758756
Create a collection ``orders`` with these documents:

‎source/reference/operator/aggregation/ltrim.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Definition
1515

1616
.. expression:: $ltrim
1717

18-
.. versionadded:: 4.0
19-
2018
Removes whitespace characters, including null, or the specified
2119
characters from the beginning of a string.
2220

‎source/reference/operator/aggregation/merge.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ Definition
2828

2929
.. pipeline:: $merge
3030

31-
.. versionadded:: 4.2
32-
3331
Writes the results of the :doc:`aggregation pipeline
3432
</core/aggregation-pipeline>` to a specified collection. The
3533
:pipeline:`$merge` operator must be the **last** stage in the
@@ -688,9 +686,6 @@ results of the aggregation pipeline to a collection:
688686
* - :pipeline:`$merge`
689687
- :pipeline:`$out`
690688

691-
* - - Available starting in MongoDB 4.2
692-
- - Available starting in MongoDB 2.6
693-
694689
* - - Can output to a collection in the same or different database.
695690
- - Can output to a collection in the same or, starting in
696691
MongoDB 4.4, different database.

‎source/reference/operator/aggregation/out.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,6 @@ following summarizes the capabilities of the two stages:
101101

102102
* - :pipeline:`$out`
103103
- :pipeline:`$merge`
104-
* - - Available starting in MongoDB 2.6
105-
- - Available starting in MongoDB 4.2
106104
* - - Can output to a collection in the same or, starting in
107105
MongoDB 4.4, different database.
108106
- - Can output to a collection in the same or different database.

‎source/reference/operator/aggregation/planCacheStats.txt

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ document similar to the following:
131131
...
132132
],
133133
"indexFilterSet" : <boolean>,
134-
"estimatedSizeBytes" : <num>, // Available starting in MongoDB 5.0, 4.4.3, 4.2.12, 4.0.23, 3.6.23
134+
"estimatedSizeBytes" : <num>, // Available starting in MongoDB 5.0, 4.4.3, 4.2.12
135135
"host" : <string>, // Available starting in MongoDB 4.4
136136
"shard" : <string> // Available starting in MongoDB 4.4 if run on sharded cluster
137137
}
@@ -237,8 +237,9 @@ including:
237237
- A number that describes the estimated size in bytes of a plan
238238
cache entry.
239239

240-
.. versionadded:: 5.0 (*Also available starting in 4.4.3, 4.2.12,
241-
4.0.23, and 3.6.23*)
240+
.. versionadded:: 5.0
241+
242+
Starting in MongoDB 5.0, 4.4.3, and 4.2.12, this field is available.
242243

243244
* - :ref:`host <plancachestats-host>`
244245

@@ -352,7 +353,7 @@ The operation returns all entries in the cache:
352353
1.5002
353354
],
354355
"indexFilterSet" : false,
355-
"estimatedSizeBytes" : NumberLong(3160), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12, 4.0.23, 3.6.23
356+
"estimatedSizeBytes" : NumberLong(3160), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12
356357
"host" : "mongodb1.example.net:27018", // Available starting in MongoDB 4.4
357358
"shard" : "shardA" // Available starting in MongoDB 4.4 if run on sharded cluster
358359
}
@@ -383,7 +384,7 @@ The operation returns all entries in the cache:
383384
1.0002
384385
],
385386
"indexFilterSet" : false,
386-
"estimatedSizeBytes" : NumberLong(2539), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12, 4.0.23, 3.6.23
387+
"estimatedSizeBytes" : NumberLong(2539), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12
387388
"host" : "mongodb1.example.net:27018", // Available starting in MongoDB 4.4
388389
"shard" : "shardA" // Available starting in MongoDB 4.4 if run on sharded cluster
389390
}
@@ -414,7 +415,7 @@ The operation returns all entries in the cache:
414415
1.7502
415416
],
416417
"indexFilterSet" : false,
417-
"estimatedSizeBytes" : NumberLong(3183), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12, 4.0.23, 3.6.23
418+
"estimatedSizeBytes" : NumberLong(3183), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12
418419
"host" : "mongodb1.example.net:27018", // Available starting in MongoDB 4.4
419420
"shard" : "shardA" // Available starting in MongoDB 4.4 if run on sharded cluster
420421
}
@@ -449,7 +450,7 @@ The operation returns all entries in the cache:
449450
1.6668666666666665
450451
],
451452
"indexFilterSet" : false,
452-
"estimatedSizeBytes" : NumberLong(4653), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12, 4.0.23, 3.6.23
453+
"estimatedSizeBytes" : NumberLong(4653), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12
453454
"host" : "mongodb1.example.net:27018", // Available starting in MongoDB 4.4
454455
"shard" : "shardA" // Available starting in MongoDB 4.4 if run on sharded cluster
455456
}
@@ -677,7 +678,7 @@ The operation returns the following:
677678
1.5002
678679
],
679680
"indexFilterSet" : false,
680-
"estimatedSizeBytes" : NumberLong(3160), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12, 4.0.23, 3.6.23
681+
"estimatedSizeBytes" : NumberLong(3160), // Available starting in MongoDB 5.0, 4.4.3, 4.2.12
681682
"host" : "mongodb1.example.net:27018", // Available starting in MongoDB 4.4
682683
"shard" : "shardA" // Available starting in MongoDB 4.4 if run on sharded cluster
683684
}

‎source/reference/operator/aggregation/round.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Definition
1515

1616
.. expression:: $round
1717

18-
.. versionadded:: 4.2.
18+
.. versionadded:: 4.2
1919

2020
:expression:`$round` rounds a number to a whole integer *or* to a
2121
specified decimal place.

‎source/reference/operator/aggregation/rtrim.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Definition
1515

1616
.. expression:: $rtrim
1717

18-
.. versionadded:: 4.0
19-
2018
Removes whitespace characters, including null, or the specified
2119
characters from the end of a string.
2220

‎source/reference/operator/aggregation/sample.txt

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,6 @@ If any of the previous conditions are false, :pipeline:`$sample`:
4747
Random sorts are subject to the :ref:`sort memory restrictions
4848
<sort-memory-limit>`.
4949

50-
MMAPv1 May Return Duplicate Documents
51-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52-
53-
If you are using the:
54-
55-
- MMAPv1 storage engine, :pipeline:`$sample` may return the same
56-
document more than once in the result set.
57-
58-
- :ref:`WiredTiger <storage-wiredtiger>` or
59-
:ref:`in-memory <storage-inmemory>` storage engine,
60-
:pipeline:`$sample` does not return duplicate documents. WiredTiger
61-
is the default storage engine as of MongoDB 3.2.
62-
6350
Example
6451
--------
6552

‎source/reference/operator/aggregation/toBool.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ Definition
2121

2222
.. expression:: $toBool
2323

24-
.. versionadded:: 4.0
25-
2624
Converts a value to a boolean.
2725

2826
:expression:`$toBool` has the following syntax:

‎source/reference/operator/aggregation/toDate.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ Definition
1919

2020
.. expression:: $toDate
2121

22-
.. versionadded:: 4.0
23-
2422
Converts a value to a date. If the value cannot be converted
2523
to a date, :expression:`$toDate` errors. If the value is null or
2624
missing, :expression:`$toDate` returns null.

‎source/reference/operator/aggregation/toDecimal.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ Definition
2020

2121
.. expression:: $toDecimal
2222

23-
.. versionadded:: 4.0
24-
2523
Converts a value to a decimal. If the value cannot be converted
2624
to a decimal, :expression:`$toDecimal` errors. If the value is null or
2725
missing, :expression:`$toDecimal` returns null.

0 commit comments

Comments
 (0)