Skip to content

Commit bf57a6f

Browse files
authored
DOCSP-27087 adding add pipeline text view section (#446)
* DOCSP-27087 adding add pipeline text view section * add preview note * indent * image * stage view yaml content * png * figwidth * figwidth all * enhance * image name * image update * remove warning * bold * guilabel * update * - * codeblock * update image * build errors * indent * Internal review feedback1 * line break * add create aggregation pipeline blurb * capatilize * Internal feedback 2 * pipeline preview expand * update picture * figure update * screenshot blackbar
1 parent f8ed88d commit bf57a6f

8 files changed

+73
-0
lines changed

source/aggregation-pipeline-builder.txt

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,70 @@ Limitations
7373
Create an Aggregation Pipeline
7474
------------------------------
7575

76+
Aggregation pipelines can be created in two seperate modes:
77+
78+
- Stage View Mode, a visual click-based pipeline editor that
79+
preloads pipeline syntax based on your selected stages.
80+
81+
- Text View Mode, a text-based pipeline editor that accepts raw
82+
pipeline syntax.
83+
84+
.. _create-agg-pipeline-stageview:
85+
86+
Stage View Mode
87+
~~~~~~~~~~~~~~~
88+
|
89+
7690
.. include:: /includes/steps/create-agg-pipeline.rst
7791

92+
.. _create-agg-pipeline-textview:
93+
94+
Text View Mode
95+
~~~~~~~~~~~~~~
96+
|
97+
98+
.. procedure::
99+
:style: normal
100+
101+
.. step:: In the aggregation pipeline pane, click the
102+
:guilabel:`</> Text` toggle switch to enable text mode for
103+
pipeline editing.
104+
105+
.. figure:: /images/compass/agg-builder-textview-toggle-on.png
106+
:alt: Toggle textmode on
107+
108+
.. step:: Enter valid aggregation syntax in the text editor.
109+
The following example pipeline limits the query results to ``4``
110+
documents.
111+
112+
.. code-block:: javascript
113+
114+
[ { "$limit" : 4 } ]
115+
116+
.. figure:: /images/compass/agg-builder-textview-edit.png
117+
:alt: Edit the text aggregation pipeline
118+
119+
.. step:: **(Optional)** If preview mode is enabled, you can
120+
click :guilabel:`Output Options` in the Pipeline Output pane to
121+
expand all nested fields and documents within the
122+
preview results.
123+
124+
.. figure:: /images/compass/agg-builder-textview-expand-pipeline-preview.png
125+
:alt: Pipeline Output preview
126+
127+
.. step:: Click :guilabel:`Run` at the top right of the pipeline builder.
128+
|compass-short| returns your results in the document view.
129+
130+
.. figure:: /images/compass/agg-builder-textview-agg-results.png
131+
:alt: Results after Running Aggregation
132+
133+
.. step:: **(Optional)** Click the :guilabel:`Output Options` dropdown
134+
and select :guilabel:`Expand all fields` to expand all nested
135+
fields and documents within the query results.
136+
137+
.. figure:: /images/compass/agg-builder-textview-expand-results.png
138+
:alt: Expand the aggregation pipeline results
139+
78140
.. _save-agg-pipeline:
79141

80142
Save a Pipeline
8.73 KB
Loading
106 KB
Loading
112 KB
Loading
95.3 KB
Loading
124 KB
Loading
9.03 KB
Loading

source/includes/steps-create-agg-pipeline.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
title: Toggle Stage View Mode
2+
level: 4
3+
ref: select-stage-view-mode
4+
content: |
5+
6+
In the aggregation pipeline pane, ensure the
7+
:guilabel:`{} Stages` toggle switch is selected:
8+
9+
.. figure:: /images/compass/agg-builder-stageview-toggle-on.png
10+
:alt: Toggle on stage view mode
11+
---
112
title: Add an aggregation pipeline stage.
213
level: 4
314
ref: add-pipeline-stage

0 commit comments

Comments
 (0)