Skip to content

Commit a1e7489

Browse files
committed
(DOCSP-6646) Adding View Aggregation Pipeline section to View and Export Chart Data (#253)
* (DOCSP-6646) Adding View Aggregation Pipeline section, editing Get Chart Data copy * Formatting for review * Changes based on feedback * Changes based on feedback
1 parent 933186c commit a1e7489

File tree

1 file changed

+42
-17
lines changed

1 file changed

+42
-17
lines changed

source/view-export-chart-data.txt

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ View Source Documents
2828

2929
Once you have selected a :doc:`data source <data-sources>` for your
3030
chart, you can view 20 sample documents from that data source by
31-
clicking the :guilabel:`View Source Documents` menu option.
31+
clicking the :guilabel:`View Source Documents` from the
32+
:icon-fa5:`ellipsis-h` menu.
3233

3334
.. note::
3435
If you want to explore your data source beyond 20 sample documents,
@@ -50,30 +51,54 @@ data source that considers:
5051

5152
- Filters applied in the :ref:`Filter Tab <filter-tab>`
5253

54+
.. _view-aggregation-pipeline:
55+
56+
View Aggregation Pipeline
57+
-------------------------
58+
59+
After you have configured a valid chart, you can view the source query
60+
for the chart. MongoDB Charts uses a special type of query to create a
61+
chart called an
62+
:manual:`aggregation pipeline </core/aggregation-pipeline>`. To view
63+
the query, click :guilabel:`View Aggregation Pipeline` from the
64+
:icon-fa5:`ellipsis-h` menu. This aggregation pipeline includes the
65+
stages that both the data source and the Chart Builder apply.
66+
67+
.. important::
68+
69+
Some Chart Builder :doc:`configuration options </customize-charts>`
70+
don't apply aggregation stages. These options are applied to a
71+
chart's visualization and do not affect the underlying data.
72+
73+
To use the pipeline in other MongoDB tools, such as
74+
:compass:`Compass </>` or the :manual:`mongo shell </mongo>`, click
75+
:icon-fa5:`copy` next to the pipeline in the
76+
:guilabel:`Aggregation Pipeline` modal.
77+
5378
.. _get-chart-data:
5479

5580
Get Chart Data
5681
--------------
5782

58-
After you have configured a valid chart, you can view the data
59-
displayed on the chart as a table. Each row in the table represents a
60-
data point. To view the chart data, click the :guilabel:`Get Chart Data`
61-
menu option.
62-
63-
From the :guilabel:`Chart Data` dialog, you can download your
64-
chart data as a CSV or JSON file. This is useful for analyzing data
65-
with third-party tools.
83+
After you have configured a valid chart, you can view and export the
84+
underlying data as a table. To view the chart data, click the
85+
:guilabel:`Get Chart Data` from the :icon-fa5:`ellipsis-h` menu. Each
86+
row in the table represents a data point.
6687

67-
.. admonition:: Considerations
88+
.. admonition:: Data Table Differs from Chart Visualization
6889
:class: important
6990

70-
Some Chart Builder configuration options (e.g. the :guilabel:`Limit
71-
Results` option and the :guilabel:`Multiplier` field-level option)
72-
apply only to the chart visualization and do not affect the
73-
underlying data. The :guilabel:`Chart Data` table displays
74-
underlying data, meaning some configuration options you see
75-
reflected on a chart may not be applied to the table. Review your
76-
data to verify its contents.
91+
Some configuration options you see reflected on a chart
92+
visualization are not applied to the data table. The
93+
:guilabel:`Chart Data` table displays underlying data retrieved
94+
with your full aggregation pipeline, and not all Chart Builder
95+
configuration options apply aggregation stages. Review your data to
96+
verify its contents.
97+
98+
If you want to analyze your underlying data with a third-party tool,
99+
you can download your data from the :guilabel:`Chart Data` modal. To
100+
download your data, click :guilabel:`Download - CSV` or
101+
:guilabel:`Download - JSON`.
77102

78103
.. figure:: /images/charts/editor-chart-data.png
79104
:figwidth: 60%

0 commit comments

Comments
 (0)