DOCS-686 mapreduce

Author: kay-kim

source/applications.txt

@@ -51,5 +51,6 @@ The following documents provide patterns for developing application features:
 .. toctree::
    :maxdepth: 2
 
+   tutorial/troubleshoot-map-reduce
    tutorial/perform-two-phase-commits
    tutorial/expire-data

source/applications/map-reduce.txt

@@ -46,12 +46,7 @@ For more information on the parameters, see the
 :method:`db.collection.mapReduce()` reference page .
 
 .. include:: /includes/examples-map-reduce.rst
-   :start-after: map-reduce-examples-begin
-   :end-before: map-reduce-sum-price-wrapper-end
-   
-.. include:: /includes/examples-map-reduce.rst
-   :start-after: map-reduce-sum-price-cmd-end
-   :end-before: map-reduce-item-counts-avg-wrapper-end
+   :start-after: map-reduce-document-prototype-begin
 
 .. _map-reduce-incremental:
 

source/includes/examples-map-reduce.rst

@@ -1,7 +1,8 @@
 Map-Reduce Examples
 -------------------
 
-.. map-reduce-examples-begin
+.. map-reduce-document-examples-begin
+.. map-reduce-document-prototype-begin
 
 Consider the following map-reduce operations on a collection ``orders``
 that contains documents of the following prototype:
@@ -19,11 +20,11 @@ that contains documents of the following prototype:
    }
 
 .. map-reduce-document-prototype-end
-
+   
 Sum the Price Per Customer Id
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. map-reduce-sum-price
+.. map-reduce-sum-price-begin
 
 Perform map-reduce operation on the ``orders`` collection to group by
 the ``cust_id``, and for each ``cust_id``, calculate the sum of the
@@ -71,7 +72,6 @@ the ``cust_id``, and for each ``cust_id``, calculate the sum of the
    operation will replace the contents with the results of this
    map-reduce operation:
 
-   .. map-reduce-sum-price-wrapper-begin
    .. code-block:: javascript
 
       db.orders.mapReduce( 
@@ -80,24 +80,12 @@ the ``cust_id``, and for each ``cust_id``, calculate the sum of the
                            { out: "map_reduce_example" }   
                          )
 
-   .. map-reduce-sum-price-wrapper-end
-   .. map-reduce-sum-price-cmd-begin
-   .. code-block:: javascript
-
-      db.runCommand(
-                     {
-                       mapreduce: 'orders',
-                       map: mapFunction1,
-                       reduce: reduceFunction1,
-                       out: 'map_reduce_example'
-                     } 
-                   )
-   .. map-reduce-sum-price-cmd-end
+.. map-reduce-sum-price-end
 
 Calculate the Number of Orders, Total Quantity, and Average Quantity Per Item
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. map-reduce-item-counts
+.. map-reduce-counts-begin
 
 Perform map-reduce operation on the ``orders`` collection to group by
 the item sku, and for each sku, calculate the number of orders and the
@@ -178,8 +166,6 @@ greater than ``01/01/2012`` for the map-reduce:
    already exists, the operation will merge the existing contents with
    the results of this map-reduce operation:
 
-   .. map-reduce-item-counts-avg-end
-   .. map-reduce-item-counts-avg-wrapper-begin
    .. code-block:: javascript
 
       db.orders.mapReduce( mapFunction2,
@@ -191,21 +177,4 @@ greater than ``01/01/2012`` for the map-reduce:
                            }
                          )
 
-   .. map-reduce-item-counts-avg-wrapper-end
-   .. map-reduce-item-counts-avg-cmd-begin
-   .. code-block:: javascript
-
-      db.runCommand(
-                     {
-                       mapreduce: 'orders',
-                       map: mapFunction2,
-                       reduce: reduceFunction2,
-                       finalize: finalizeFunction2,
-                       out: { merge: "map_reduce_example" }, 
-                       query: { ord_date: { $gt: new Date('01/01/2012') } },
-                     }
-                   )
-
-   .. map-reduce-item-counts-avg-cmd-end
-
-.. map-reduce-examples-end
+.. map-reduce-counts-end

source/reference/command/mapReduce.txt

@@ -30,35 +30,50 @@ mapReduce
 
    In addition to specifying the ``<collection>`` over which to perform
    the ``mapreduce`` command, the command accepts the following:
-   
+
    .. include:: /includes/parameters-map-reduce.rst
 
+   A sample map-reduce operation using the :dbcommand:`mapReduce`
+   command may have the following prototype:
+
+   .. code-block:: javascript
+
+      var mapFunction = function() { ... };
+      var reduceFunction = function(key, values) { ... };
+
+      db.runCommand(
+                     {
+                       mapreduce: 'orders',
+                       map: mapFunction,
+                       reduce: reduceFunction,
+                       out: { merge: 'map_reduce_results' },
+                       query: { ord_date: { $gt: new Date('01/01/2012') } }
+                     }
+                   )
+
+   In the :program:`mongo`, the :method:`db.collection.mapReduce()`
+   method is a wrapper around the :dbcommand:`mapReduce` command. The
+   following examples use the :method:`db.collection.mapReduce()`:
+
    .. include:: /includes/examples-map-reduce.rst
-      :start-after: map-reduce-examples-begin
+      :start-after: map-reduce-document-prototype-begin
       :end-before: map-reduce-document-prototype-end
 
    - .. include:: /includes/examples-map-reduce.rst
-        :start-after: map-reduce-sum-price
-        :end-before: map-reduce-sum-price-wrapper-begin
+        :start-after: map-reduce-sum-price-begin
+        :end-before: map-reduce-sum-price-end
 
-     .. include:: /includes/examples-map-reduce.rst
-             :start-after: map-reduce-sum-price-cmd-begin
-             :end-before: map-reduce-sum-price-cmd-end
-     
    - .. include:: /includes/examples-map-reduce.rst
-        :start-after: map-reduce-item-counts
-        :end-before: map-reduce-item-counts-avg-end
+        :start-after: map-reduce-counts-begin
+        :end-before: map-reduce-counts-end
+
+   For more information and examples, see the :doc:`Map-Reduce
+   </applications/map-reduce>` page.
 
-     .. include:: /includes/examples-map-reduce.rst
-        :start-after: map-reduce-item-counts-avg-cmd-begin
-        :end-before: map-reduce-item-counts-avg-cmd-end
+   .. seealso:: 
 
-   .. seealso:: :method:`mapReduce()` and :term:`map-reduce`.
+      - :term:`map-reduce` and :method:`db.collection.mapReduce()`
 
-      The :doc:`Map-Reduce </applications/map-reduce>` 
-      provides a greater overview of MongoDB's map-reduce
-      functionality. Consider the :wiki:`Simple application
-      <Aggregation>` support for basic aggregation operations as well
-      as :doc:`/applications/aggregation`.
+      - :doc:`/applications/aggregation`
 
    .. slave-ok

source/reference/method/db.collection.mapReduce.txt

@@ -30,28 +30,23 @@ db.collection.mapReduce()
 
    .. include:: /includes/parameters-map-reduce.rst
 
-   .. mapReduce-syntax-end
-
    .. include:: /includes/examples-map-reduce.rst
-      :start-after: map-reduce-examples-begin
+      :start-after: map-reduce-document-prototype-begin
       :end-before: map-reduce-document-prototype-end
 
    - .. include:: /includes/examples-map-reduce.rst
-        :start-after: map-reduce-sum-price
-        :end-before: map-reduce-sum-price-wrapper-end
+        :start-after: map-reduce-sum-price-begin
+        :end-before: map-reduce-sum-price-end
 
    - .. include:: /includes/examples-map-reduce.rst
-        :start-after: map-reduce-item-counts
-        :end-before: map-reduce-item-counts-avg-wrapper-end
-
-   .. seealso:: :term:`map-reduce` and :dbcommand:`mapReduce`
+        :start-after: map-reduce-counts-begin
+        :end-before: map-reduce-counts-end
 
-      The :doc:`Map-Reduce </applications/map-reduce>` page
-      provides a greater overview of MongoDB's map-reduce
-      functionality, while the :doc:`/applications/aggregation`
-      provides an overview of the aggregation framework.
+   For more information and examples, see the :doc:`Map-Reduce
+   </applications/map-reduce>` page.
 
-      .. Consider
-      .. STUB ":doc:`/applications/simple-aggregation` for simple aggregation
-      .. operations and :doc:`/applications/aggregation`" for a more flexible
-      .. approach to data aggregation in MongoDB.
+   .. seealso:: 
+
+      - :term:`map-reduce` and :dbcommand:`mapReduce`
+
+      - :doc:`/applications/aggregation`

source/tutorial.txt

@@ -51,6 +51,7 @@ Application Development
 .. toctree::
    :maxdepth: 1
 
+   tutorial/troubleshoot-map-reduce
    tutorial/write-a-tumblelog-application-with-django-mongodb-engine
    tutorial/write-a-tumblelog-application-with-flask-mongoengine
 

source/tutorial/troubleshoot-map-reduce.txt

@@ -4,8 +4,11 @@ Troubleshoot Map-Reduce
 
 .. default-domain:: mongodb
 
+The :doc:`/applications/map-reduce` operation requires both the ``map``
+function and the ``reduce`` function.
+
 You can troubleshoot the ``map`` function and the ``reduce`` function
-in the :program:`mongo` shell.
+in the :program:`mongo` shell. 
 
 .. _troubleshoot-map-function:
 
@@ -258,7 +261,7 @@ should equal the same as if all the values were passed in one call.
                              ];
 
 #. Define a sample ``values1`` array that combines the values passed to
-``reduceFunction2``:
+   ``reduceFunction2``:
 
    .. code-block:: javascript
 
@@ -269,7 +272,7 @@ should equal the same as if all the values were passed in one call.
                     ];
 
 #. Invoke the ``reduceFunction2`` first with ``myKey`` and
-``valuesIdempotent`` and then with ``myKey`` and ``values1``:
+   ``valuesIdempotent`` and then with ``myKey`` and ``values1``:
 
    .. code-block:: javascript