Skip to content

Commit e409e60

Browse files
authored
DOCSP-26358 replaces agg pipline doc directives (#2120)
1 parent b7569a6 commit e409e60

35 files changed

+86
-90
lines changed

source/core/aggregation-pipeline-limits.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Number of Stages Restrictions
3232

3333
.. versionchanged:: 5.0
3434

35-
MongoDB 5.0 limits the number of :doc:`aggregation pipeline stages
36-
</reference/operator/aggregation-pipeline>` allowed in a single pipeline
37-
to 1000.
35+
MongoDB 5.0 limits the number of :ref:`aggregation pipeline stages
36+
<aggregation-pipeline-operator-reference>` allowed in a single
37+
pipeline to 1000.
3838

3939
.. _agg-memory-restrictions:
4040

source/core/read-preference.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ Read Preference and Transactions
229229
Additional Considerations
230230
-------------------------
231231

232-
For :doc:`aggregation pipeline </core/aggregation-pipeline>`
232+
For :ref:`aggregation pipeline <aggregation-pipeline>`
233233
operations that include the :pipeline:`$out` or :pipeline:`$merge`
234234
stages, the pipeline runs on the :term:`primary` member regardless of
235235
read preference setting.

source/core/sharded-cluster-query-router.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ retrieves the results.
5151

5252
.. versionchanged:: 3.6
5353

54-
For :doc:`aggregation operations </core/aggregation-pipeline>` that
54+
For :ref:`aggregation operations <aggregation-pipeline>` that
5555
run on multiple shards, if the operations do not require running on
5656
the database's :term:`primary shard`, these operations may route the
5757
results back to the :binary:`~bin.mongos` where the results are then

source/core/views/create-view.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -220,13 +220,12 @@ When you query a view:
220220

221221
- MongoDB appends the client query to the underlying pipeline and
222222
returns the results of that combined pipeline to the client. MongoDB
223-
may apply :doc:`aggregation pipeline optimizations
224-
</core/aggregation-pipeline-optimization>` to the combined pipeline.
223+
may apply :ref:`aggregation pipeline optimizations
224+
<agg-pipeline-optimization>` to the combined pipeline.
225225

226-
- The :doc:`aggregation pipeline optimizer
227-
</core/aggregation-pipeline-optimization>` reshapes the view
228-
aggregation pipeline stages to improve performance. The optimization
229-
does not change the query results.
226+
- The aggregation pipeline optimizer reshapes the view aggregation
227+
pipeline stages to improve performance. The optimization does not
228+
change the query results.
230229

231230
Resource Locking
232231
~~~~~~~~~~~~~~~~

source/includes/collection-audit-event.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ view:
44
- ``viewOn`` field with the database and collection for the view.
55

66
- ``pipeline`` field with the
7-
:doc:`aggregation pipeline </core/aggregation-pipeline>` definition
7+
:ref:`aggregation pipeline <aggregation-pipeline>` definition
88
for the view.

source/includes/fact-use-aggregation-not-map-reduce.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ Starting in MongoDB 5.0, :doc:`map-reduce </core/map-reduce>` is
22
deprecated:
33

44
- Instead of :doc:`map-reduce </core/map-reduce>`, you should use an
5-
:doc:`aggregation pipeline </core/aggregation-pipeline>`. Aggregation
5+
:ref:`aggregation pipeline <aggregation-pipeline>`. Aggregation
66
pipelines provide better performance and usability than map-reduce.
77

8-
- You can rewrite map-reduce operations using :doc:`aggregation
9-
pipeline stages </meta/aggregation-quick-reference>`, such as
8+
- You can rewrite map-reduce operations using :ref:`aggregation
9+
pipeline stages <agg-pipeline-quick-ref>`, such as
1010
:pipeline:`$group`, :pipeline:`$merge`, and others.
1111

1212
- For map-reduce operations that require custom functionality, you can

source/query-api.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ You can use the |query-api| to perform:
2828
or a MongoDB :driver:`driver </>`.
2929

3030
- **Data transformations**. Use
31-
:doc:`aggregation pipelines </core/aggregation-pipeline>` to
31+
:ref:`aggregation pipelines <aggregation-pipeline>` to
3232
reshape your data and perform calculations.
3333

3434
- **Document join support** Use :pipeline:`$lookup` and

source/reference/command.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Aggregation Commands
6262

6363
* - :dbcommand:`aggregate`
6464

65-
- Performs :doc:`aggregation tasks </core/aggregation-pipeline>` such as :pipeline:`$group` using an aggregation pipeline.
65+
- Performs :ref:`aggregation tasks <aggregation-pipeline>` such as :pipeline:`$group` using an aggregation pipeline.
6666

6767
* - :dbcommand:`count`
6868

source/reference/command/aggregate.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Definition
1515

1616
.. dbcommand:: aggregate
1717

18-
Performs aggregation operation using the :doc:`aggregation pipeline
19-
</reference/operator/aggregation-pipeline>`. The pipeline allows users
18+
Performs aggregation operation using the :ref:`aggregation pipeline
19+
<aggregation-pipeline>`. The pipeline allows users
2020
to process data from a collection or other source with a sequence of
2121
stage-based manipulations.
2222

@@ -88,8 +88,7 @@ arguments:
8888

8989
- array
9090

91-
- An array of :doc:`aggregation pipeline stages
92-
</reference/operator/aggregation-pipeline>` that process and
91+
- An array of aggregation pipeline stages that process and
9392
transform the document stream as part of the aggregation
9493
pipeline.
9594

source/reference/command/findAndModify.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ The command takes the following fields:
121121
- If passed a replacement document ``{ <field1>: <value1>, ...}``,
122122
the |operation| performs a replacement.
123123

124-
- Starting in MongoDB 4.2, if passed an :doc:`aggregation pipeline
125-
</core/aggregation-pipeline>` ``[ <stage1>, <stage2>, ... ]``,
124+
- Starting in MongoDB 4.2, if passed an :ref:`aggregation pipeline
125+
<aggregation-pipeline>` ``[ <stage1>, <stage2>, ... ]``,
126126
|operation| modifies the document per the pipeline. The pipeline
127127
can consist of the following stages:
128128

source/reference/command/nav-aggregation.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Aggregation Commands
2222

2323
* - :dbcommand:`aggregate`
2424

25-
- Performs :doc:`aggregation tasks </core/aggregation-pipeline>` such as :pipeline:`$group` using an aggregation pipeline.
25+
- Performs :ref:`aggregation tasks <aggregation-pipeline>` such as :pipeline:`$group` using an aggregation pipeline.
2626

2727
* - :dbcommand:`count`
2828

source/reference/command/serverStatus.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1668,9 +1668,9 @@ metrics
16681668
.. serverstatus:: metrics.aggStageCounters
16691669

16701670
A document that reports on the use of
1671-
:doc:`aggregation pipeline stages
1672-
</reference/operator/aggregation-pipeline/>`. The fields
1673-
in :serverstatus:`metrics.aggStageCounters` are the names of
1671+
:ref:`aggregation pipeline stages
1672+
<aggregation-pipeline-operator-reference>`. The fields in
1673+
:serverstatus:`metrics.aggStageCounters` are the names of
16741674
aggregation pipeline stages. For each pipeline stage,
16751675
:dbcommand:`serverStatus` reports the number of times that stage
16761676
has been executed.

source/reference/command/update.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,8 +402,8 @@ Update with an Aggregation Pipeline
402402
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
403403

404404
Starting in MongoDB 4.2, the update statement field :ref:`u
405-
<update-command-u>` field can accept an :doc:`aggregation pipeline
406-
</core/aggregation-pipeline>` ``[ <stage1>, <stage2>, ... ]`` that
405+
<update-command-u>` field can accept an :ref:`aggregation pipeline
406+
<aggregation-pipeline>` ``[ <stage1>, <stage2>, ... ]`` that
407407
specifies the modifications to perform. The pipeline can consist of
408408
the following stages:
409409

source/reference/map-reduce-to-aggregation-pipeline.txt

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Map-Reduce to Aggregation Pipeline
44

55
.. default-domain:: mongodb
66

7-
An :doc:`aggregation pipeline </core/aggregation-pipeline>` provides
7+
An :ref:`aggregation pipeline <aggregation-pipeline>` provides
88
better performance and usability than a :doc:`map-reduce
99
</core/map-reduce>` operation.
1010

11-
Map-reduce operations can be rewritten using :doc:`aggregation pipeline
12-
operators </meta/aggregation-quick-reference>`, such as
13-
:pipeline:`$group`, :pipeline:`$merge`, and others.
11+
Map-reduce operations can be rewritten using :ref:`aggregation pipeline
12+
operators <agg-pipeline-quick-ref>`, such as :pipeline:`$group`,
13+
:pipeline:`$merge`, and others.
1414

1515
For map-reduce operations that require custom functionality, MongoDB
1616
provides the :group:`$accumulator` and :expression:`$function`
@@ -237,11 +237,10 @@ shows an approximate translation of ``mapFunction`` using the
237237
Examples
238238
--------
239239

240-
Various map-reduce expressions can be rewritten using :doc:`aggregation
241-
pipeline operators </meta/aggregation-quick-reference>`, such as
242-
:pipeline:`$group`, :pipeline:`$merge`, and others, without requiring
243-
custom functions. However, for illustrative purposes, the following
244-
examples provide both alternatives.
240+
Various map-reduce expressions can be rewritten using aggregation
241+
pipeline operators, such as :pipeline:`$group`, :pipeline:`$merge`, and
242+
others, without requiring custom functions. However, for illustrative
243+
purposes, the following examples provide both alternatives.
245244

246245
.. _mr-to-agg-examples1:
247246

source/reference/method.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Collection
2929

3030
* - :method:`db.collection.aggregate()`
3131

32-
- Provides access to the :doc:`aggregation pipeline </core/aggregation-pipeline>`.
32+
- Provides access to the :ref:`aggregation pipeline <aggregation-pipeline>`.
3333

3434
* - :method:`db.collection.bulkWrite()`
3535

source/reference/method/db.collection.aggregate.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ Definition
3737
- array
3838

3939
- A sequence of data aggregation operations or stages. See the
40-
:doc:`aggregation pipeline operators
41-
</reference/operator/aggregation-pipeline>` for details.
40+
:ref:`aggregation pipeline operators <aggregation-pipeline>`
41+
for details.
4242

4343
The method can still accept the pipeline stages as separate
4444
arguments instead of as elements in an array; however, if you do

source/reference/method/db.collection.findAndModify.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,8 @@ Definition
125125
- If passed a replacement document ``{ <field1>: <value1>, ...}``,
126126
the |operation| performs a replacement.
127127

128-
- Starting in MongoDB 4.2, if passed an :doc:`aggregation pipeline
129-
</core/aggregation-pipeline>` ``[ <stage1>, <stage2>, ... ]``,
128+
- Starting in MongoDB 4.2, if passed an :ref:`aggregation pipeline
129+
<aggregation-pipeline>` ``[ <stage1>, <stage2>, ... ]``,
130130
|operation| modifies the document per the pipeline. The pipeline
131131
can consist of the following stages:
132132

source/reference/method/db.collection.updateMany.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -239,10 +239,9 @@ Update with an Aggregation Pipeline
239239
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
240240

241241
Starting in MongoDB 4.2, the :method:`db.collection.updateMany()` method
242-
can accept an :doc:`aggregation pipeline
243-
</core/aggregation-pipeline>` ``[ <stage1>, <stage2>, ... ]`` that
244-
specifies the modifications to perform. The pipeline can consist of
245-
the following stages:
242+
can accept an :ref:`aggregation pipeline <aggregation-pipeline>`
243+
``[ <stage1>, <stage2>, ... ]`` that specifies the modifications to
244+
perform. The pipeline can consist of the following stages:
246245

247246
.. include:: /includes/list-update-agg-stages.rst
248247

source/reference/method/db.collection.updateOne.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,8 @@ Update with an Aggregation Pipeline
230230
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
231231

232232
Starting in MongoDB 4.2, the :method:`db.collection.updateOne()` method
233-
can accept an :doc:`aggregation pipeline
234-
</core/aggregation-pipeline>` ``[ <stage1>, <stage2>, ... ]`` that
233+
can accept an :ref:`aggregation pipeline
234+
<aggregation-pipeline>` ``[ <stage1>, <stage2>, ... ]`` that
235235
specifies the modifications to perform. The pipeline can consist of
236236
the following stages:
237237

source/reference/method/js-collection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Collection Methods
2828

2929
* - :method:`db.collection.aggregate()`
3030

31-
- Provides access to the :doc:`aggregation pipeline </core/aggregation-pipeline>`.
31+
- Provides access to the :ref:`aggregation pipeline <aggregation-pipeline>`.
3232

3333
* - :method:`db.collection.bulkWrite()`
3434

source/reference/operator/aggregation.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Expression Operators
2323
--------------------
2424

2525
These expression operators are available to construct :ref:`expressions
26-
<aggregation-expressions>` for use in the :doc:`aggregation pipeline
27-
stages </reference/operator/aggregation-pipeline>`.
26+
<aggregation-expressions>` for use in the :ref:`aggregation pipeline
27+
stages <aggregation-pipeline>`.
2828

2929
.. include:: /includes/intro-aggregation-operator-expressions.rst
3030

source/reference/operator/aggregation/interface.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Aggregation Commands
2525

2626
* - :dbcommand:`aggregate`
2727

28-
- Performs :doc:`aggregation tasks </core/aggregation-pipeline>` such as :pipeline:`$group` using an aggregation pipeline.
28+
- Performs :ref:`aggregation tasks <aggregation-pipeline>` such as :pipeline:`$group` using an aggregation pipeline.
2929

3030
* - :dbcommand:`count`
3131

@@ -53,8 +53,8 @@ Aggregation Methods
5353

5454
* - :method:`db.collection.aggregate()`
5555

56-
- Provides access to the :doc:`aggregation pipeline
57-
</core/aggregation-pipeline>`.
56+
- Provides access to the :ref:`aggregation pipeline
57+
<aggregation-pipeline>`.
5858

5959

6060
* - :method:`db.collection.mapReduce()`

source/reference/operator/aggregation/merge.txt

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

2929
.. pipeline:: $merge
3030

31-
Writes the results of the :doc:`aggregation pipeline
32-
</core/aggregation-pipeline>` to a specified collection. The
31+
Writes the results of the :ref:`aggregation pipeline
32+
<aggregation-pipeline>` to a specified collection. The
3333
:pipeline:`$merge` operator must be the **last** stage in the
3434
pipeline.
3535

source/reference/operator/query/comment.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Behavior
3232
You can use the :query:`$comment` with any expression taking a query
3333
predicate, such as the query predicate in
3434
:method:`db.collection.updateOne()` or in the :pipeline:`$match` stage
35-
of the :doc:`aggregation pipeline </meta/aggregation-quick-reference>`.
35+
of the :ref:`aggregation pipeline <agg-pipeline-quick-ref>`.
3636
For an example, see :ref:`ex-comment-agg-expression`.
3737

3838
Examples

source/reference/sql-aggregation-comparison.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ SQL to Aggregation Mapping Chart
1414
files in the includes directory. To change the content of the
1515
tables, edit those files.
1616

17-
The :doc:`aggregation pipeline </core/aggregation-pipeline>` allows
17+
The :ref:`aggregation pipeline <aggregation-pipeline>` allows
1818
MongoDB to provide native aggregation capabilities that corresponds to
1919
many common data aggregation operations in SQL.
2020

source/release-notes/3.4.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -782,8 +782,8 @@ Aggregation
782782
New Aggregation Stage for Recursive Search
783783
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
784784

785-
3.4 introduces a stage to the :doc:`aggregation pipeline
786-
</core/aggregation-pipeline>` that allows for recursive search.
785+
3.4 introduces a stage to the :ref:`aggregation pipeline
786+
<aggregation-pipeline>` that allows for recursive search.
787787

788788
.. list-table::
789789
:header-rows: 1
@@ -812,8 +812,8 @@ documents, you may want to classify items by a single category, such as
812812
by the price range, or by multiple categories, such as by price range
813813
as well as separately by the departments.
814814

815-
3.4 introduces stages to the :doc:`aggregation pipeline
816-
</core/aggregation-pipeline>` that allow for faceted search.
815+
3.4 introduces stages to the :ref:`aggregation pipeline
816+
<aggregation-pipeline>` that allow for faceted search.
817817

818818
.. list-table::
819819
:header-rows: 1
@@ -852,8 +852,8 @@ as well as separately by the departments.
852852
New Aggregation Stages to Facilitate Reshaping Documents
853853
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
854854

855-
3.4 introduces stages to the :doc:`aggregation pipeline
856-
</core/aggregation-pipeline>` that faciliate replacing documents as
855+
3.4 introduces stages to the :ref:`aggregation pipeline
856+
<aggregation-pipeline>` that faciliate replacing documents as
857857
well as adding new fields.
858858

859859
.. list-table::
@@ -878,8 +878,8 @@ well as adding new fields.
878878
New Aggregation Stage to Count
879879
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
880880

881-
3.4 introduces a new stage to the :doc:`aggregation pipeline
882-
</core/aggregation-pipeline>` that faciliate counting document.
881+
3.4 introduces a new stage to the :ref:`aggregation pipeline
882+
<aggregation-pipeline>` that faciliate counting document.
883883

884884
.. list-table::
885885
:header-rows: 1

source/release-notes/3.6-compatibility.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ Sorting with a Compound Sort Pattern on Multiple Array Fields with ``aggregate``
244244
````````````````````````````````````````````````````````````````````````````````
245245

246246
In MongoDB 3.6, when sorting in an
247-
:doc:`aggregation pipeline </core/aggregation-pipeline/>`, MongoDB can
247+
:ref:`aggregation pipeline <aggregation-pipeline>`, MongoDB can
248248
no longer sort documents which contain *parallel arrays* in the fields
249249
being sorted on. Arrays are considered parallel if they are sibling
250250
elements of the BSON object. Sort keys involving nested arrays are not

source/release-notes/5.0-compatibility.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -398,8 +398,8 @@ Starting in MongoDB 5.0:
398398
:method:`db.collection.reIndex()` shell method may only be run on
399399
:term:`standalone` instances.
400400

401-
- The number of :doc:`aggregation pipeline stages
402-
</reference/operator/aggregation-pipeline>` allowed in a single
401+
- The number of :ref:`aggregation pipeline stages
402+
<aggregation-pipeline-operator-reference>` allowed in a single
403403
pipeline is limited to 1000.
404404

405405
- Dropping the final collection in a database (or dropping the database

source/sharding.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -398,7 +398,7 @@ Practical MongoDB Aggregations E-Book
398398
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
399399

400400
For more information on how sharding works with
401-
:doc:`aggregations </aggregation>`, read the sharding
401+
:ref:`aggregations <aggregation-pipeline>`, read the sharding
402402
chapter in the `Practical MongoDB Aggregations
403403
<https://www.practical-mongodb-aggregations.com/guides/sharding.html>`__
404404
e-book.

source/tutorial/manage-indexes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ sharded collections until you find the inconsistencies.
203203

204204
The following pipeline is for MongoDB 4.2.4 and above.
205205

206-
#. Define the following :doc:`aggregation pipeline </core/aggregation-pipeline>`:
206+
#. Define the following :ref:`aggregation pipeline <aggregation-pipeline>`:
207207

208208
.. code-block:: javascript
209209

0 commit comments

Comments
 (0)