/*
* Copyright (c) 2008-2016 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.MongoNamespace;
import com.mongodb.WriteConcern;
import com.mongodb.async.SingleResultCallback;
import com.mongodb.binding.AsyncWriteBinding;
import com.mongodb.binding.WriteBinding;
import com.mongodb.client.model.Collation;
import com.mongodb.connection.AsyncConnection;
import com.mongodb.connection.Connection;
import com.mongodb.connection.ConnectionDescription;
import org.bson.BsonArray;
import org.bson.BsonBoolean;
import org.bson.BsonDocument;
import org.bson.BsonInt64;
import org.bson.BsonString;
import java.util.List;
import java.util.concurrent.TimeUnit;
import static com.mongodb.assertions.Assertions.isTrueArgument;
import static com.mongodb.assertions.Assertions.notNull;
import static com.mongodb.internal.async.ErrorHandlingResultCallback.errorHandlingCallback;
import static com.mongodb.operation.CommandOperationHelper.executeWrappedCommandProtocol;
import static com.mongodb.operation.CommandOperationHelper.executeWrappedCommandProtocolAsync;
import static com.mongodb.operation.OperationHelper.AsyncCallableWithConnection;
import static com.mongodb.operation.OperationHelper.CallableWithConnection;
import static com.mongodb.operation.OperationHelper.LOGGER;
import static com.mongodb.operation.OperationHelper.serverIsAtLeastVersionThreeDotSix;
import static com.mongodb.operation.OperationHelper.validateCollation;
import static com.mongodb.operation.OperationHelper.releasingCallback;
import static com.mongodb.operation.OperationHelper.serverIsAtLeastVersionThreeDotTwo;
import static com.mongodb.operation.OperationHelper.withConnection;
import static com.mongodb.operation.WriteConcernHelper.appendWriteConcernToCommand;
import static com.mongodb.operation.WriteConcernHelper.writeConcernErrorTransformer;
/**
* An operation that executes an aggregation that writes its results to a collection (which is what makes this a write operation rather than
* a read operation).
*
* @mongodb.server.release 2.6
* @mongodb.driver.manual reference/command/aggregate/ Aggregation
* @since 3.0
*/
public class AggregateToCollectionOperation implements AsyncWriteOperation<Void>, WriteOperation<Void> {
private final MongoNamespace namespace;
private final List<BsonDocument> pipeline;
private final WriteConcern writeConcern;
private Boolean allowDiskUse;
private long maxTimeMS;
private Boolean bypassDocumentValidation;
private Collation collation;
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param pipeline the aggregation pipeline.
* @deprecated Prefer {@link #AggregateToCollectionOperation(MongoNamespace, List, WriteConcern)}
*/
@Deprecated
public AggregateToCollectionOperation(final MongoNamespace namespace, final List<BsonDocument> pipeline) {
this(namespace, pipeline, null);
}
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param pipeline the aggregation pipeline.
* @param writeConcern the write concern to apply
*
* @since 3.4
*/
public AggregateToCollectionOperation(final MongoNamespace namespace, final List<BsonDocument> pipeline,
final WriteConcern writeConcern) {
this.namespace = notNull("namespace", namespace);
this.pipeline = notNull("pipeline", pipeline);
this.writeConcern = writeConcern;
isTrueArgument("pipeline is empty", !pipeline.isEmpty());
isTrueArgument("last stage of pipeline does not contain an output collection",
pipeline.get(pipeline.size() - 1).get("$out") != null);
}
/**
* Gets the aggregation pipeline.
*
* @return the pipeline
* @mongodb.driver.manual core/aggregation-introduction/#aggregation-pipelines Aggregation Pipeline
*/
public List<BsonDocument> getPipeline() {
return pipeline;
}
/**
* Gets the write concern.
*
* @return the write concern, which may be null
*
* @since 3.4
*/
public WriteConcern getWriteConcern() {
return writeConcern;
}
/**
* 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 allowDiskUse;
}
/**
* 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 AggregateToCollectionOperation allowDiskUse(final Boolean allowDiskUse) {
this.allowDiskUse = allowDiskUse;
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) {
notNull("timeUnit", timeUnit);
return timeUnit.convert(maxTimeMS, TimeUnit.MILLISECONDS);
}
/**
* 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 AggregateToCollectionOperation maxTime(final long maxTime, final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
this.maxTimeMS = TimeUnit.MILLISECONDS.convert(maxTime, timeUnit);
return this;
}
/**
* Gets the bypass document level validation flag
*
* @return the bypass document level validation flag
* @since 3.2
*/
public Boolean getBypassDocumentValidation() {
return bypassDocumentValidation;
}
/**
* Sets the bypass document level validation flag.
*
* <p>Note: This only applies when an $out stage is specified</p>.
*
* @param bypassDocumentValidation If true, allows the write to opt-out of document level validation.
* @return this
* @since 3.2
* @mongodb.server.release 3.2
*/
public AggregateToCollectionOperation bypassDocumentValidation(final Boolean bypassDocumentValidation) {
this.bypassDocumentValidation = bypassDocumentValidation;
return this;
}
/**
* Returns the collation options
*
* @return the collation options
* @since 3.4
* @mongodb.server.release 3.4
*/
public Collation getCollation() {
return collation;
}
/**
* Sets the collation options
*
* <p>A null value represents the server default.</p>
* @param collation the collation options to use
* @return this
* @since 3.4
* @mongodb.server.release 3.4
*/
public AggregateToCollectionOperation collation(final Collation collation) {
this.collation = collation;
return this;
}
@Override
public Void execute(final WriteBinding binding) {
return withConnection(binding, new CallableWithConnection<Void>() {
@Override
public Void call(final Connection connection) {
validateCollation(connection, collation);
return executeWrappedCommandProtocol(binding, namespace.getDatabaseName(), getCommand(connection.getDescription()),
connection, writeConcernErrorTransformer());
}
});
}
@Override
public void executeAsync(final AsyncWriteBinding binding, final SingleResultCallback<Void> callback) {
withConnection(binding, new AsyncCallableWithConnection() {
@Override
public void call(final AsyncConnection connection, final Throwable t) {
SingleResultCallback<Void> errHandlingCallback = errorHandlingCallback(callback, LOGGER);
if (t != null) {
errHandlingCallback.onResult(null, t);
} else {
final SingleResultCallback<Void> wrappedCallback = releasingCallback(errHandlingCallback, connection);
validateCollation(connection, collation, new AsyncCallableWithConnection() {
@Override
public void call(final AsyncConnection connection, final Throwable t) {
if (t != null) {
wrappedCallback.onResult(null, t);
} else {
executeWrappedCommandProtocolAsync(binding, namespace.getDatabaseName(),
getCommand(connection.getDescription()), connection, writeConcernErrorTransformer(),
wrappedCallback);
}
}
});
}
}
});
}
private BsonDocument getCommand(final ConnectionDescription description) {
BsonDocument commandDocument = new BsonDocument("aggregate", new BsonString(namespace.getCollectionName()));
commandDocument.put("pipeline", new BsonArray(pipeline));
if (maxTimeMS > 0) {
commandDocument.put("maxTimeMS", new BsonInt64(maxTimeMS));
}
if (allowDiskUse != null) {
commandDocument.put("allowDiskUse", BsonBoolean.valueOf(allowDiskUse));
}
if (bypassDocumentValidation != null && serverIsAtLeastVersionThreeDotTwo(description)) {
commandDocument.put("bypassDocumentValidation", BsonBoolean.valueOf(bypassDocumentValidation));
}
if (serverIsAtLeastVersionThreeDotSix(description)) {
commandDocument.put("cursor", new BsonDocument());
}
appendWriteConcernToCommand(writeConcern, commandDocument, description);
if (collation != null) {
commandDocument.put("collation", collation.asDocument());
}
return commandDocument;
}
}