Commit 6a46d117 authored by Jeremy Mikola's avatar Jeremy Mikola

Clarify when aggregate and mapReduce options may be ignored

parent 9b925197
...@@ -70,6 +70,8 @@ source: ...@@ -70,6 +70,8 @@ source:
source: source:
file: apiargs-MongoDBCollection-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: readPreference ref: readPreference
post: |
This option will be ignored when using the :ref:`$out <agg-out>` stage.
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
......
source: source:
file: apiargs-MongoDBCollection-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: bypassDocumentValidation ref: bypassDocumentValidation
post: |
This only applies when results are output to a collection.
--- ---
source: source:
file: apiargs-MongoDBCollection-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
...@@ -55,6 +57,8 @@ source: ...@@ -55,6 +57,8 @@ source:
source: source:
file: apiargs-MongoDBCollection-common-option.yaml file: apiargs-MongoDBCollection-common-option.yaml
ref: readPreference ref: readPreference
post: |
This option will be ignored when results are output to a collection.
--- ---
arg_name: option arg_name: option
name: scope name: scope
......
...@@ -92,6 +92,8 @@ class Aggregate implements Executable ...@@ -92,6 +92,8 @@ class Aggregate implements Executable
* *
* * readPreference (MongoDB\Driver\ReadPreference): Read preference. * * readPreference (MongoDB\Driver\ReadPreference): Read preference.
* *
* This option is ignored if the $out stage is specified.
*
* * typeMap (array): Type map for BSON deserialization. This will be * * typeMap (array): Type map for BSON deserialization. This will be
* applied to the returned Cursor (it is not sent to the server). * applied to the returned Cursor (it is not sent to the server).
* *
......
...@@ -107,6 +107,8 @@ class MapReduce implements Executable ...@@ -107,6 +107,8 @@ class MapReduce implements Executable
* *
* * readPreference (MongoDB\Driver\ReadPreference): Read preference. * * readPreference (MongoDB\Driver\ReadPreference): Read preference.
* *
* This option is ignored if results are output to a collection.
*
* * scope (document): Specifies global variables that are accessible in * * scope (document): Specifies global variables that are accessible in
* the map, reduce and finalize functions. * the map, reduce and finalize functions.
* *
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment