DOCSP-49230 - Aggregation stages (builders) #591

mongoKart · 2025-04-15T01:58:08Z

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-49230

Staging Links

aggregation/stages

aggregation

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?
Are the page titles greater than 20 characters long and SEO relevant?

netlify · 2025-04-15T01:58:25Z

✅ Deploy Preview for docs-csharp ready!

Name	Link
🔨 Latest commit	`900c152`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-csharp/deploys/67fe9e045479fb0008f1377c
😎 Deploy Preview	https://deploy-preview-591--docs-csharp.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mongoKart · 2025-04-15T13:25:53Z

source/aggregation/stages.txt

+  * - :manual:`$bucket </reference/operator/aggregation/bucket/>` 
+    - Categorizes incoming documents into groups, called buckets,
+      based on a specified expression and bucket boundaries.
+    - :ref:`Bucket() <csharp-aggregation-bucket>`


All method links are broken pending future PRs

mongoKart · 2025-04-15T13:46:47Z

source/aggregation/stages.txt

+    - Builders Method
+
+  * - :manual:`$bucket </reference/operator/aggregation/bucket/>` 
+    - Categorizes incoming documents into groups, called buckets,


Stage descriptions were taken (almost) verbatim from server docs

rustagir

good work!

rustagir · 2025-04-15T15:59:09Z

source/aggregation.txt

+   :titlesonly:
+   :maxdepth: 1
+
+   Stages </aggregation/stages>


S: consider titling this Pipeline Stages

rustagir · 2025-04-15T15:59:48Z

source/aggregation/stages.txt

+.. _csharp-aggregation-stages:
+
+==================
+Aggregation Stages


S: consider calling this pipeline stages or aggregation pipeline stages

rustagir · 2025-04-15T16:00:34Z

source/aggregation/stages.txt

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


S: since this guide is more about creating the stages than adding them to a pipeline

Suggested change

On this page, you can learn how to create an aggregation pipeline and add stages to it

by using methods in the {+driver-short+}.

On this page, you can learn how to create an aggregation pipeline and pipeline stages

by using methods in the {+driver-short+}.

source/aggregation/stages.txt

rustagir · 2025-04-15T16:22:02Z

source/aggregation/stages.txt

+in the aggregation pipeline, but doesn't provide type hints or type safety.
+
+The following code example shows how to add ``$unset``, an aggregation
+stage without a corresponding method, to an empty aggregation pipeline:


Suggested change

stage without a corresponding method, to an empty aggregation pipeline:

stage without a corresponding builder method, to an empty aggregation pipeline:

rustagir · 2025-04-15T16:23:11Z

source/aggregation/stages.txt

+Aggregation Stage Methods
+-------------------------
+
+The following table lists the builders methods in the {+driver-short+} that correspond


Suggested change

The following table lists the builders methods in the {+driver-short+} that correspond

The following table lists the builder methods in the {+driver-short+} that correspond

rustagir · 2025-04-15T16:25:07Z

source/aggregation/stages.txt

+to stages in the aggregation pipeline. For more information about an aggregation stage,
+click the stage name. For more information about a builders method, click the
+method name. If an aggregation stage isn't in the table, you must use the
+:ref:`BsonDocument <csharp-aggregation-stages-bsondocument>` syntax to add the stage
+to your pipeline.


Suggested change

to stages in the aggregation pipeline. For more information about an aggregation stage,

click the stage name. For more information about a builders method, click the

method name. If an aggregation stage isn't in the table, you must use the

:ref:`BsonDocument <csharp-aggregation-stages-bsondocument>` syntax to add the stage

to your pipeline.

to stages in the aggregation pipeline. To learn more about an aggregation stage,

follow the link from the stage name to the Server manual reference. To learn more about a

builder method, follow the link from the method name to the dedicated guide. If an

aggregation stage isn't in the table, the driver does not provide a builder method, so you must use the

:ref:`BsonDocument <csharp-aggregation-stages-bsondocument>` syntax to add the stage

to your pipeline.

rustagir · 2025-04-15T16:26:24Z

source/aggregation/stages.txt

+     - Performs a recursive search on a collection. To each output
+       document, adds a new array field that contains the traversal
+       results of the recursive search for that document.


Suggested change

- Performs a recursive search on a collection. To each output

document, adds a new array field that contains the traversal

results of the recursive search for that document.

- Performs a recursive search on a collection. This method adds

a new array field to each output document that contains the traversal

results of the recursive search for that document.

source/aggregation/stages.txt

rustagir · 2025-04-15T16:28:13Z

source/aggregation/stages.txt

+-----------------
+
+To learn more about assembling an aggregation pipeline, see
+:manual:`Aggregation Pipeline </core/aggregation-pipeline/>`.


S: add link target

Suggested change

:manual:`Aggregation Pipeline </core/aggregation-pipeline/>`.

:manual:`Aggregation Pipeline </core/aggregation-pipeline/>` in the Server manual.

applies everywhere

rustagir

dont need to take another look unless you request. Nice job!

rustagir · 2025-04-15T17:18:09Z

source/aggregation/stages.txt

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


S; wording still awkward, maybe try this wording as its actually not super important to know that the stage doesnt have a builder method (since you can do this with any stage)

Suggested change

The following code example shows how to add ``$unset``, an aggregation

stage without a corresponding builder method, to an empty aggregation pipeline:

The following code example shows how to add an ``$unset`` stage to an empty aggregation pipeline:

rustagir · 2025-04-15T17:18:43Z

source/aggregation/stages.txt

+.. code-block:: csharp
+
+   var pipeline = new EmptyPipelineDefinition<BsonDocument>()
+           .AppendStage<BsonDocument, BsonDocument, BsonDocument>("{ $unset: "field1" }");


S: text highlighting weird, do you need to escape the characters as there's multiple sets of " marks?

rustagir · 2025-04-15T17:19:50Z

source/aggregation/stages.txt

+       available for self-managed deployments. To learn more, see
+       :atlas:`Atlas Search Aggregation Pipeline Stages
+       </reference/atlas-search/query-syntax>` in the Atlas documentation.


S: change the link to go to the atlas vector search overview

mongoKart added 6 commits April 9, 2025 20:28

wip

410d18d

wip

a06c194

wip

e410530

wip

1c89369

wip

aa37a1b

first draft

b1ab3a6

remove stage files

e29ccda

mongoKart commented Apr 15, 2025

View reviewed changes

mongoKart added 3 commits April 15, 2025 08:36

edits

8778f5f

add stages to snooty

6457609

small fixes

a53b35b

mongoKart commented Apr 15, 2025

View reviewed changes

mongoKart added 5 commits April 15, 2025 08:51

table width

e932b5a

table widths

1fb55d0

table fix

9d51161

table widths

aac403a

table widths

11ecea4

rustagir self-requested a review April 15, 2025 15:38

rustagir requested changes Apr 15, 2025

View reviewed changes

rr feedback

1129cc8

mongoKart requested a review from rustagir April 15, 2025 17:12

rustagir approved these changes Apr 15, 2025

View reviewed changes

rr feedback

900c152

mongoKart requested review from a team and JamesKovacs and removed request for a team April 15, 2025 17:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-49230 - Aggregation stages (builders) #591

DOCSP-49230 - Aggregation stages (builders) #591

mongoKart commented Apr 15, 2025 •

edited by github-actions bot

Loading

netlify bot commented Apr 15, 2025 •

edited

Loading

mongoKart Apr 15, 2025 •

edited

Loading

mongoKart Apr 15, 2025

rustagir left a comment

rustagir Apr 15, 2025

rustagir Apr 15, 2025

rustagir Apr 15, 2025

rustagir Apr 15, 2025

rustagir Apr 15, 2025

rustagir Apr 15, 2025

rustagir Apr 15, 2025

rustagir Apr 15, 2025

rustagir Apr 15, 2025

rustagir left a comment

rustagir Apr 15, 2025

rustagir Apr 15, 2025

rustagir Apr 15, 2025

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

	stage without a corresponding method, to an empty aggregation pipeline:
	stage without a corresponding builder method, to an empty aggregation pipeline:

	The following table lists the builders methods in the {+driver-short+} that correspond
	The following table lists the builder methods in the {+driver-short+} that correspond

	:manual:`Aggregation Pipeline </core/aggregation-pipeline/>`.
	:manual:`Aggregation Pipeline </core/aggregation-pipeline/>` in the Server manual.

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

DOCSP-49230 - Aggregation stages (builders) #591

Are you sure you want to change the base?

DOCSP-49230 - Aggregation stages (builders) #591

Conversation

mongoKart commented Apr 15, 2025 • edited by github-actions bot Loading

Pull Request Info

Staging Links

Self-Review Checklist

netlify bot commented Apr 15, 2025 • edited Loading

✅ Deploy Preview for docs-csharp ready!

mongoKart Apr 15, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustagir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustagir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mongoKart commented Apr 15, 2025 •

edited by github-actions bot

Loading

netlify bot commented Apr 15, 2025 •

edited

Loading

mongoKart Apr 15, 2025 •

edited

Loading