com.mongodb.operation.AggregateOperation 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.operation;
import com.mongodb.ExplainVerbosity;
import com.mongodb.MongoNamespace;
import com.mongodb.async.AsyncBatchCursor;
import com.mongodb.async.SingleResultCallback;
import com.mongodb.binding.AsyncReadBinding;
import com.mongodb.binding.ReadBinding;
import com.mongodb.client.model.Collation;
import org.bson.BsonDocument;
import org.bson.BsonValue;
import org.bson.codecs.Decoder;
import java.util.List;
import java.util.concurrent.TimeUnit;
/**
* An operation that executes an aggregation query.
*
* @param the operations result type.
* @mongodb.driver.manual aggregation/ Aggregation
* @mongodb.server.release 2.2
* @since 3.0
*/
public class AggregateOperation implements AsyncReadOperation>, ReadOperation> {
private final AggregateOperationImpl wrapped;
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param pipeline the aggregation pipeline.
* @param decoder the decoder for the result documents.
*/
public AggregateOperation(final MongoNamespace namespace, final List pipeline, final Decoder decoder) {
this.wrapped = new AggregateOperationImpl(namespace, pipeline, decoder);
}
/**
* Gets the aggregation pipeline.
*
* @return the pipeline
* @mongodb.driver.manual core/aggregation-introduction/#aggregation-pipelines Aggregation Pipeline
*/
public List getPipeline() {
return wrapped.getPipeline();
}
/**
* Whether writing to temporary files is enabled. A null value indicates that it's unspecified.
*
* @return true if writing to temporary files is enabled
* @mongodb.driver.manual reference/command/aggregate/ Aggregation
* @mongodb.server.release 2.6
*/
public Boolean getAllowDiskUse() {
return wrapped.getAllowDiskUse();
}
/**
* Enables writing to temporary files. A null value indicates that it's unspecified.
*
* @param allowDiskUse true if writing to temporary files is enabled
* @return this
* @mongodb.driver.manual reference/command/aggregate/ Aggregation
* @mongodb.server.release 2.6
*/
public AggregateOperation allowDiskUse(final Boolean allowDiskUse) {
wrapped.allowDiskUse(allowDiskUse);
return this;
}
/**
* Gets the number of documents to return per batch. Default to 0, which indicates that the server chooses an appropriate batch size.
*
* @return the batch size, which may be null
* @mongodb.driver.manual reference/method/cursor.batchSize/#cursor.batchSize Batch Size
*/
public Integer getBatchSize() {
return wrapped.getBatchSize();
}
/**
* Sets the number of documents to return per batch.
*
* @param batchSize the batch size
* @return this
* @mongodb.driver.manual reference/method/cursor.batchSize/#cursor.batchSize Batch Size
*/
public AggregateOperation batchSize(final Integer batchSize) {
wrapped.batchSize(batchSize);
return this;
}
/**
* The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor
* query. This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor,
* this option is ignored.
*
* A zero value will be ignored.
*
* @param timeUnit the time unit to return the result in
* @return the maximum await execution time in the given time unit
* @mongodb.server.release 3.6
* @mongodb.driver.manual reference/method/cursor.maxTimeMS/#cursor.maxTimeMS Max Time
*/
public long getMaxAwaitTime(final TimeUnit timeUnit) {
return wrapped.getMaxAwaitTime(timeUnit);
}
/**
* Sets the maximum await execution time on the server for this operation.
*
* @param maxAwaitTime the max await time. A value less than one will be ignored, and indicates that the driver should respect the
* server's default value
* @param timeUnit the time unit, which may not be null
* @return this
* @mongodb.server.release 3.6
*/
public AggregateOperation maxAwaitTime(final long maxAwaitTime, final TimeUnit timeUnit) {
wrapped.maxAwaitTime(maxAwaitTime, timeUnit);
return this;
}
/**
* Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.
*
* @param timeUnit the time unit to return the result in
* @return the maximum execution time in the given time unit
* @mongodb.driver.manual reference/method/cursor.maxTimeMS/#cursor.maxTimeMS Max Time
*/
public long getMaxTime(final TimeUnit timeUnit) {
return wrapped.getMaxTime(timeUnit);
}
/**
* Sets the maximum execution time on the server for this operation.
*
* @param maxTime the max time
* @param timeUnit the time unit, which may not be null
* @return this
* @mongodb.driver.manual reference/method/cursor.maxTimeMS/#cursor.maxTimeMS Max Time
*/
public AggregateOperation maxTime(final long maxTime, final TimeUnit timeUnit) {
wrapped.maxTime(maxTime, timeUnit);
return this;
}
/**
* 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.
*
* @return whether the server should use a cursor to return results
* @mongodb.driver.manual reference/command/aggregate/ Aggregation
* @mongodb.server.release 2.6
* @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 Boolean getUseCursor() {
return wrapped.getUseCursor();
}
/**
* Sets whether the server should use a cursor to return results.
*
* @param useCursor whether the server should use a cursor to return results
* @return this
* @mongodb.driver.manual reference/command/aggregate/ Aggregation
* @mongodb.server.release 2.6
* @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 AggregateOperation useCursor(final Boolean useCursor) {
wrapped.useCursor(useCursor);
return this;
}
/**
* Returns the collation options
*
* @return the collation options
* @since 3.4
* @mongodb.driver.manual reference/command/aggregate/ Aggregation
* @mongodb.server.release 3.4
*/
public Collation getCollation() {
return wrapped.getCollation();
}
/**
* Sets the collation options
*
* A null value represents the server default.
* @param collation the collation options to use
* @return this
* @since 3.4
* @mongodb.driver.manual reference/command/aggregate/ Aggregation
* @mongodb.server.release 3.4
*/
public AggregateOperation collation(final Collation collation) {
wrapped.collation(collation);
return this;
}
/**
* Returns the comment to send with the aggregate. The default is not to include a comment with the aggregation.
*
* @return the comment
* @since 3.6
* @mongodb.server.release 3.6
*/
public String getComment() {
return wrapped.getComment();
}
/**
* Sets the comment to the aggregation. A null value means no comment is set.
*
* @param comment the comment
* @return this
* @since 3.6
* @mongodb.server.release 3.6
*/
public AggregateOperation comment(final String comment) {
wrapped.comment(comment);
return this;
}
/**
* Returns the hint for which index to use. The default is not to set a hint.
*
* @return the hint
* @since 3.6
* @mongodb.server.release 3.6
*/
public BsonDocument getHint() {
BsonValue hint = wrapped.getHint();
if (hint == null) {
return null;
}
if (!hint.isDocument()) {
throw new IllegalArgumentException("Hint is not a BsonDocument please use the #getHintBsonValue() method. ");
}
return hint.asDocument();
}
/**
* Returns the hint BsonValue for which index to use. The default is not to set a hint.
*
* Hints can either be a BsonString or a BsonDocument.
*
* @return the hint
* @since 3.8
* @mongodb.server.release 3.6
*/
public BsonValue getHintBsonValue() {
return wrapped.getHint();
}
/**
* Sets the hint for which index to use. A null value means no hint is set.
*
* @param hint the hint
* @return this
* @since 3.6
* @mongodb.server.release 3.6
*/
public AggregateOperation hint(final BsonValue hint) {
wrapped.hint(hint);
return this;
}
@Override
public BatchCursor execute(final ReadBinding binding) {
return wrapped.execute(binding);
}
@Override
public void executeAsync(final AsyncReadBinding binding, final SingleResultCallback> callback) {
wrapped.executeAsync(binding, callback);
}
/**
* Gets an operation whose execution explains this operation.
*
* @param explainVerbosity the explain verbosity
* @return a read operation that when executed will explain this operation
*/
public ReadOperation asExplainableOperation(final ExplainVerbosity explainVerbosity) {
return new AggregateExplainOperation(getNamespace(), getPipeline())
.allowDiskUse(getAllowDiskUse())
.maxTime(getMaxAwaitTime(TimeUnit.MILLISECONDS), TimeUnit.MILLISECONDS)
.hint(wrapped.getHint());
}
/**
* Gets an operation whose execution explains this operation.
*
* @param explainVerbosity the explain verbosity
* @return a read operation that when executed will explain this operation
*/
public AsyncReadOperation asExplainableOperationAsync(final ExplainVerbosity explainVerbosity) {
return new AggregateExplainOperation(getNamespace(), getPipeline())
.allowDiskUse(getAllowDiskUse())
.maxTime(getMaxAwaitTime(TimeUnit.MILLISECONDS), TimeUnit.MILLISECONDS)
.hint(wrapped.getHint());
}
MongoNamespace getNamespace() {
return wrapped.getNamespace();
}
Decoder getDecoder() {
return wrapped.getDecoder();
}
@Override
public String toString() {
return "AggregateOperation{"
+ "namespace=" + getNamespace()
+ ", pipeline=" + getPipeline()
+ ", decoder=" + getDecoder()
+ ", allowDiskUse=" + getAllowDiskUse()
+ ", batchSize=" + getBatchSize()
+ ", collation=" + getCollation()
+ ", comment=" + getComment()
+ ", hint=" + getHint()
+ ", maxAwaitTimeMS=" + getMaxAwaitTime(TimeUnit.MILLISECONDS)
+ ", maxTimeMS=" + getMaxTime(TimeUnit.MILLISECONDS)
+ ", useCursor=" + wrapped.getUseCursor()
+ "}";
}
}