com.mongodb

类 AggregationOptions.Builder

java.lang.Object

com.mongodb.AggregationOptions.Builder

封闭类:

AggregationOptions

@NotThreadSafe
public static class AggregationOptions.Builder
extends java.lang.Object

Builder for creating AggregationOptions.

MongoDB documentation

aggregate

Since server release

2.2

方法概要

限定符和类型	方法和说明
AggregationOptions.Builder	allowDiskUse(java.lang.Boolean allowDiskUse) Set whether to enable external sort capabilities.
AggregationOptions.Builder	batchSize(java.lang.Integer size) Sets the size of batches to use when iterating over results.
AggregationOptions	build() Return the options based on this builder.
AggregationOptions.Builder	bypassDocumentValidation(java.lang.Boolean bypassDocumentValidation) Sets whether to bypass document validation.
AggregationOptions.Builder	maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit) Sets the maximum execution time for the aggregation command.
AggregationOptions.Builder	outputMode(AggregationOptions.OutputMode mode) The mode of output for this configuration.

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

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

方法详细资料

batchSize

public AggregationOptions.Builder batchSize(java.lang.Integer size)

Sets the size of batches to use when iterating over results. Can be null.

参数:

size - the batch size to apply to the cursor

返回:

this so calls can be chained

Since server release

2.6

allowDiskUse

public AggregationOptions.Builder allowDiskUse(java.lang.Boolean allowDiskUse)

Set whether to enable external sort capabilities. If set to false, $sort produces an error if the operation consumes 10 percent or more RAM.

参数:

allowDiskUse - whether or not aggregation stages can write data to temporary files

返回:

this so calls can be chained

Since server release

2.6

outputMode

public AggregationOptions.Builder outputMode(AggregationOptions.OutputMode mode)

The mode of output for this configuration.

参数:

mode - an OutputMode that defines how to output the results of the aggregation

返回:

this so calls can be chained

另请参阅:

AggregationOptions.OutputMode

maxTime

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

Sets the maximum execution time for the aggregation command.

参数:

maxTime - the max time

timeUnit - the time unit

返回:

this so calls can be chained

Since server release

2.6

bypassDocumentValidation

public AggregationOptions.Builder bypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)

Sets whether to bypass document validation.

参数:

bypassDocumentValidation - whether to bypass document validation, or null if unspecified

返回:

this

从以下版本开始:

2.14

Since server release

3.2

build

public AggregationOptions build()

Return the options based on this builder.

返回:

the aggregation options