Package com.mongodb.async.client

Interface AggregateIterable<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

MongoIterable<TResult>

@Deprecated
public interface AggregateIterable<TResult>
extends MongoIterable<TResult>

Deprecated.

Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)

Iterable for aggregate.

Since:

3.0

Method Summary

Modifier and Type	Method	Description
AggregateIterable<TResult>	allowDiskUse(Boolean allowDiskUse)	Deprecated. Enables writing to temporary files.
AggregateIterable<TResult>	batchSize(int batchSize)	Deprecated. Sets the number of documents to return per batch.
AggregateIterable<TResult>	bypassDocumentValidation(Boolean bypassDocumentValidation)	Deprecated. Sets the bypass document level validation flag.
AggregateIterable<TResult>	collation(Collation collation)	Deprecated. Sets the collation options
AggregateIterable<TResult>	comment(String comment)	Deprecated. Sets the comment to the aggregation.
AggregateIterable<TResult>	hint(Bson hint)	Deprecated. Sets the hint for which index to use.
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.
AggregateIterable<TResult>	maxTime(long maxTime, TimeUnit timeUnit)	Deprecated. Sets the maximum execution time on the server for this operation.
void	toCollection(SingleResultCallback<Void> callback)	Deprecated. 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 com.mongodb.async.client.MongoIterable

batchCursor, first, forEach, getBatchSize, into, map

Method Detail

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

MongoDB documentation

Aggregation

Since server release

2.6

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

MongoDB documentation

Max Time

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

Since server release

3.6

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

toCollection

void toCollection(SingleResultCallback<Void> callback)

Deprecated.

Aggregates documents according to the specified aggregation pipeline, which must end with a $out or $merge stage.

Parameters:

callback - the callback, which is called when the aggregation completes

Throws:

IllegalStateException - if the pipeline does not end with a $out or $merge stage

MongoDB documentation

Aggregation

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

MongoDB documentation

Batch Size

bypassDocumentValidation

AggregateIterable<TResult> bypassDocumentValidation(@Nullable
                                                    Boolean bypassDocumentValidation)

Deprecated.

Sets the bypass document level validation flag.

Note: This only applies when a $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)

Deprecated.

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)

Deprecated.

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)

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

Since server release

3.6