DOCSP-22847 New Aggregation Toolbar (#412)

* DOCSP-22848 Updating Aggregation Pipeline Builder page to show new toolbar (#403)

* DOCSP-22848 updating aggregation page with new pipeline toolbar

* DOCSP-22848 added step to include run button

* DOCSP-22848 updated screenshots

* DOCSP-22848 updated screenshots

Co-authored-by: Jocelyn Mendez <[email protected]>

* DOCSP-22849 exporting aggregation results (#404)

Co-authored-by: Jocelyn Mendez <[email protected]>

* DOCSP-22962 New Explain Plan for Aggregation Pipeline Builder (#407)

* DOCSP-22962 explain plan for pipelines

* DOCSP-22962 fix image

* DOCSP-22962 fix image

* DOCSP-22962 internal feedback

* DOCSP-22962 rewording

* DOCSP-22962 rewording

* DOCSP-22962 adding ref

* DOCSP-22962 updated screenshot

Co-authored-by: Jocelyn Mendez <[email protected]>

* DOCSP-22847 adding export to agg builder page

* DOCSP-22847 reworked agg-builder example

* DOCSP-22847 reworked agg-builder example

* DOCSP-22847 reworked agg-builder example

* DOCSP-22847 small changes

* DOCSP-22847 desired to target

* DOCSP-22847 removed then

Co-authored-by: Jocelyn Mendez <[email protected]>

Author: jocelyn-mendez1

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-    "esbonio.server.enabled": true
+    "esbonio.server.enabled": true,
+    "esbonio.sphinx.confDir": ""
 }

source/aggregation-pipeline-builder.txt

@@ -40,6 +40,10 @@ You can:
 
 - :ref:`View or change pipeline settings <change-pipeline-settings>`
 
+- :ref:`View the explain plan for pipelines <explain-plan-pipeline>` 
+
+- :ref:`Export Aggregation Results <export-agg-builder-results>`
+
 - :ref:`Specify custom collation <pipeline-custom-collation>`
 
 - :ref:`Create a view from pipeline results <create-a-view>`
@@ -74,10 +78,18 @@ Open a Saved Pipeline
 ---------------------
 
 1. Click the :guilabel:`Folder` icon at the top left of the
-   pipeline builder.
+   pipeline builder. 
+
+   .. figure:: /images/compass/saved-pipeline-icon.png
+         :figwidth: 316px
+         :alt: Saved Pipeline Icon
 
 #. Hover over the pipeline you want to open and click :guilabel:`Open`.
 
+   .. figure:: /images/compass/saved-pipelines.png
+         :figwidth: 316px
+         :alt: Saved Pipelines List 
+
 #. In the modal, click :guilabel:`Open Pipeline`.
 
 .. note::
@@ -139,11 +151,6 @@ To view and change pipeline settings:
       * - .. data:: Number of Preview Documents
         - Number of documents to show in the preview.
         - 20
-      * - .. data:: Max Time
-        - Cumulative time limit in milliseconds for processing
-          the pipeline. Use this option to limit the waiting time if
-          the pipeline stops responding.
-        - 5000
       * - .. data:: Limit
         - When :guilabel:`Sample Mode` is enabled, specifies the number of
           documents passed to :pipeline:`$group`, :pipeline:`$bucket`, and
@@ -154,6 +161,27 @@ To view and change pipeline settings:
 #. Click :guilabel:`Apply` to save changes and close the
    :guilabel:`Settings` panel.
 
+.. _explain-plan-pipeline:
+
+Explain Plan for Pipelines
+--------------------------
+
+Use the :guilabel:`Explain` button to view the explain plan that helps you 
+understand the performance of your pipelines. You can view the explain plan 
+at any point while creating or editing your pipeline. 
+
+To view your pipeline explain plan, click :guilabel:`Explain` in the 
+right corner of your pipeline toolbar.
+
+.. figure:: /images/compass/agg-explain-plan.png
+    :alt: Aggregation Pipeline Builder Explain Plan
+
+Your results are presented in this format: 
+
+.. figure:: /images/compass/agg-explain-results.png
+    :figwidth: 450px
+    :alt: Aggregation Pipeline Builder Explain Results
+
 .. _pipeline-custom-collation:
 
 Specify Custom Collation
@@ -165,11 +193,55 @@ letter case and accent marks.
 
 To specify a custom collation:
 
-#. Click the :guilabel:`Collation` button at the top of the pipeline
-   builder.
+#. Click :guilabel:`More Options` in the top right corner of the pipeline 
+   builder. 
+
+   .. figure:: /images/compass/options-collation.png
+        :alt: Collation Option
 
 #. Enter your collation document.
 
+.. _export-agg-builder-results:
+
+Export Aggregation Results
+--------------------------
+
+To export results from your aggregation pipeline:
+
+#. Connect to the deployment containing the
+   :doc:`collection </collections>` you wish to export data from.
+
+   To learn how to connect to a deployment, see
+   :ref:`connect-run-compass`.
+
+#. Navigate to your target collection.
+
+   You can either select the collection from the
+   :doc:`Collections </collections>` tab or click the collection 
+   in the left-hand pane. 
+
+#. Create an aggregation pipeline and run for results.
+
+   To learn how to create an aggregation pipeline, see :ref:`Create an 
+   Aggregation Pipeline <create-agg-pipeline>`. 
+
+#. Click :guilabel:`Export`.
+
+#. Choose the appropriate file type.
+
+   Under :guilabel:`Select Export File Type`, select either 
+   :guilabel:`JSON` or :guilabel:`CSV`. If you select :guilabel:`JSON`,
+   your data is exported to the target file as an array of JSON objects.
+
+#. Under :guilabel:`Output`, choose where to export the file to.
+
+   .. figure:: /images/compass/aggregation-export.png
+      :alt: Export Aggregation Data
+      :width: 70%
+
+#. Click :guilabel:`Export`. 
+
+
 .. _create-a-view:
 
 Create a View from Pipeline Results
@@ -192,91 +264,45 @@ for a collection with airline data. You can download this
 dataset from the following link:
 `air_airlines.json <https://raw.githubusercontent.com/mongodb/docs-assets/compass/air_airlines.json>`__.
 
-For instructions on importing JSON data into your cluster, see
-:manual:`mongoimport </reference/program/mongoimport/>`. This
-example assumes you have the data in the
+For instructions on importing JSON data into your cluster, see :ref:`Import Data 
+into a Collection <import-data>`. This example assumes you have the data in the
 ``example.air_airlines`` namespace.
 
+Procedure
+~~~~~~~~~
 
-Create the Pipeline
-~~~~~~~~~~~~~~~~~~~
+1. Connect to a database deployment. For information on how to connect to a 
+   database deployment, see :atlas:`Connect via Compass </compass-connection/>`.
 
-The following pipeline has two aggregation stages:
-:pipeline:`$group` and :pipeline:`$match`.
+#. Select the ``example`` database where the ``air_airlines`` collection 
+   exists. 
 
-- The ``$group`` stage groups documents by their
-  ``active`` status and ``country``. The stage also adds
-  a new ``flightCount`` field containing the number
-  of documents in each group.
+#. Create the Pipeline
 
-- The ``$match`` stage filters documents to return documents
-  with a ``flightCount`` value greater than or equal to ``5``.
+   |
 
-.. figure:: /images/compass/agg-builder-full-example.png
-   :alt: Aggregation Builder Full Example
+   The following pipeline has two aggregation stages:
+   :pipeline:`$group` and :pipeline:`$match`.
 
-Copy the Pipeline to the Clipboard
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+   - The ``$group`` stage groups documents by their
+     ``active`` status and ``country``. The stage also adds
+     a new ``flightCount`` field containing the number
+     of documents in each group.
 
-1. Click the :guilabel:`Export to Language` button at the top
-   of the pipeline builder. The following page displays:
+   - The ``$match`` stage filters documents to return documents
+     with a ``flightCount`` value greater than or equal to ``5``.
 
-   .. figure:: /images/compass/agg-builder-example-export-to-node.png
-      :alt: Aggregation Builder Full Example
+     .. figure:: /images/compass/agg-builder-full-example.png
+        :alt: Aggregation Builder Full Example
 
-#. Click the :guilabel:`Copy` button in the :guilabel:`My Pipeline`
-   panel on the left. |compass-short| copies the pipeline to your
-   clipboard in :binary:`~mongo` shell syntax. You will use the
-   pipeline in the following section.
+#. Run the Pipeline.
 
-Run the Pipeline
-~~~~~~~~~~~~~~~~
-
-1. Launch and connect to a
-   :manual:`mongod </reference/program/mongod/>` instance which contains the imported ``air_airlines.json`` dataset.
-   
-#. Switch to the ``example`` database where the ``air_airlines``
-   collection exists:
-
-   .. code-block:: javascript
-
-      use example
-
-#. Run the following command to run the pipeline created in
-   |compass-short|:
-
-   .. code-block:: javascript
-
-      db.air_airlines.aggregate([{
-        $group: {
-          _id: {
-            active: '$active',
-            country: '$country'
-          },
-          flightCount: {
-            $sum: 1
-          }
-        }
-      }, {
-        $match: {
-          flightCount: {
-            $gte: 5
-          }
-        }
-      }])
+   Click :guilabel:`Run` at the top right of the pipeline builder.
 
 The pipeline returns documents, as shown in the following abbreviated example:
 
-.. code-block:: javascript
-
-   { "_id" : { "active" : "Y", "country" : "Nigeria" }, "flightCount" : 5 }
-   { "_id" : { "active" : "N", "country" : "Switzerland" }, "flightCount" : 46 }
-   { "_id" : { "active" : "N", "country" : "Bahrain" }, "flightCount" : 8 }
-   { "_id" : { "active" : "N", "country" : "Guinea-Bissau" }, "flightCount" : 8 }
-   { "_id" : { "active" : "N", "country" : "Argentina" }, "flightCount" : 14 }
-   { "_id" : { "active" : "N", "country" : "Moldova" }, "flightCount" : 17 }
-   { "_id" : { "active" : "Y", "country" : "Israel" }, "flightCount" : 6 }
-   { "_id" : { "active" : "N", "country" : "Finland" }, "flightCount" : 7 }
+.. figure:: /images/compass/airline-example-results.png
+   :alt: Airline Pipeline Results
 
 .. toctree::
    :titlesonly:

source/images/compass/agg-builder-example-export-to-node.png

@@ -23,6 +23,8 @@ or from a collection, navigate to the detailed collection view by either
 selecting the collection from the :doc:`Databases </databases>` tab or
 clicking the collection in the left-side navigation.
 
+.. _import-data:
+
 Import Data into a Collection
 -----------------------------
 
@@ -124,8 +126,10 @@ Export Data from a Collection
 
 |compass| can export data from a collection as either a
 **JSON** or **CSV** file. If you specify a
-:ref:`filter <query-bar-filter>`, |compass-short| only exports 
-documents which match the specified query.
+:ref:`filter <query-bar-filter>` or :ref:`aggregation pipeline 
+<compass-agg-builder>` for your collection, |compass-short| only exports 
+documents which match the specified query or 
+pipeline results.
 
 Behavior
 ~~~~~~~~
@@ -158,6 +162,46 @@ Procedure
       .. include:: /includes/steps/export-filter.rst
 
       .. include:: /includes/fact-export-progress-bar.rst
+   
+   .. tab:: Export Aggregation Results
+      :tabid: export-Aggregation
+
+      To export results from your aggregation pipeline:
+
+      .. procedure::
+         :style: normal
+
+         .. step:: Connect to the deployment containing the :doc:`collection </collections>` you wish to export data from.
+
+            To learn how to connect to a deployment, see
+            :ref:`connect-run-compass`.
+
+         .. step:: Navigate to your target collection.
+
+            You can either select the collection from the
+            :doc:`Collections </collections>` tab or click the collection 
+            in the left-hand pane. 
+
+         .. step:: Create an aggregation pipeline and run for results. 
+
+            To learn how to create an aggregation pipeline, see :ref:`Create an 
+            Aggregation Pipeline <create-agg-pipeline>`. 
+
+         .. step:: Click :guilabel:`Export`.
+
+         .. step:: Choose the appropriate file type.
+
+            Under :guilabel:`Select Export File Type`, select either 
+            :guilabel:`JSON` or :guilabel:`CSV`. If you select :guilabel:`JSON`,
+            your data is exported to the target file as an array of JSON objects.
+
+            Then, under :guilabel:`Output`, choose where to export the file to.
+
+            .. figure:: /images/compass/aggregation-export.png
+               :alt: Export Aggregation Data
+               :width: 70%
+
+         .. step:: Click :guilabel:`Export`. 
 
 Import and Export Data from the Command Line
 --------------------------------------------

source/images/compass/agg-builder-exclude-stage-example.png

@@ -23,4 +23,4 @@ To save your pipeline:
          :figwidth: 316px
          :alt: Name your pipeline
 
-   .. step:: Click :guilabel:`Save`
+   .. step:: Click :guilabel:`Save`

source/images/compass/agg-builder-export-dropdown.png

@@ -50,5 +50,27 @@ content: |
 
          .. figure:: /images/compass/agg-builder-exclude-stage-example.png
             :alt: Aggregation Builder exclude stage example
-...
+---
+title: Run the pipeline.
+level: 4
+ref: run-aggregation
+content: |
+  Click :guilabel:`Run` at the top right of the pipeline builder. 
+  |compass-short| returns your results in the document view.
+
+  .. warning::
 
+     When you click :guilabel:`Run`, the aggregation runs against the entire 
+     collection.
+
+  .. figure:: /images/compass/run-results.png
+       :alt: Results after Running Aggregation
+---
+title: Edit the pipeline.
+level: 4
+ref: edit-after-run
+content: |
+   Click :guilabel:`Edit` at the top of your pipeline toolbar to return to the 
+   aggregation pipeline builder. You can make changes to your pipeline from 
+   there.
+...

source/images/compass/agg-builder-full-example.png

@@ -74,4 +74,4 @@ content: |
 title: Click :guilabel:`Close`.
 level: 4
 ref: click-close
-...
+...

source/images/compass/agg-builder-match-stage.png

@@ -6,7 +6,7 @@ content: |
   To learn how to connect to a deployment, see
   :ref:`connect-run-compass`.
 ---
-title: Navigate to your desired collection.
+title: Navigate to your target collection.
 level: 4
 ref: select-collection
 content: |