Package com.mongodb.client

Interface AggregateIterable<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

Iterable<TResult>, MongoIterable<TResult>

public interface AggregateIterable<TResult>
extends MongoIterable<TResult>

Iterable for aggregate.

Since:

3.0

MongoDB documentation

Aggregation

Method Summary

Modifier and Type	Method	Description
AggregateIterable<TResult>	allowDiskUse(Boolean allowDiskUse)	Enables writing to temporary files.
AggregateIterable<TResult>	batchSize(int batchSize)	Sets the number of documents to return per batch.
AggregateIterable<TResult>	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
AggregateIterable<TResult>	collation(Collation collation)	Sets the collation options
AggregateIterable<TResult>	comment(String comment)	Sets the comment to the aggregation.
AggregateIterable<TResult>	hint(Bson hint)	Sets the hint for which index to use.
AggregateIterable<TResult>	maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit)	The maximum amount of time for the server to wait on new documents to satisfy a $changeStream aggregation.
AggregateIterable<TResult>	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
void	toCollection()	Aggregates documents according to the specified aggregation pipeline, which must end with a $out or $merge stage.
AggregateIterable<TResult>	useCursor(Boolean useCursor)	Deprecated. There is no replacement for this.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.mongodb.client.MongoIterable

cursor, first, forEach, into, iterator, map

Method Detail

toCollection

void toCollection()

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

MongoDB documentation

$out stage

$merge stage

allowDiskUse

AggregateIterable<TResult> allowDiskUse(@Nullable
                                        Boolean allowDiskUse)

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

MongoDB documentation

Aggregation

Since server release

2.6

batchSize

AggregateIterable<TResult> batchSize(int batchSize)

Sets the number of documents to return per batch.

Specified by:

batchSize in interface MongoIterable<TResult>

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size

maxTime

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

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

MongoDB documentation

Aggregation

Since server release

2.6

maxAwaitTime

AggregateIterable<TResult> maxAwaitTime(long maxAwaitTime,
                                        TimeUnit timeUnit)

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

Since server release

3.6

bypassDocumentValidation

AggregateIterable<TResult> bypassDocumentValidation(@Nullable
                                                    Boolean bypassDocumentValidation)

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

MongoDB documentation

Aggregation

Since server release

3.2

collation

AggregateIterable<TResult> collation(@Nullable
                                     Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since:

3.4

Since server release

3.4

comment

AggregateIterable<TResult> comment(@Nullable
                                   String comment)

Sets the comment to the aggregation. A null value means no comment is set.

Parameters:

comment - the comment

Returns:

this

Since:

3.6

Since server release

3.6

hint

AggregateIterable<TResult> hint(@Nullable
                                Bson hint)

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

Since server release

3.6