org.springframework.data.mongodb.core.aggregation

Class AggregationOptions

java.lang.Object

org.springframework.data.mongodb.core.aggregation.AggregationOptions

public class AggregationOptions
extends Object

Holds a set of configurable aggregation options that can be used within an aggregation pipeline. A list of support aggregation options can be found in the MongoDB reference documentation https://docs.mongodb.org/manual/reference/command/aggregate/#aggregate

Since:

1.6

Author:

Thomas Darimont, Oliver Gierke, Christoph Strobl, Mark Paluch

See Also:

Aggregation.withOptions(AggregationOptions), TypedAggregation.withOptions(AggregationOptions)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregationOptions.Builder A Builder for AggregationOptions.

Constructor Summary

Constructors

Constructor and Description
AggregationOptions(boolean allowDiskUse, boolean explain, org.bson.Document cursor) Creates a new AggregationOptions.
AggregationOptions(boolean allowDiskUse, boolean explain, org.bson.Document cursor, Collation collation) Creates a new AggregationOptions.
AggregationOptions(boolean allowDiskUse, boolean explain, org.bson.Document cursor, Collation collation, String comment) Creates a new AggregationOptions.
AggregationOptions(boolean allowDiskUse, boolean explain, int cursorBatchSize) Creates a new AggregationOptions.

Method Summary

Modifier and Type	Method and Description
static AggregationOptions.Builder	builder() Obtain a new AggregationOptions.Builder for constructing AggregationOptions.
static AggregationOptions	fromDocument(org.bson.Document document) Creates new AggregationOptions given DBObject containing aggregation options.
Optional<Collation>	getCollation() Get collation settings for string comparison.
Optional<String>	getComment() Get the comment for the aggregation.
Optional<org.bson.Document>	getCursor() Specify a document that contains options that control the creation of the cursor object.
Integer	getCursorBatchSize() The initial cursor batch size, if available, otherwise null.
boolean	isAllowDiskUse() Enables writing to temporary files.
boolean	isExplain() Specifies to return the information on the processing of the pipeline.
org.bson.Document	toDocument() Returns a Document representation of this AggregationOptions.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregationOptions

public AggregationOptions(boolean allowDiskUse,
                          boolean explain,
                          org.bson.Document cursor)

Creates a new AggregationOptions.

Parameters:

allowDiskUse - whether to off-load intensive sort-operations to disk.

explain - whether to get the execution plan for the aggregation instead of the actual results.

cursor - can be null, used to pass additional options to the aggregation.

AggregationOptions

public AggregationOptions(boolean allowDiskUse,
                          boolean explain,
                          @Nullable
                          org.bson.Document cursor,
                          @Nullable
                          Collation collation)

Creates a new AggregationOptions.

Parameters:

allowDiskUse - whether to off-load intensive sort-operations to disk.

explain - whether to get the execution plan for the aggregation instead of the actual results.

cursor - can be null, used to pass additional options (such as batchSize) to the aggregation.

collation - collation for string comparison. Can be null.

Since:

2.0

AggregationOptions

public AggregationOptions(boolean allowDiskUse,
                          boolean explain,
                          @Nullable
                          org.bson.Document cursor,
                          @Nullable
                          Collation collation,
                          @Nullable
                          String comment)

Creates a new AggregationOptions.

Parameters:

allowDiskUse - whether to off-load intensive sort-operations to disk.

explain - whether to get the execution plan for the aggregation instead of the actual results.

cursor - can be null, used to pass additional options (such as batchSize) to the aggregation.

collation - collation for string comparison. Can be null.

comment - execution comment. Can be null.

Since:

2.2

AggregationOptions

public AggregationOptions(boolean allowDiskUse,
                          boolean explain,
                          int cursorBatchSize)

Creates a new AggregationOptions.

Parameters:

allowDiskUse - whether to off-load intensive sort-operations to disk.

explain - whether to get the execution plan for the aggregation instead of the actual results.

cursorBatchSize - initial cursor batch size.

Since:

2.0

Method Detail

fromDocument

public static AggregationOptions fromDocument(org.bson.Document document)

Creates new AggregationOptions given DBObject containing aggregation options.

Parameters:

document - must not be null.

Returns:

the AggregationOptions.

Since:

2.0

builder

public static AggregationOptions.Builder builder()

Obtain a new AggregationOptions.Builder for constructing AggregationOptions.

Returns:

never null.

Since:

2.0

isAllowDiskUse

public boolean isAllowDiskUse()

Enables writing to temporary files. When set to true, aggregation stages can write data to the _tmp subdirectory in the dbPath directory.

Returns:

isExplain

public boolean isExplain()

Specifies to return the information on the processing of the pipeline.

Returns:

getCursorBatchSize

@Nullable
public Integer getCursorBatchSize()

The initial cursor batch size, if available, otherwise null.

Returns:

the batch size or null.

Since:

2.0

getCursor

public Optional<org.bson.Document> getCursor()

Specify a document that contains options that control the creation of the cursor object.

Returns:

getCollation

public Optional<Collation> getCollation()

Get collation settings for string comparison.

Returns:

Since:

2.0

getComment

public Optional<String> getComment()

Get the comment for the aggregation.

Returns:

Since:

2.2

toDocument

public org.bson.Document toDocument()

Returns a Document representation of this AggregationOptions.

Returns:

toString

public String toString()

Overrides:

toString in class Object