com.mongodb.operation.FindAndUpdateOperation 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.MongoNamespace;
import com.mongodb.WriteConcern;
import com.mongodb.client.model.Collation;
import com.mongodb.connection.ConnectionDescription;
import com.mongodb.connection.ServerDescription;
import com.mongodb.internal.validator.MappedFieldNameValidator;
import com.mongodb.internal.validator.NoOpFieldNameValidator;
import com.mongodb.internal.validator.UpdateFieldNameValidator;
import com.mongodb.lang.Nullable;
import com.mongodb.session.SessionContext;
import org.bson.BsonArray;
import org.bson.BsonBoolean;
import org.bson.BsonDocument;
import org.bson.BsonString;
import org.bson.FieldNameValidator;
import org.bson.codecs.Decoder;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import static com.mongodb.assertions.Assertions.notNull;
import static com.mongodb.internal.operation.ServerVersionHelper.serverIsAtLeastVersionThreeDotTwo;
import static com.mongodb.operation.CommandOperationHelper.CommandCreator;
import static com.mongodb.operation.DocumentHelper.putIfNotNull;
import static com.mongodb.operation.DocumentHelper.putIfNotZero;
import static com.mongodb.operation.DocumentHelper.putIfTrue;
import static com.mongodb.operation.OperationHelper.validateCollation;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
/**
* An operation that atomically finds and updates a single document.
*
* @param the operations result type.
* @since 3.0
* @mongodb.driver.manual reference/command/findAndModify/ findAndModify
*/
@Deprecated
public class FindAndUpdateOperation extends BaseFindAndModifyOperation {
private final BsonDocument update;
private final List updatePipeline;
private BsonDocument filter;
private BsonDocument projection;
private BsonDocument sort;
private long maxTimeMS;
private boolean returnOriginal = true;
private boolean upsert;
private Boolean bypassDocumentValidation;
private Collation collation;
private List arrayFilters;
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param decoder the decoder for the result documents.
* @param update the document containing update operators.
* @deprecated use {@link #FindAndUpdateOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument)} instead
*/
@Deprecated
public FindAndUpdateOperation(final MongoNamespace namespace, final Decoder decoder, final BsonDocument update) {
this(namespace, WriteConcern.ACKNOWLEDGED, false, decoder, update);
}
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param writeConcern the writeConcern for the operation
* @param decoder the decoder for the result documents.
* @param update the document containing update operators.
* @since 3.2
* @deprecated use {@link #FindAndUpdateOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument)} instead
*/
@Deprecated
public FindAndUpdateOperation(final MongoNamespace namespace, final WriteConcern writeConcern, final Decoder decoder,
final BsonDocument update) {
this(namespace, writeConcern, false, decoder, update);
}
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param writeConcern the writeConcern for the operation
* @param retryWrites if writes should be retried if they fail due to a network error.
* @param decoder the decoder for the result documents.
* @param update the document containing update operators.
* @since 3.6
*/
public FindAndUpdateOperation(final MongoNamespace namespace, final WriteConcern writeConcern, final boolean retryWrites,
final Decoder decoder, final BsonDocument update) {
super(namespace, writeConcern, retryWrites, decoder);
this.update = notNull("decoder", update);
this.updatePipeline = null;
}
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param writeConcern the writeConcern for the operation
* @param retryWrites if writes should be retried if they fail due to a network error.
* @param decoder the decoder for the result documents.
* @param update the pipeline containing update operators.
* @since 3.11
* @mongodb.server.release 4.2
*/
public FindAndUpdateOperation(final MongoNamespace namespace, final WriteConcern writeConcern, final boolean retryWrites,
final Decoder decoder, final List update) {
super(namespace, writeConcern, retryWrites, decoder);
this.updatePipeline = update;
this.update = null;
}
/**
* Gets the document containing update operators
*
* @return the update document
*/
@Nullable
public BsonDocument getUpdate() {
return update;
}
/**
* Gets the pipeline containing update operators
*
* @return the update pipeline
* @since 3.11
* @mongodb.server.release 4.2
*/
@Nullable
public List getUpdatePipeline() {
return updatePipeline;
}
/**
* Gets the query filter.
*
* @return the query filter
* @mongodb.driver.manual reference/method/db.collection.find/ Filter
*/
public BsonDocument getFilter() {
return filter;
}
/**
* Sets the filter to apply to the query.
*
* @param filter the filter, which may be null.
* @return this
* @mongodb.driver.manual reference/method/db.collection.find/ Filter
*/
public FindAndUpdateOperation filter(final BsonDocument filter) {
this.filter = filter;
return this;
}
/**
* Gets a document describing the fields to return for all matching documents.
*
* @return the project document, which may be null
* @mongodb.driver.manual reference/method/db.collection.find/ Projection
*/
public BsonDocument getProjection() {
return projection;
}
/**
* Sets a document describing the fields to return for all matching documents.
*
* @param projection the project document, which may be null.
* @return this
* @mongodb.driver.manual reference/method/db.collection.find/ Projection
*/
public FindAndUpdateOperation projection(final BsonDocument projection) {
this.projection = projection;
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
*/
public long getMaxTime(final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
return timeUnit.convert(maxTimeMS, 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
*/
public FindAndUpdateOperation maxTime(final long maxTime, final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
this.maxTimeMS = MILLISECONDS.convert(maxTime, timeUnit);
return this;
}
/**
* Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined
* order.
*
* @return a document describing the sort criteria
* @mongodb.driver.manual reference/method/cursor.sort/ Sort
*/
public BsonDocument getSort() {
return sort;
}
/**
* Sets the sort criteria to apply to the query.
*
* @param sort the sort criteria, which may be null.
* @return this
* @mongodb.driver.manual reference/method/cursor.sort/ Sort
*/
public FindAndUpdateOperation sort(final BsonDocument sort) {
this.sort = sort;
return this;
}
/**
* When false, returns the updated document rather than the original. The default is false.
*
* @return true if the original document should be returned
*/
public boolean isReturnOriginal() {
return returnOriginal;
}
/**
* Set to false if the updated document rather than the original should be returned.
*
* @param returnOriginal set to false if the updated document rather than the original should be returned
* @return this
*/
public FindAndUpdateOperation returnOriginal(final boolean returnOriginal) {
this.returnOriginal = returnOriginal;
return this;
}
/**
* Returns true if a new document should be inserted if there are no matches to the query filter. The default is false.
*
* @return true if a new document should be inserted if there are no matches to the query filter
*/
public boolean isUpsert() {
return upsert;
}
/**
* Set to true if a new document should be inserted if there are no matches to the query filter.
*
* @param upsert true if a new document should be inserted if there are no matches to the query filter
* @return this
*/
public FindAndUpdateOperation upsert(final boolean upsert) {
this.upsert = upsert;
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.
*
* @param bypassDocumentValidation If true, allows the write to opt-out of document level validation.
* @return this
* @since 3.2
* @mongodb.driver.manual reference/command/aggregate/ Aggregation
* @mongodb.server.release 3.2
*/
public FindAndUpdateOperation 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
*
* A null value represents the server default.
* @param collation the collation options to use
* @return this
* @since 3.4
* @mongodb.server.release 3.4
*/
public FindAndUpdateOperation collation(final Collation collation) {
this.collation = collation;
return this;
}
/**
* Sets the array filters option
*
* @param arrayFilters the array filters, which may be null
* @return this
* @since 3.6
* @mongodb.server.release 3.6
*/
public FindAndUpdateOperation arrayFilters(final List arrayFilters) {
this.arrayFilters = arrayFilters;
return this;
}
/**
* Returns the array filters option
*
* @return the array filters, which may be null
* @since 3.6
* @mongodb.server.release 3.6
*/
public List getArrayFilters() {
return arrayFilters;
}
@Override
protected String getDatabaseName() {
return getNamespace().getDatabaseName();
}
@Override
protected FieldNameValidator getFieldNameValidator() {
Map map = new HashMap();
map.put("update", new UpdateFieldNameValidator());
return new MappedFieldNameValidator(new NoOpFieldNameValidator(), map);
}
@Override
protected CommandCreator getCommandCreator(final SessionContext sessionContext) {
return new CommandCreator() {
@Override
public BsonDocument create(final ServerDescription serverDescription, final ConnectionDescription connectionDescription) {
return createCommand(sessionContext, serverDescription, connectionDescription);
}
};
}
private BsonDocument createCommand(final SessionContext sessionContext, final ServerDescription serverDescription,
final ConnectionDescription connectionDescription) {
validateCollation(connectionDescription, collation);
BsonDocument commandDocument = new BsonDocument("findAndModify", new BsonString(getNamespace().getCollectionName()));
putIfNotNull(commandDocument, "query", getFilter());
putIfNotNull(commandDocument, "fields", getProjection());
putIfNotNull(commandDocument, "sort", getSort());
commandDocument.put("new", new BsonBoolean(!isReturnOriginal()));
putIfTrue(commandDocument, "upsert", isUpsert());
putIfNotZero(commandDocument, "maxTimeMS", getMaxTime(MILLISECONDS));
if (getUpdatePipeline() != null) {
commandDocument.put("update", new BsonArray(getUpdatePipeline()));
} else {
putIfNotNull(commandDocument, "update", getUpdate());
}
if (bypassDocumentValidation != null && serverIsAtLeastVersionThreeDotTwo(connectionDescription)) {
commandDocument.put("bypassDocumentValidation", BsonBoolean.valueOf(bypassDocumentValidation));
}
addWriteConcernToCommand(connectionDescription, commandDocument, sessionContext);
if (collation != null) {
commandDocument.put("collation", collation.asDocument());
}
if (arrayFilters != null) {
commandDocument.put("arrayFilters", new BsonArray(arrayFilters));
}
addTxnNumberToCommand(serverDescription, connectionDescription, commandDocument, sessionContext);
return commandDocument;
}
}