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

Method Summary

Modifier and Type	Method and 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>	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
AggregateIterable<TResult>	useCursor(Boolean useCursor) Sets whether the server should use a cursor to return results.

Methods inherited from interface com.mongodb.client.MongoIterable

first, forEach, into, iterator, map

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

allowDiskUse

AggregateIterable<TResult> allowDiskUse(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

AggregateIterable<TResult> useCursor(Boolean useCursor)

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

bypassDocumentValidation

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

3.2

MongoDB documentation

Aggregation

Since server release

3.2

collation

AggregateIterable<TResult> collation(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