com.mongodb.AggregationOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation
Show all versions of mongo-java-driver Show documentation
The MongoDB Java Driver uber-artifact, containing the legacy driver, the mongodb-driver, mongodb-driver-core, and bson
/*
* Copyright 2008-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mongodb;
import com.mongodb.annotations.NotThreadSafe;
import com.mongodb.client.model.Collation;
import java.util.concurrent.TimeUnit;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
/**
* The options to apply to an aggregate operation.
*
* @mongodb.server.release 2.2
* @mongodb.driver.manual reference/command/aggregate/ aggregate
* @since 2.12
*/
public class AggregationOptions {
private final Integer batchSize;
private final Boolean allowDiskUse;
private final OutputMode outputMode;
private final long maxTimeMS;
private final Boolean bypassDocumentValidation;
private final Collation collation;
/**
* Enumeration to define where the results of the aggregation will be output.
* @deprecated There is no replacement for this. Applications can assume that the driver will use a cursor for server versions
* that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate
* command.
*/
@Deprecated
public enum OutputMode {
/**
* The output of the aggregate operation is returned inline.
*/
INLINE,
/**
* The output of the aggregate operation is returned using a cursor.
*
* @mongodb.server.release 2.6
*/
CURSOR
}
AggregationOptions(final Builder builder) {
batchSize = builder.batchSize;
allowDiskUse = builder.allowDiskUse;
outputMode = builder.outputMode;
maxTimeMS = builder.maxTimeMS;
bypassDocumentValidation = builder.bypassDocumentValidation;
collation = builder.collation;
}
/**
* If true, this enables external sort capabilities, otherwise $sort produces an error if the operation consumes 10 percent or more of
* RAM.
*
* @return true if aggregation stages can write data to temporary files
* @mongodb.server.release 2.6
*/
public Boolean getAllowDiskUse() {
return allowDiskUse;
}
/**
* The size of batches to use when iterating over results.
*
* @return the batch size
* @mongodb.server.release 2.6
*/
public Integer getBatchSize() {
return batchSize;
}
/**
* The mode of output for this configuration.
*
* @return whether the output will be inline or via a cursor, which defaults to {@link OutputMode#CURSOR}
* @see OutputMode
* @deprecated There is no replacement for this. Applications can assume that the driver will use a cursor for server versions
* that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate
* command.
*/
@Deprecated
public OutputMode getOutputMode() {
return outputMode;
}
/**
* Gets the maximum execution time for the aggregation command.
*
* @param timeUnit the time unit for the result
* @return the max time
* @mongodb.server.release 2.6
* @since 2.12
*/
public long getMaxTime(final TimeUnit timeUnit) {
return timeUnit.convert(maxTimeMS, MILLISECONDS);
}
/**
* Gets whether to bypass document validation, or null if unspecified. The default is null.
*
* @return whether to bypass document validation, or null if unspecified.
* @since 2.14
* @mongodb.server.release 3.2
*/
public Boolean getBypassDocumentValidation() {
return bypassDocumentValidation;
}
/**
* Returns the collation options
*
* @return the collation options
* @since 3.4
* @mongodb.server.release 3.4
*/
public Collation getCollation() {
return collation;
}
@Override
public String toString() {
return "AggregationOptions{"
+ "batchSize=" + batchSize
+ ", allowDiskUse=" + allowDiskUse
+ ", outputMode=" + outputMode
+ ", maxTimeMS=" + maxTimeMS
+ ", bypassDocumentValidation=" + bypassDocumentValidation
+ ", collation=" + collation
+ "}";
}
/**
* Creates a new Builder for {@code AggregationOptions}.
*
* @return a new empty builder.
*/
public static Builder builder() {
return new Builder();
}
/**
* Builder for creating {@code AggregationOptions}.
*
* @mongodb.server.release 2.2
* @mongodb.driver.manual reference/command/aggregate/ aggregate
*/
@NotThreadSafe
public static class Builder {
private Integer batchSize;
private Boolean allowDiskUse;
private OutputMode outputMode = OutputMode.CURSOR;
private long maxTimeMS;
private Boolean bypassDocumentValidation;
private Collation collation;
private Builder() {
}
/**
* Sets the size of batches to use when iterating over results. Can be null.
*
* @param size the batch size to apply to the cursor
* @return {@code this} so calls can be chained
* @mongodb.server.release 2.6
*/
public Builder batchSize(final Integer size) {
batchSize = size;
return this;
}
/**
* Set whether to enable external sort capabilities. If set to false, $sort produces an error if the operation consumes 10 percent
* or more RAM.
*
* @param allowDiskUse whether or not aggregation stages can write data to temporary files
* @return {@code this} so calls can be chained
* @mongodb.server.release 2.6
*/
public Builder allowDiskUse(final Boolean allowDiskUse) {
this.allowDiskUse = allowDiskUse;
return this;
}
/**
* The mode of output for this configuration.
*
* @param mode an {@code OutputMode} that defines how to output the results of the aggregation.
* @return {@code this} so calls can be chained
* @see OutputMode
* @deprecated There is no replacement for this. Applications can assume that the driver will use a cursor for server versions
* that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the
* aggregate command.
*/
@Deprecated
public Builder outputMode(final OutputMode mode) {
outputMode = mode;
return this;
}
/**
* Sets the maximum execution time for the aggregation command.
*
* @param maxTime the max time
* @param timeUnit the time unit
* @return {@code this} so calls can be chained
* @mongodb.server.release 2.6
*/
public Builder maxTime(final long maxTime, final TimeUnit timeUnit) {
maxTimeMS = MILLISECONDS.convert(maxTime, timeUnit);
return this;
}
/**
* Sets whether to bypass document validation.
*
* @param bypassDocumentValidation whether to bypass document validation, or null if unspecified
* @return this
* @since 2.14
* @mongodb.server.release 3.2
*/
public Builder bypassDocumentValidation(final Boolean bypassDocumentValidation) {
this.bypassDocumentValidation = bypassDocumentValidation;
return this;
}
/**
* Sets the collation
*
* @param collation the collation
* @return this
* @since 3.4
* @mongodb.server.release 3.4
*/
public Builder collation(final Collation collation) {
this.collation = collation;
return this;
}
/**
* Return the options based on this builder.
*
* @return the aggregation options
*/
public AggregationOptions build() {
return new AggregationOptions(this);
}
}
}