/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mongodb.client;

import com.mongodb.client.model.Collation;
import com.mongodb.lang.Nullable;
import org.bson.conversions.Bson;

import java.util.concurrent.TimeUnit;

Iterable for aggregate.
Type parameters:
  • <TResult> – The type of the result.
@mongodb.driver.manualreference/command/aggregate/ Aggregation
Since:3.0
/** * Iterable for aggregate. * * @param <TResult> The type of the result. * @mongodb.driver.manual reference/command/aggregate/ Aggregation * @since 3.0 */
public interface AggregateIterable<TResult> extends MongoIterable<TResult> {
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
@mongodb.driver.manualreference/operator/aggregation/out/ $out stage
@mongodb.driver.manualreference/operator/aggregation/merge/ $merge stage
Since:3.4
/** * 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 * @mongodb.driver.manual reference/operator/aggregation/out/ $out stage * @mongodb.driver.manual reference/operator/aggregation/merge/ $merge stage * @since 3.4 */
void toCollection();
Enables writing to temporary files. A null value indicates that it's unspecified.
Params:
  • allowDiskUse – true if writing to temporary files is enabled
Returns:this
@mongodb.driver.manualreference/command/aggregate/ Aggregation
@mongodb.server.release2.6
/** * Enables writing to temporary files. A null value indicates that it's unspecified. * * @param allowDiskUse true if writing to temporary files is enabled * @return this * @mongodb.driver.manual reference/command/aggregate/ Aggregation * @mongodb.server.release 2.6 */
AggregateIterable<TResult> allowDiskUse(@Nullable Boolean allowDiskUse);
Sets the number of documents to return per batch.
Params:
  • batchSize – the batch size
Returns:this
@mongodb.driver.manualreference/method/cursor.batchSize/#cursor.batchSize Batch Size
/** * Sets the number of documents to return per batch. * * @param batchSize the batch size * @return this * @mongodb.driver.manual reference/method/cursor.batchSize/#cursor.batchSize Batch Size */
AggregateIterable<TResult> batchSize(int batchSize);
Sets the maximum execution time on the server for this operation.
Params:
  • maxTime – the max time
  • timeUnit – the time unit, which may not be null
Returns:this
@mongodb.driver.manualreference/method/cursor.maxTimeMS/#cursor.maxTimeMS Max Time
/** * Sets the maximum execution time on the server for this operation. * * @param maxTime the max time * @param timeUnit the time unit, which may not be null * @return this * @mongodb.driver.manual reference/method/cursor.maxTimeMS/#cursor.maxTimeMS Max Time */
AggregateIterable<TResult> maxTime(long maxTime, TimeUnit timeUnit);
Sets whether the server should use a cursor to return results.
Params:
  • useCursor – whether the server should use a cursor to return results
Returns:this
@mongodb.driver.manualreference/command/aggregate/ Aggregation
@mongodb.server.release2.6
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. * * @param useCursor whether the server should use a cursor to return results * @return this * @mongodb.driver.manual reference/command/aggregate/ Aggregation * @mongodb.server.release 2.6 * @deprecated There is no replacement for this. Applications can assume that the driver will use a cursor for server versions * that support it (&gt;= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate * command. */
@Deprecated AggregateIterable<TResult> useCursor(@Nullable Boolean useCursor);
The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation. A zero value will be ignored.
Params:
  • 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
@mongodb.server.release3.6
Since:3.6
/** * The maximum amount of time for the server to wait on new documents to satisfy a {@code $changeStream} aggregation. * * A zero value will be ignored. * * @param maxAwaitTime the max await time * @param timeUnit the time unit to return the result in * @return the maximum await execution time in the given time unit * @mongodb.server.release 3.6 * @since 3.6 */
AggregateIterable<TResult> maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit);
Sets the bypass document level validation flag.

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

.
Params:
  • bypassDocumentValidation – If true, allows the write to opt-out of document level validation.
Returns:this
Since:3.2
@mongodb.driver.manualreference/command/aggregate/ Aggregation
@mongodb.server.release3.2
/** * Sets the bypass document level validation flag. * * <p>Note: This only applies when an $out or $merge stage is specified</p>. * * @param bypassDocumentValidation If true, allows the write to opt-out of document level validation. * @return this * @since 3.2 * @mongodb.driver.manual reference/command/aggregate/ Aggregation * @mongodb.server.release 3.2 */
AggregateIterable<TResult> bypassDocumentValidation(@Nullable Boolean bypassDocumentValidation);
Sets the collation options

A null value represents the server default.

Params:
  • collation – the collation options to use
Returns:this
Since:3.4
@mongodb.server.release3.4
/** * Sets the collation options * * <p>A null value represents the server default.</p> * @param collation the collation options to use * @return this * @since 3.4 * @mongodb.server.release 3.4 */
AggregateIterable<TResult> collation(@Nullable Collation collation);
Sets the comment to the aggregation. A null value means no comment is set.
Params:
  • comment – the comment
Returns:this
Since:3.6
@mongodb.server.release3.6
/** * Sets the comment to the aggregation. A null value means no comment is set. * * @param comment the comment * @return this * @since 3.6 * @mongodb.server.release 3.6 */
AggregateIterable<TResult> comment(@Nullable String comment);
Sets the hint for which index to use. A null value means no hint is set.
Params:
  • hint – the hint
Returns:this
Since:3.6
@mongodb.server.release3.6
/** * Sets the hint for which index to use. A null value means no hint is set. * * @param hint the hint * @return this * @since 3.6 * @mongodb.server.release 3.6 */
AggregateIterable<TResult> hint(@Nullable Bson hint); }