com.mongodb.operation.CreateIndexesOperation 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 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.DuplicateKeyException;
import com.mongodb.ErrorCategory;
import com.mongodb.MongoCommandException;
import com.mongodb.MongoException;
import com.mongodb.MongoNamespace;
import com.mongodb.WriteConcern;
import com.mongodb.WriteConcernResult;
import com.mongodb.async.SingleResultCallback;
import com.mongodb.binding.AsyncWriteBinding;
import com.mongodb.binding.WriteBinding;
import com.mongodb.bulk.IndexRequest;
import com.mongodb.connection.AsyncConnection;
import com.mongodb.connection.Connection;
import com.mongodb.connection.ConnectionDescription;
import com.mongodb.internal.operation.IndexHelper;
import org.bson.BsonArray;
import org.bson.BsonBoolean;
import org.bson.BsonDocument;
import org.bson.BsonDouble;
import org.bson.BsonInt32;
import org.bson.BsonInt64;
import org.bson.BsonString;
import java.util.ArrayList;
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.executeCommand;
import static com.mongodb.operation.CommandOperationHelper.executeCommandAsync;
import static com.mongodb.operation.CommandOperationHelper.writeConcernErrorWriteTransformer;
import static com.mongodb.operation.DocumentHelper.putIfNotZero;
import static com.mongodb.internal.operation.IndexHelper.generateIndexName;
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.releasingCallback;
import static com.mongodb.operation.OperationHelper.validateIndexRequestCollations;
import static com.mongodb.operation.OperationHelper.withConnection;
import static com.mongodb.internal.operation.WriteConcernHelper.appendWriteConcernToCommand;
import static com.mongodb.operation.CommandOperationHelper.writeConcernErrorTransformer;
/**
* An operation that creates one or more indexes.
*
* Multiple index creation is supported starting with MongoDB server version 2.6
*
* @mongodb.driver.manual reference/command/createIndexes/ Create indexes
* @since 3.0
*/
@Deprecated
public class CreateIndexesOperation implements AsyncWriteOperation, WriteOperation {
private final MongoNamespace namespace;
private final List requests;
private final WriteConcern writeConcern;
private long maxTimeMS;
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param requests the index request
* @deprecated Prefer {@link #CreateIndexesOperation(MongoNamespace, List, WriteConcern)}
*/
@Deprecated
public CreateIndexesOperation(final MongoNamespace namespace, final List requests) {
this(namespace, requests, null);
}
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param requests the index request
* @param writeConcern the write concern
*
* @since 3.4
*/
public CreateIndexesOperation(final MongoNamespace namespace, final List requests, final WriteConcern writeConcern) {
this.namespace = notNull("namespace", namespace);
this.requests = notNull("indexRequests", requests);
this.writeConcern = writeConcern;
}
/**
* Gets the write concern.
*
* @return the write concern, which may be null
*
* @since 3.4
*/
public WriteConcern getWriteConcern() {
return writeConcern;
}
/**
* Gets the index requests.
*
* @return the index requests
*/
public List getRequests() {
return requests;
}
/**
* Gets the index names.
*
* @return a list of index names
*/
public List getIndexNames() {
List indexNames = new ArrayList(requests.size());
for (IndexRequest request : requests) {
if (request.getName() != null) {
indexNames.add(request.getName());
} else {
indexNames.add(IndexHelper.generateIndexName(request.getKeys()));
}
}
return indexNames;
}
/**
* 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
* @since 3.6
*/
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
* @since 3.6
*/
public CreateIndexesOperation maxTime(final long maxTime, final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
isTrueArgument("maxTime >= 0", maxTime >= 0);
this.maxTimeMS = TimeUnit.MILLISECONDS.convert(maxTime, timeUnit);
return this;
}
@Override
public Void execute(final WriteBinding binding) {
return withConnection(binding, new CallableWithConnection() {
@Override
public Void call(final Connection connection) {
try {
validateIndexRequestCollations(connection, requests);
executeCommand(binding, namespace.getDatabaseName(), getCommand(connection.getDescription()),
connection, writeConcernErrorTransformer());
} catch (MongoCommandException e) {
throw checkForDuplicateKeyError(e);
}
return null;
}
});
}
@Override
public void executeAsync(final AsyncWriteBinding binding, final SingleResultCallback callback) {
withConnection(binding, new AsyncCallableWithConnection() {
@Override
public void call(final AsyncConnection connection, final Throwable t) {
SingleResultCallback errHandlingCallback = errorHandlingCallback(callback, LOGGER);
if (t != null) {
errHandlingCallback.onResult(null, t);
} else {
final SingleResultCallback wrappedCallback = releasingCallback(errHandlingCallback, connection);
validateIndexRequestCollations(connection, requests, new AsyncCallableWithConnection() {
@Override
public void call(final AsyncConnection connection, final Throwable t) {
if (t != null) {
wrappedCallback.onResult(null, t);
} else {
executeCommandAsync(binding, namespace.getDatabaseName(),
getCommand(connection.getDescription()), connection, writeConcernErrorWriteTransformer(),
new SingleResultCallback() {
@Override
public void onResult(final Void result, final Throwable t) {
wrappedCallback.onResult(null, translateException(t));
}
});
}
}
});
}
}
});
}
private BsonDocument getIndex(final IndexRequest request) {
BsonDocument index = new BsonDocument();
index.append("key", request.getKeys());
index.append("name", new BsonString(request.getName() != null ? request.getName() : generateIndexName(request.getKeys())));
index.append("ns", new BsonString(namespace.getFullName()));
if (request.isBackground()) {
index.append("background", BsonBoolean.TRUE);
}
if (request.isUnique()) {
index.append("unique", BsonBoolean.TRUE);
}
if (request.isSparse()) {
index.append("sparse", BsonBoolean.TRUE);
}
if (request.getExpireAfter(TimeUnit.SECONDS) != null) {
index.append("expireAfterSeconds", new BsonInt64(request.getExpireAfter(TimeUnit.SECONDS)));
}
if (request.getVersion() != null) {
index.append("v", new BsonInt32(request.getVersion()));
}
if (request.getWeights() != null) {
index.append("weights", request.getWeights());
}
if (request.getDefaultLanguage() != null) {
index.append("default_language", new BsonString(request.getDefaultLanguage()));
}
if (request.getLanguageOverride() != null) {
index.append("language_override", new BsonString(request.getLanguageOverride()));
}
if (request.getTextVersion() != null) {
index.append("textIndexVersion", new BsonInt32(request.getTextVersion()));
}
if (request.getSphereVersion() != null) {
index.append("2dsphereIndexVersion", new BsonInt32(request.getSphereVersion()));
}
if (request.getBits() != null) {
index.append("bits", new BsonInt32(request.getBits()));
}
if (request.getMin() != null) {
index.append("min", new BsonDouble(request.getMin()));
}
if (request.getMax() != null) {
index.append("max", new BsonDouble(request.getMax()));
}
if (request.getBucketSize() != null) {
index.append("bucketSize", new BsonDouble(request.getBucketSize()));
}
if (request.getDropDups()) {
index.append("dropDups", BsonBoolean.TRUE);
}
if (request.getStorageEngine() != null) {
index.append("storageEngine", request.getStorageEngine());
}
if (request.getPartialFilterExpression() != null) {
index.append("partialFilterExpression", request.getPartialFilterExpression());
}
if (request.getCollation() != null) {
index.append("collation", request.getCollation().asDocument());
}
if (request.getWildcardProjection() != null) {
index.append("wildcardProjection", request.getWildcardProjection());
}
return index;
}
private BsonDocument getCommand(final ConnectionDescription description) {
BsonDocument command = new BsonDocument("createIndexes", new BsonString(namespace.getCollectionName()));
List values = new ArrayList();
for (IndexRequest request : requests) {
values.add(getIndex(request));
}
command.put("indexes", new BsonArray(values));
putIfNotZero(command, "maxTimeMS", maxTimeMS);
appendWriteConcernToCommand(writeConcern, command, description);
return command;
}
private MongoException translateException(final Throwable t) {
return (t instanceof MongoCommandException) ? checkForDuplicateKeyError((MongoCommandException) t)
: MongoException.fromThrowable(t);
}
@SuppressWarnings("deprecation")
private MongoException checkForDuplicateKeyError(final MongoCommandException e) {
if (ErrorCategory.fromErrorCode(e.getCode()) == ErrorCategory.DUPLICATE_KEY) {
return new DuplicateKeyException(e.getResponse(), e.getServerAddress(), WriteConcernResult.acknowledged(0, false, null));
} else {
return e;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy