com.mongodb.client.model

Class AggregateOptions

java.lang.Object

com.mongodb.client.model.AggregateOptions

public class AggregateOptions
extends Object

A model describing an aggregation.

Since:

3.0

MongoDB documentation

Aggregation

Since server release

2.2

Constructor Summary

Constructors

Constructor and Description
AggregateOptions()

Method Summary

Methods

Modifier and Type	Method and Description
AggregateOptions	allowDiskUse(Boolean allowDiskUse) Enables writing to temporary files.
AggregateOptions	batchSize(Integer batchSize) Sets the number of documents to return per batch.
Boolean	getAllowDiskUse() Whether writing to temporary files is enabled.
Integer	getBatchSize() Gets the number of documents to return per batch.
long	getMaxTime(TimeUnit timeUnit) Gets the maximum execution time on the server for this operation.
Boolean	getUseCursor() Gets whether the server should use a cursor to return results.
AggregateOptions	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
AggregateOptions	useCursor(Boolean useCursor) Sets whether the server should use a cursor to return results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AggregateOptions

public AggregateOptions()

Method Detail

getAllowDiskUse

public Boolean getAllowDiskUse()

Whether writing to temporary files is enabled. A null value indicates that it's unspecified.

Returns:

true if writing to temporary files is enabled

MongoDB documentation

Aggregation

Since server release

2.6

allowDiskUse

public AggregateOptions 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

getBatchSize

public Integer getBatchSize()

Gets the number of documents to return per batch. Default to null, which indicates that the server chooses an appropriate batch size.

Returns:

the batch size, which may be null

MongoDB documentation

Batch Size

batchSize

public AggregateOptions batchSize(Integer batchSize)

Sets the number of documents to return per batch.

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum execution time in the given time unit

MongoDB documentation

Max Time

maxTime

public AggregateOptions 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

getUseCursor

public Boolean getUseCursor()

Gets whether the server should use a cursor to return results. The default value is null, in which case a cursor will be used if the server supports it.

Returns:

whether the server should use a cursor to return results

MongoDB documentation

Aggregation

Since server release

2.6

useCursor

public AggregateOptions 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