Package com.mongodb.client
Interface MapReduceIterable<TResult>
- Type Parameters:
TResult
- The type of the result.
- All Superinterfaces:
Iterable<TResult>
,MongoIterable<TResult>
Deprecated.
Superseded by aggregate
Iterable for map-reduce.
By default the MapReduceIterable
returns the results inline. You can write map-reduce output to a collection by using the
collectionName(String)
method.
- Since:
- 3.0
-
Method Summary
Modifier and TypeMethodDescriptionaction
(MapReduceAction action) Deprecated.Specify theMapReduceAction
to be used when writing to a collection.batchSize
(int batchSize) Deprecated.Sets the number of documents to return per batch.bypassDocumentValidation
(Boolean bypassDocumentValidation) Deprecated.Sets the bypass document level validation flag.Deprecated.Sets the collation optionscollectionName
(String collectionName) Deprecated.Sets the collectionName for the output of the MapReducedatabaseName
(String databaseName) Deprecated.Sets the name of the database to output into.Deprecated.Sets the query filter to apply to the query.finalizeFunction
(String finalizeFunction) Deprecated.Sets the JavaScript function that follows the reduce method and modifies the output.jsMode
(boolean jsMode) Deprecated.Sets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions.limit
(int limit) Deprecated.Sets the limit to apply.Deprecated.Sets the maximum execution time on the server for this operation.Deprecated.Sets the global variables that are accessible in the map, reduce and finalize functions.Deprecated.Sets the sort criteria to apply to the query.timeoutMode
(TimeoutMode timeoutMode) Deprecated.Sets the timeoutMode for the cursor.void
Deprecated.Aggregates documents to a collection according to the specified map-reduce function with the given options, which must specify a non-inline result.verbose
(boolean verbose) Deprecated.Sets whether to include the timing information in the result information.Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
toCollection
void toCollection()Deprecated.Aggregates documents to a collection according to the specified map-reduce function with the given options, which must specify a non-inline result.- Throws:
IllegalStateException
- if a collection name to write the results to has not been specified- Since:
- 3.4
- See Also:
-
collectionName
Deprecated.Sets the collectionName for the output of the MapReduceThe default action is replace the collection if it exists, to change this use
action(com.mongodb.client.model.MapReduceAction)
.- Parameters:
collectionName
- the name of the collection that you want the map-reduce operation to write its output.- Returns:
- this
-
finalizeFunction
Deprecated.Sets the JavaScript function that follows the reduce method and modifies the output.- Parameters:
finalizeFunction
- the JavaScript function that follows the reduce method and modifies the output.- Returns:
- this
- MongoDB documentation
- Requirements for the finalize Function
-
scope
Deprecated.Sets the global variables that are accessible in the map, reduce and finalize functions.- Parameters:
scope
- the global variables that are accessible in the map, reduce and finalize functions.- Returns:
- this
- MongoDB documentation
- mapReduce
-
sort
Deprecated.Sets the sort criteria to apply to the query.- Parameters:
sort
- the sort criteria, which may be null.- Returns:
- this
- MongoDB documentation
- Sort
-
filter
Deprecated.Sets the query filter to apply to the query.- Parameters:
filter
- the filter to apply to the query.- Returns:
- this
- MongoDB documentation
- Filter
-
limit
Deprecated.Sets the limit to apply.- Parameters:
limit
- the limit, which may be null- Returns:
- this
- MongoDB documentation
- Limit
-
jsMode
Deprecated.Sets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions. Defaults to false.- Parameters:
jsMode
- the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions- Returns:
- jsMode
- MongoDB documentation
- mapReduce
-
verbose
Deprecated.Sets whether to include the timing information in the result information.- Parameters:
verbose
- whether to include the timing information in the result information.- Returns:
- this
-
maxTime
Deprecated.Sets the maximum execution time on the server for this operation.- Parameters:
maxTime
- the max timetimeUnit
- the time unit, which may not be null- Returns:
- this
- MongoDB documentation
- Max Time
-
action
Deprecated.Specify theMapReduceAction
to be used when writing to a collection.- Parameters:
action
- anMapReduceAction
to perform on the collection- Returns:
- this
-
databaseName
Deprecated.Sets the name of the database to output into.- Parameters:
databaseName
- the name of the database to output into.- Returns:
- this
- MongoDB documentation
- output with an action
-
batchSize
Deprecated.Sets the number of documents to return per batch.- Specified by:
batchSize
in interfaceMongoIterable<TResult>
- Parameters:
batchSize
- the batch size- Returns:
- this
- MongoDB documentation
- Batch Size
-
bypassDocumentValidation
Deprecated.Sets the bypass document level validation flag.Note: This only applies when an $out stage is specified
. -
collation
Deprecated.Sets the collation optionsA null value represents the server default.
- Parameters:
collation
- the collation options to use- Returns:
- this
- Since:
- 3.4
- Since server release
- 3.4
-
timeoutMode
Deprecated.Sets the timeoutMode for the cursor.Requires the
timeout
to be set, either in theMongoClientSettings
, viaMongoDatabase
or viaMongoCollection
- Parameters:
timeoutMode
- the timeout mode- Returns:
- this
- Since:
- 5.2
-