com.mongodb.operation

类 AggregateToCollectionOperation

java.lang.Object

com.mongodb.operation.AggregateToCollectionOperation

所有已实现的接口:

AsyncWriteOperation<java.lang.Void>, WriteOperation<java.lang.Void>

public class AggregateToCollectionOperation
extends java.lang.Object
implements AsyncWriteOperation<java.lang.Void>, WriteOperation<java.lang.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).

从以下版本开始:

3.0

Since server release

2.6

构造器概要

构造器

构造器和说明
AggregateToCollectionOperation(MongoNamespace namespace, java.util.List<BsonDocument> pipeline) Construct a new instance.

方法概要

限定符和类型	方法和说明
AggregateToCollectionOperation	allowDiskUse(java.lang.Boolean allowDiskUse) Enables writing to temporary files.
AggregateToCollectionOperation	bypassDocumentValidation(java.lang.Boolean bypassDocumentValidation) Sets the bypass document level validation flag.
java.lang.Void	execute(WriteBinding binding) General execute which can return anything of type T
void	executeAsync(AsyncWriteBinding binding, SingleResultCallback<java.lang.Void> callback) General execute which can return anything of type T
java.lang.Boolean	getAllowDiskUse() Whether writing to temporary files is enabled.
java.lang.Boolean	getBypassDocumentValidation() Gets the bypass document level validation flag
long	getMaxTime(java.util.concurrent.TimeUnit timeUnit) Gets the maximum execution time on the server for this operation.
java.util.List<BsonDocument>	getPipeline() Gets the aggregation pipeline.
AggregateToCollectionOperation	maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.

从类继承的方法 java.lang.Object

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

构造器详细资料

AggregateToCollectionOperation

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

Construct a new instance.

参数:

namespace - the database and collection namespace for the operation.

pipeline - the aggregation pipeline.

方法详细资料

getPipeline

public java.util.List<BsonDocument> getPipeline()

Gets the aggregation pipeline.

返回:

the pipeline

MongoDB documentation

Aggregation Pipeline

getAllowDiskUse

public java.lang.Boolean getAllowDiskUse()

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

返回:

true if writing to temporary files is enabled

MongoDB documentation

Aggregation

Since server release

2.6

allowDiskUse

public AggregateToCollectionOperation allowDiskUse(java.lang.Boolean allowDiskUse)

Enables writing to temporary files. A null value indicates that it's unspecified.

参数:

allowDiskUse - true if writing to temporary files is enabled

返回:

this

MongoDB documentation

Aggregation

Since server release

2.6

getMaxTime

public long getMaxTime(java.util.concurrent.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.

参数:

timeUnit - the time unit to return the result in

返回:

the maximum execution time in the given time unit

MongoDB documentation

Max Time

maxTime

public AggregateToCollectionOperation maxTime(long maxTime,
                                              java.util.concurrent.TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

参数:

maxTime - the max time

timeUnit - the time unit, which may not be null

返回:

this

MongoDB documentation

Max Time

getBypassDocumentValidation

public java.lang.Boolean getBypassDocumentValidation()

Gets the bypass document level validation flag

返回:

the bypass document level validation flag

从以下版本开始:

3.2

bypassDocumentValidation

public AggregateToCollectionOperation bypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)

Sets the bypass document level validation flag.

Note: This only applies when an $out stage is specified

.

参数:

bypassDocumentValidation - If true, allows the write to opt-out of document level validation.

返回:

this

从以下版本开始:

3.2

MongoDB documentation

Aggregation

Since server release

3.2

execute

public java.lang.Void execute(WriteBinding binding)

从接口复制的说明: WriteOperation

General execute which can return anything of type T

指定者:

execute 在接口中 WriteOperation<java.lang.Void>

参数:

binding - the binding to execute in the context of

返回:

T, the result of the execution

executeAsync

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

从接口复制的说明: AsyncWriteOperation

General execute which can return anything of type T

指定者:

executeAsync 在接口中 AsyncWriteOperation<java.lang.Void>

参数:

binding - the binding to execute in the context of

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