AggregateOperation (mongo-java-driver 3.3.0-query-log-max-size API)

java.lang.Object
- com.mongodb.operation.AggregateOperation<T>

类型参数:

T - the operations result type.

所有已实现的接口:

AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>
```
public class AggregateOperation<T>
extends java.lang.Object
implements AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>
```
An operation that executes an aggregation query.

从以下版本开始:

3.0

MongoDB documentation

Aggregation

Since server release

2.2

构造器概要

构造器
构造器和说明
`AggregateOperation(MongoNamespace namespace, java.util.List<BsonDocument> pipeline, Decoder<T> decoder)` Construct a new instance.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`AggregateOperation<T>`	`allowDiskUse(java.lang.Boolean allowDiskUse)` Enables writing to temporary files.
`ReadOperation<BsonDocument>`	`asExplainableOperation(ExplainVerbosity explainVerbosity)` Gets an operation whose execution explains this operation.
`AsyncReadOperation<BsonDocument>`	`asExplainableOperationAsync(ExplainVerbosity explainVerbosity)` Gets an operation whose execution explains this operation.
`AggregateOperation<T>`	`batchSize(java.lang.Integer batchSize)` Sets the number of documents to return per batch.
`BatchCursor<T>`	`execute(ReadBinding binding)` General execute which can return anything of type T
`void`	`executeAsync(AsyncReadBinding binding, SingleResultCallback<AsyncBatchCursor<T>> callback)` General execute which can return anything of type T
`java.lang.Boolean`	`getAllowDiskUse()` Whether writing to temporary files is enabled.
`java.lang.Integer`	`getBatchSize()` Gets the number of documents to return per batch.
`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.
`ReadConcern`	`getReadConcern()` Gets the read concern
`java.lang.Boolean`	`getUseCursor()` Gets whether the server should use a cursor to return results.
`AggregateOperation<T>`	`maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit)` Sets the maximum execution time on the server for this operation.
`AggregateOperation<T>`	`readConcern(ReadConcern readConcern)` Sets the read concern
`AggregateOperation<T>`	`useCursor(java.lang.Boolean useCursor)` Sets whether the server should use a cursor to return results.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AggregateOperation
```
public AggregateOperation(MongoNamespace namespace,
                          java.util.List<BsonDocument> pipeline,
                          Decoder<T> decoder)
```
    Construct a new instance.
    
    参数:
    
    namespace - the database and collection namespace for the operation.
    
    pipeline - the aggregation pipeline.
    
    decoder - the decoder for the result documents.
- 方法详细资料
  - 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 AggregateOperation<T> 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
  - getBatchSize
```
public java.lang.Integer getBatchSize()
```
    Gets the number of documents to return per batch. Default to 0, which indicates that the server chooses an appropriate batch size.
    
    返回:
    
    the batch size, which may be null
    
    MongoDB documentation
    
    Batch Size
  - batchSize
```
public AggregateOperation<T> batchSize(java.lang.Integer batchSize)
```
    Sets the number of documents to return per batch.
    
    参数:
    
    batchSize - the batch size
    
    返回:
    
    this
    
    MongoDB documentation
    
    Batch Size
  - 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 AggregateOperation<T> 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
  - getUseCursor
```
public java.lang.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.
    
    返回:
    
    whether the server should use a cursor to return results
    
    MongoDB documentation
    
    Aggregation
    
    Since server release
    
    2.6
  - useCursor
```
public AggregateOperation<T> useCursor(java.lang.Boolean useCursor)
```
    Sets whether the server should use a cursor to return results.
    
    参数:
    
    useCursor - whether the server should use a cursor to return results
    
    返回:
    
    this
    
    MongoDB documentation
    
    Aggregation
    
    Since server release
    
    2.6
  - getReadConcern
```
public ReadConcern getReadConcern()
```
    Gets the read concern
    
    返回:
    
    the read concern
    
    从以下版本开始:
    
    3.2
    
    MongoDB documentation
    
    Read Concern
  - readConcern
```
public AggregateOperation<T> readConcern(ReadConcern readConcern)
```
    Sets the read concern
    
    参数:
    
    readConcern - the read concern
    
    返回:
    
    this
    
    从以下版本开始:
    
    3.2
    
    MongoDB documentation
    
    Read Concern
  - execute
```
public BatchCursor<T> execute(ReadBinding binding)
```
    从接口复制的说明: ReadOperation
    
    General execute which can return anything of type T
    
    指定者:
    
    execute 在接口中 ReadOperation<BatchCursor<T>>
    
    参数:
    
    binding - the binding to execute in the context of
    
    返回:
    
    T, the result of the execution
  - executeAsync
```
public void executeAsync(AsyncReadBinding binding,
                         SingleResultCallback<AsyncBatchCursor<T>> callback)
```
    从接口复制的说明: AsyncReadOperation
    
    General execute which can return anything of type T
    
    指定者:
    
    executeAsync 在接口中 AsyncReadOperation<AsyncBatchCursor<T>>
    
    参数:
    
    binding - the binding to execute in the context of
    
    callback - the callback to be called when the operation has been executed
  - asExplainableOperation
```
public ReadOperation<BsonDocument> asExplainableOperation(ExplainVerbosity explainVerbosity)
```
    Gets an operation whose execution explains this operation.
    
    参数:
    
    explainVerbosity - the explain verbosity
    
    返回:
    
    a read operation that when executed will explain this operation
  - asExplainableOperationAsync
```
public AsyncReadOperation<BsonDocument> asExplainableOperationAsync(ExplainVerbosity explainVerbosity)
```
    Gets an operation whose execution explains this operation.
    
    参数:
    
    explainVerbosity - the explain verbosity
    
    返回:
    
    a read operation that when executed will explain this operation

类 AggregateOperation<T>

构造器概要

方法概要

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

构造器详细资料

AggregateOperation

方法详细资料

getPipeline

getAllowDiskUse

allowDiskUse

getBatchSize

batchSize

getMaxTime

maxTime

getUseCursor

useCursor

getReadConcern

readConcern

execute

executeAsync

asExplainableOperation

asExplainableOperationAsync