Package com.mongodb.client

Interface AggregateIterable<TResult>

Type Parameters:
TResult - The type of the result.
All Superinterfaces:
Iterable<TResult>, MongoIterable<TResult>
@Deprecated(since="2021-05-27") public interface AggregateIterable<TResult> extends MongoIterable<TResult>
Deprecated.
Usage of this API is not supported in AEM as a Cloud Service.
Iterable for aggregate.
Since:
3.0

  • Method Details

    • toCollection

      void toCollection()
      Deprecated.
      Aggregates documents according to the specified aggregation pipeline, which must end with a $out or $merge stage.
      Throws:
      IllegalStateException - if the pipeline does not end with a $out or $merge stage
      Since:
      3.4

    • allowDiskUse

      AggregateIterable<TResult> allowDiskUse(@Nullable Boolean allowDiskUse)
      Deprecated.
      Enables writing to temporary files. A null value indicates that it's unspecified.
      Parameters:
      allowDiskUse - true if writing to temporary files is enabled
      Returns:
      this

    • batchSize

      AggregateIterable<TResult> batchSize(int batchSize)
      Deprecated.
      Sets the number of documents to return per batch.
      Specified by:
      batchSize in interface MongoIterable<TResult>
      Parameters:
      batchSize - the batch size
      Returns:
      this

    • maxTime

      AggregateIterable<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

    • useCursor

      @Deprecated AggregateIterable<TResult> useCursor(@Nullable Boolean useCursor)
      Deprecated.
      There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.
      Sets whether the server should use a cursor to return results.
      Parameters:
      useCursor - whether the server should use a cursor to return results
      Returns:
      this

    • maxAwaitTime

      AggregateIterable<TResult> maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit)
      Deprecated.
      The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation. A zero value will be ignored.
      Parameters:
      maxAwaitTime - the max await time
      timeUnit - the time unit to return the result in
      Returns:
      the maximum await execution time in the given time unit
      Since:
      3.6

    • bypassDocumentValidation

      AggregateIterable<TResult> bypassDocumentValidation(@Nullable Boolean bypassDocumentValidation)
      Deprecated.
      Sets the bypass document level validation flag.

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

      .
      Parameters:
      bypassDocumentValidation - If true, allows the write to opt-out of document level validation.
      Returns:
      this
      Since:
      3.2

    • collation

      AggregateIterable<TResult> collation(@Nullable Collation collation)
      Deprecated.
      Sets the collation options

      A null value represents the server default.

      Parameters:
      collation - the collation options to use
      Returns:
      this
      Since:
      3.4

    • comment

      AggregateIterable<TResult> comment(@Nullable String comment)
      Deprecated.
      Sets the comment to the aggregation. A null value means no comment is set.
      Parameters:
      comment - the comment
      Returns:
      this
      Since:
      3.6

    • hint

      AggregateIterable<TResult> hint(@Nullable Bson hint)
      Deprecated.
      Sets the hint for which index to use. A null value means no hint is set.
      Parameters:
      hint - the hint
      Returns:
      this
      Since:
      3.6