Skip to content

Commit 1129cc8

Browse files
committed
rr feedback
1 parent 11ecea4 commit 1129cc8

File tree

2 files changed

+34
-22
lines changed

2 files changed

+34
-22
lines changed

source/aggregation.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Aggregation Operations
2121
:titlesonly:
2222
:maxdepth: 1
2323

24-
Stages </aggregation/stages>
24+
Pipeline Stages </aggregation/stages>
2525

2626
Overview
2727
--------

source/aggregation/stages.txt

+33-21
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _csharp-aggregation-stages:
22

3-
==================
4-
Aggregation Stages
5-
==================
3+
===========================
4+
Aggregation Pipeline Stages
5+
===========================
66

77
.. facet::
88
:name: genre
@@ -20,20 +20,20 @@ Aggregation Stages
2020
Overview
2121
--------
2222

23-
On this page, you can learn how to create an aggregation pipeline and add stages to it
23+
On this page, you can learn how to create an aggregation pipeline and pipeline stages
2424
by using methods in the {+driver-short+}.
2525

2626
Build an Aggregation Pipeline
2727
-----------------------------
2828

29-
You can use the {+driver-short+} to build an aggregation pipeline by using builders
29+
You can use the {+driver-short+} to build an aggregation pipeline by using builder
3030
methods or BSON documents. See the following sections to learn more about each of these
3131
approaches.
3232

33-
.. _csharp-aggregation-stages-builders:
33+
.. _csharp-aggregation-stages-builder:
3434

35-
Builders
36-
~~~~~~~~
35+
Builder Methods
36+
~~~~~~~~~~~~~~~
3737

3838
You can build a type-safe aggregation pipeline in the following ways:
3939

@@ -61,7 +61,7 @@ or :guilabel:`Aggregate` tab to see the corresponding code for each approach:
6161
.Merge(...);
6262

6363
// Executes the aggregation pipeline
64-
var results = collection.Aggregate(pipeline).ToList();
64+
var results = collection.Aggregate(pipeline);
6565

6666
.. tab:: Aggregate
6767
:tabid: aggregate
@@ -86,13 +86,14 @@ to construct a stage in the Query API syntax. Then, pass the BSON document to th
8686
in the aggregation pipeline, but doesn't provide type hints or type safety.
8787

8888
The following code example shows how to add ``$unset``, an aggregation
89-
stage without a corresponding method, to an empty aggregation pipeline:
89+
stage without a corresponding builder method, to an empty aggregation pipeline:
9090

9191
.. code-block:: csharp
9292

93-
var pipeline = new EmptyPipelineDefinition<BsonDocument>().AppendStage<BsonDocument, BsonDocument, BsonDocument>("{ $unset: "field1" }");
93+
var pipeline = new EmptyPipelineDefinition<BsonDocument>()
94+
.AppendStage<BsonDocument, BsonDocument, BsonDocument>("{ $unset: "field1" }");
9495

95-
.. note::
96+
.. important::
9697

9798
If you use a ``BsonDocument`` to define a pipeline stage, the driver doesn't
9899
recognize any ``BsonClassMap`` attributes, serialization attributes, or
@@ -102,10 +103,14 @@ stage without a corresponding method, to an empty aggregation pipeline:
102103
Aggregation Stage Methods
103104
-------------------------
104105

105-
The following table lists the builders methods in the {+driver-short+} that correspond
106-
to stages in the aggregation pipeline. For more information about an aggregation stage,
107-
click the stage name. For more information about a builders method, click the
108-
method name. If an aggregation stage isn't in the table, you must use the
106+
The following table lists the builder methods in the {+driver-short+} that correspond
107+
to stages in the aggregation pipeline. To learn more about an aggregation stage,
108+
follow the link from the method name to its reference page in the {+mdb-server+} manual.
109+
To learn more about a builder method, follow the link from the method name to its
110+
dedicated page.
111+
112+
If an aggregation stage isn't in the table, the driver doesn't provide a builder method for
113+
it. In this case, you must use the
109114
:ref:`BsonDocument <csharp-aggregation-stages-bsondocument>` syntax to add the stage
110115
to your pipeline.
111116

@@ -115,7 +120,7 @@ to your pipeline.
115120

116121
* - Aggregation Stage
117122
- Description
118-
- Builders Method
123+
- Builder Method
119124

120125
* - :manual:`$bucket </reference/operator/aggregation/bucket/>`
121126
- Categorizes incoming documents into groups, called buckets,
@@ -166,8 +171,8 @@ to your pipeline.
166171
- :ref:`Facet() <csharp-aggregation-facet>`
167172

168173
* - :manual:`$graphLookup </reference/operator/aggregation/graphLookup/>`
169-
- Performs a recursive search on a collection. To each output
170-
document, adds a new array field that contains the traversal
174+
- Performs a recursive search on a collection. This method adds
175+
a new array field to each output document that contains the traversal
171176
results of the recursive search for that document.
172177
- :ref:`GraphLookup() <csharp-aggregation-graphlookup>`
173178

@@ -324,16 +329,23 @@ to your pipeline.
324329
:abbr:`ENN (Exact Nearest Neighbor)` search on a
325330
vector in the specified field of an
326331
:atlas:`Atlas </reference/atlas-search/query-syntax/>` collection.
332+
333+
This stage is available only for MongoDB Atlas clusters, and is not
334+
available for self-managed deployments. To learn more, see
335+
:atlas:`Atlas Search Aggregation Pipeline Stages
336+
</reference/atlas-search/query-syntax>` in the Atlas documentation.
327337
- :ref:`VectorSearch() <csharp-aggregation-vectorsearch>`
328338

329339
API Documentation
330340
-----------------
331341

332342
To learn more about assembling an aggregation pipeline, see
333-
:manual:`Aggregation Pipeline </core/aggregation-pipeline/>`.
343+
:manual:`Aggregation Pipeline </core/aggregation-pipeline/>` in the {+mdb-server+}
344+
manual.
334345

335346
To learn more about creating pipeline stages, see
336-
:manual:`Aggregation Stages </reference/operator/aggregation-pipeline/>`.
347+
:manual:`Aggregation Stages </reference/operator/aggregation-pipeline/>` in the
348+
{+mdb-server+} manual.
337349

338350
For more information about the methods and classes used on this page, see the
339351
following API documentation:

0 commit comments

Comments
 (0)