DOCSP-5629 POC: videos - agg pipeline

Author: kay-kim

Makefile

@@ -36,11 +36,16 @@ test: html ## Runs test framework over the corpus
 
 html: examples ## Builds this branch's HTML under build/<branch>/html
 	giza make html
+	# TEMP copy of video file. Remove once video infrastructure in place.
+	if [ -f source/images/agg-pipeline.mp4 ]; then cp source/images/agg-pipeline.mp4 build/${GIT_BRANCH}/html/_images/; fi 
+	
 
 publish: examples ## Builds this branch's publishable HTML and other artifacts under build/public
 	if [ ${GIT_BRANCH} = master ]; then rm -rf build/master build/public; fi
 	giza make publish
 	if [ ${GIT_BRANCH} = master ]; then mut-redirects config/redirects -o build/public/.htaccess; fi
+	# TEMP copy of video file. Remove once video infrastructure in place.
+	if [ -f source/images/agg-pipeline.mp4 ]; then cp source/images/agg-pipeline.mp4 build/public/${GIT_BRANCH}/_images/; cp source/images/agg-pipeline.mp4 build/${GIT_BRANCH}/html/_images/; cp source/images/agg-pipeline.mp4 build/${GIT_BRANCH}/dirhtml/_images/;fi
 
 # - Enter build/<branch>/html, and recurse over each regular file
 #   <basename>/<filename>.

source/aggregation.txt

@@ -27,7 +27,36 @@ Aggregation Pipeline
 MongoDB's :doc:`aggregation framework
 </core/aggregation-pipeline>` is modeled on the concept of data
 processing pipelines. Documents enter a multi-stage pipeline that
-transforms the documents into an aggregated result.
+transforms the documents into an aggregated result. For example:
+
+.. only:: website and dirhtml
+
+   .. raw:: html
+
+      <video style="width:100%;" src="../_images/agg-pipeline.mp4" controls> </video>
+
+.. only:: website and html and (not dirhtml)
+
+   .. raw:: html
+
+      <video style="width:100%;" src="_images/agg-pipeline.mp4" controls> </video>
+
+In the example,
+
+.. code-block:: javascript
+
+   db.orders.aggregate([
+      { $match: { status: "A" } },
+      { $group: { _id: "$cust_id", total: { $sum: "$amount" } } }
+   ])
+
+**First Stage**: The :pipeline:`$match` stage filters the documents by
+the ``status`` field and passes to the next stage those documents that
+have ``status`` equal to ``"A"``.
+
+**Second Stage**: The :pipeline:`$group` stage groups the documents by
+the ``cust_id`` field to calculate the sum of the amount for each
+unique ``cust_id``.
 
 The most basic pipeline stages provide *filters* that operate like
 queries and *document transformations* that modify the form
@@ -53,8 +82,6 @@ internal optimization phase. See
 :ref:`aggregation-pipeline-operators-and-performance` and
 :doc:`/core/aggregation-pipeline-optimization` for details.
 
-.. include:: /images/aggregation-pipeline.rst
-
 .. _aggregation-map-reduce:
 
 Map-Reduce

source/core/aggregation-pipeline.txt

@@ -13,17 +13,36 @@ Aggregation Pipeline
 The aggregation pipeline is a framework for data aggregation modeled
 on the concept of data processing pipelines. Documents enter a
 multi-stage pipeline that transforms the documents into aggregated
-results.
+results. For example:
 
-.. include:: /images/aggregation-pipeline.rst
+.. only:: website and dirhtml
 
-The aggregation pipeline provides an alternative to :term:`map-reduce`
-and may be the preferred solution for aggregation tasks where the
-complexity of map-reduce may be unwarranted.
+   .. raw:: html
 
-Aggregation pipeline have some limitations on value types and result
-size. See :doc:`/core/aggregation-pipeline-limits` for details on
-limits and restrictions on the aggregation pipeline.
+      <video style="width:100%;" src="../../_images/agg-pipeline.mp4" controls> </video>
+
+.. only:: website and html and (not dirhtml)
+
+   .. raw:: html
+
+      <video style="width:100%;" src="../_images/agg-pipeline.mp4" controls> </video>
+
+In the example,
+
+.. code-block:: javascript
+
+   db.orders.aggregate([
+      { $match: { status: "A" } },
+      { $group: { _id: "$cust_id", total: { $sum: "$amount" } } }
+   ])
+
+**First Stage**: The :pipeline:`$match` stage filters the documents by
+the ``status`` field and passes to the next stage those documents that
+have ``status`` equal to ``"A"``.
+
+**Second Stage**: The :pipeline:`$group` stage groups the documents by
+the ``cust_id`` field to calculate the sum of the amount for each
+unique ``cust_id``.
 
 .. _aggregation-pipeline:
 
@@ -126,16 +145,36 @@ equivalent to a single query with a sort and can use an index. When
 possible, place :pipeline:`$match` operators at the beginning of the
 pipeline.
 
-Additional Features
-~~~~~~~~~~~~~~~~~~~
+Considerations
+--------------
 
-The aggregation pipeline has an internal optimization phase that
-provides improved performance for certain sequences of operators. For
-details, see :doc:`/core/aggregation-pipeline-optimization`.
+Sharded Collections
+~~~~~~~~~~~~~~~~~~~~
 
 The aggregation pipeline supports operations on sharded collections.
 See :ref:`aggregation-pipeline-sharded-collection`.
 
+Aggregation vs Map-Reduce
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The aggregation pipeline provides an alternative to :term:`map-reduce`
+and may be the preferred solution for aggregation tasks where the
+complexity of map-reduce may be unwarranted.
+
+Limitations
+~~~~~~~~~~~
+
+Aggregation pipeline have some limitations on value types and result
+size. See :doc:`/core/aggregation-pipeline-limits` for details on
+limits and restrictions on the aggregation pipeline.
+
+Pipeline Optimization
+~~~~~~~~~~~~~~~~~~~~~
+
+The aggregation pipeline has an internal optimization phase that
+provides improved performance for certain sequences of operators. For
+details, see :doc:`/core/aggregation-pipeline-optimization`.
+
 .. toctree::
    :titlesonly:
    :hidden: