com.mongodb.reactivestreams.client

Interface MapReducePublisher<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

org.reactivestreams.Publisher<TResult>

public interface MapReducePublisher<TResult>
extends org.reactivestreams.Publisher<TResult>

Publisher for map reduce.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
MapReducePublisher<TResult>	action(com.mongodb.client.model.MapReduceAction action) Specify the MapReduceAction to be used when writing to a collection.
MapReducePublisher<TResult>	bypassDocumentValidation(Boolean bypassDocumentValidation) Sets the bypass document level validation flag.
MapReducePublisher<TResult>	collation(com.mongodb.client.model.Collation collation) Sets the collation options
MapReducePublisher<TResult>	collectionName(String collectionName) Sets the collectionName for the output of the MapReduce
MapReducePublisher<TResult>	databaseName(String databaseName) Sets the name of the database to output into.
MapReducePublisher<TResult>	filter(org.bson.conversions.Bson filter) Sets the query filter to apply to the query.
MapReducePublisher<TResult>	finalizeFunction(String finalizeFunction) Sets the JavaScript function that follows the reduce method and modifies the output.
MapReducePublisher<TResult>	jsMode(boolean jsMode) Sets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions.
MapReducePublisher<TResult>	limit(int limit) Sets the limit to apply.
MapReducePublisher<TResult>	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
MapReducePublisher<TResult>	nonAtomic(boolean nonAtomic) Sets if the post-processing step will prevent MongoDB from locking the database.
MapReducePublisher<TResult>	scope(org.bson.conversions.Bson scope) Sets the global variables that are accessible in the map, reduce and finalize functions.
MapReducePublisher<TResult>	sharded(boolean sharded) Sets if the output database is sharded
MapReducePublisher<TResult>	sort(org.bson.conversions.Bson sort) Sets the sort criteria to apply to the query.
org.reactivestreams.Publisher<Success>	toCollection() Aggregates documents to a collection according to the specified map-reduce function with the given options, which must specify a non-inline result.
MapReducePublisher<TResult>	verbose(boolean verbose) Sets whether to include the timing information in the result information.

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Detail

collectionName

MapReducePublisher<TResult> collectionName(String collectionName)

Sets the collectionName for the output of the MapReduce

The 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

MapReducePublisher<TResult> finalizeFunction(String finalizeFunction)

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

MapReducePublisher<TResult> scope(org.bson.conversions.Bson scope)

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

MapReducePublisher<TResult> sort(org.bson.conversions.Bson sort)

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

MongoDB documentation

Sort

filter

MapReducePublisher<TResult> filter(org.bson.conversions.Bson filter)

Sets the query filter to apply to the query.

Parameters:

filter - the filter to apply to the query.

Returns:

this

MongoDB documentation

Filter

limit

MapReducePublisher<TResult> limit(int limit)

Sets the limit to apply.

Parameters:

limit - the limit, which may be null

Returns:

this

MongoDB documentation

Limit

jsMode

MapReducePublisher<TResult> jsMode(boolean jsMode)

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

MapReducePublisher<TResult> verbose(boolean verbose)

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

MapReducePublisher<TResult> maxTime(long maxTime,
                                  TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

MongoDB documentation

Max Time

action

MapReducePublisher<TResult> action(com.mongodb.client.model.MapReduceAction action)

Specify the MapReduceAction to be used when writing to a collection.

Parameters:

action - an MapReduceAction to perform on the collection

Returns:

this

databaseName

MapReducePublisher<TResult> databaseName(String databaseName)

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

sharded

MapReducePublisher<TResult> sharded(boolean sharded)

Sets if the output database is sharded

Parameters:

sharded - if the output database is sharded

Returns:

this

MongoDB documentation

output with an action

nonAtomic

MapReducePublisher<TResult> nonAtomic(boolean nonAtomic)

Sets if the post-processing step will prevent MongoDB from locking the database. Valid only with the MapReduceAction.MERGE or MapReduceAction.REDUCE actions.

Parameters:

nonAtomic - if the post-processing step will prevent MongoDB from locking the database.

Returns:

this

MongoDB documentation

output with an action

bypassDocumentValidation

MapReducePublisher<TResult> bypassDocumentValidation(Boolean bypassDocumentValidation)

Sets the bypass document level validation flag.

Note: This only applies when an $out stage is specified

.

Parameters:

bypassDocumentValidation - If true, allows the write to opt-out of document level validation.

Returns:

this

Since:

1.2

MongoDB documentation

Aggregation

Since server release

3.2

toCollection

org.reactivestreams.Publisher<Success> toCollection()

Aggregates documents to a collection according to the specified map-reduce function with the given options, which must specify a non-inline result.

Returns:

a publisher with a single element indicating when the operation has completed

MongoDB documentation

Aggregation

collation

MapReducePublisher<TResult> collation(com.mongodb.client.model.Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since:

1.3

Since server release

3.4