Package com.mongodb.reactivestreams.client

Interface MapReducePublisher<TResult>

Type Parameters:
TResult - The type of the result.
All Superinterfaces:
Publisher<TResult>
@Deprecated public interface MapReducePublisher<TResult> extends Publisher<TResult>
Deprecated.
Superseded by aggregate
Publisher for map reduce.

By default, the MapReducePublisher produces the results inline. You can write map-reduce output to a collection by using the collectionName(String) and toCollection() methods.

Since:
1.0

  • Method Details

    • collectionName

      MapReducePublisher<TResult> collectionName(String collectionName)
      Deprecated.
      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
      See Also:

    • finalizeFunction

      MapReducePublisher<TResult> finalizeFunction(@Nullable String 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

      MapReducePublisher<TResult> scope(@Nullable Bson 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

      MapReducePublisher<TResult> sort(@Nullable Bson 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

      MapReducePublisher<TResult> filter(@Nullable Bson 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

      MapReducePublisher<TResult> limit(int limit)
      Deprecated.
      Sets the limit to apply.
      Parameters:
      limit - the limit, which may be null
      Returns:
      this
      MongoDB documentation
      Limit

    • jsMode

      MapReducePublisher<TResult> 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. 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)
      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

      MapReducePublisher<TResult> maxTime(long maxTime, TimeUnit timeUnit)
      Deprecated.
      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)
      Deprecated.
      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(@Nullable String 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

    • bypassDocumentValidation

      MapReducePublisher<TResult> bypassDocumentValidation(@Nullable Boolean bypassDocumentValidation)
      Deprecated.
      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

      Publisher<Void> toCollection()
      Deprecated.
      Aggregates documents to a collection according to the specified map-reduce function with the given options, which must not produce results inline. Calling this method and then subscribing to the returned Publisher is the preferred alternative to subscribing to this MapReducePublisher, because this method does what is explicitly requested without executing implicit operations.
      Returns:
      an empty publisher that indicates when the operation has completed
      Throws:
      IllegalStateException - if a collection name to write the results to has not been specified
      See Also:
      MongoDB documentation
      Aggregation

    • subscribe

      void subscribe(Subscriber<? super TResult> s)
      Deprecated.
      Requests MapReducePublisher to start streaming data according to the specified map-reduce function with the given options.
      • If the aggregation produces results inline, then finds all documents in the affected namespace and produces them. You may want to use toCollection() instead.
      • Otherwise, produces no elements.
      Specified by:
      subscribe in interface Publisher<TResult>

    • collation

      MapReducePublisher<TResult> collation(@Nullable com.mongodb.client.model.Collation collation)
      Deprecated.
      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

    • batchSize

      MapReducePublisher<TResult> batchSize(int batchSize)
      Deprecated.
      Sets the number of documents to return per batch.

      Overrides the Subscription.request(long) value for setting the batch size, allowing for fine-grained control over the underlying cursor.

      Parameters:
      batchSize - the batch size
      Returns:
      this
      Since:
      1.8
      MongoDB documentation
      Batch Size

    • timeoutMode

      @Alpha(CLIENT) MapReducePublisher<TResult> timeoutMode(com.mongodb.client.cursor.TimeoutMode timeoutMode)
      Deprecated.
      Sets the timeoutMode for the cursor.

      Requires the timeout to be set, either in the MongoClientSettings, via MongoDatabase or via MongoCollection

      If the timeout is set then:

      • For non-tailable cursors, the default value of timeoutMode is TimeoutMode.CURSOR_LIFETIME
      • For tailable cursors, the default value of timeoutMode is TimeoutMode.ITERATION and its an error to configure it as: TimeoutMode.CURSOR_LIFETIME
      Parameters:
      timeoutMode - the timeout mode
      Returns:
      this
      Since:
      5.2

    • first

      Publisher<TResult> first()
      Deprecated.
      Helper to return a publisher limited to the first result.
      Returns:
      a Publisher which will contain a single item.
      Since:
      1.8