com.mongodb.operation

Class AggregateToCollectionOperation

java.lang.Object

com.mongodb.operation.AggregateToCollectionOperation

All Implemented Interfaces:

AsyncWriteOperation<Void>, WriteOperation<Void>

public class AggregateToCollectionOperation
extends Object
implements AsyncWriteOperation<Void>, WriteOperation<Void>

An operation that executes an aggregation that writes its results to a collection (which is what makes this a write operation rather than a read operation).

Since:

3.0

Since server release

2.6

Constructor Summary

Constructors

Constructor and Description
AggregateToCollectionOperation(MongoNamespace namespace, List<BsonDocument> pipeline) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
AggregateToCollectionOperation	allowDiskUse(Boolean allowDiskUse) Enables writing to temporary files.
Void	execute(WriteBinding binding) General execute which can return anything of type T
void	executeAsync(AsyncWriteBinding binding, SingleResultCallback<Void> callback) General execute which can return anything of type T
Boolean	getAllowDiskUse() Whether writing to temporary files is enabled.
long	getMaxTime(TimeUnit timeUnit) Gets the maximum execution time on the server for this operation.
List<BsonDocument>	getPipeline() Gets the aggregation pipeline.
AggregateToCollectionOperation	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateToCollectionOperation

public AggregateToCollectionOperation(MongoNamespace namespace,
                                      List<BsonDocument> pipeline)

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

pipeline - the aggregation pipeline.

Method Detail

getPipeline

public List<BsonDocument> getPipeline()

Gets the aggregation pipeline.

Returns:

the pipeline

MongoDB documentation

Aggregation Pipeline

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

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

execute

public Void execute(WriteBinding binding)

Description copied from interface: WriteOperation

General execute which can return anything of type T

Specified by:

execute in interface WriteOperation<Void>

Parameters:

binding - the binding to execute in the context of

Returns:

T, the result of the execution

executeAsync

public void executeAsync(AsyncWriteBinding binding,
                         SingleResultCallback<Void> callback)

Description copied from interface: AsyncWriteOperation

General execute which can return anything of type T

Specified by:

executeAsync in interface AsyncWriteOperation<Void>

Parameters:

binding - the binding to execute in the context of

callback - the callback to be called when the operation has been executed