com.mongodb.operation.ListIndexesOperation 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.MongoCommandException;
import com.mongodb.MongoNamespace;
import com.mongodb.ReadPreference;
import com.mongodb.ServerAddress;
import com.mongodb.async.AsyncBatchCursor;
import com.mongodb.async.SingleResultCallback;
import com.mongodb.binding.AsyncConnectionSource;
import com.mongodb.binding.AsyncReadBinding;
import com.mongodb.binding.ConnectionSource;
import com.mongodb.binding.ReadBinding;
import com.mongodb.connection.AsyncConnection;
import com.mongodb.connection.Connection;
import com.mongodb.connection.ConnectionDescription;
import com.mongodb.connection.QueryResult;
import com.mongodb.operation.CommandOperationHelper.CommandTransformer;
import org.bson.BsonDocument;
import org.bson.BsonInt64;
import org.bson.BsonString;
import org.bson.codecs.Codec;
import org.bson.codecs.Decoder;
import java.util.concurrent.TimeUnit;
import static com.mongodb.ReadPreference.primary;
import static com.mongodb.assertions.Assertions.notNull;
import static com.mongodb.connection.ServerType.SHARD_ROUTER;
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.CommandOperationHelper.isNamespaceError;
import static com.mongodb.operation.CommandOperationHelper.rethrowIfNotNamespaceError;
import static com.mongodb.operation.CursorHelper.getCursorDocumentFromBatchSize;
import static com.mongodb.operation.OperationHelper.AsyncCallableWithConnectionAndSource;
import static com.mongodb.operation.OperationHelper.LOGGER;
import static com.mongodb.operation.OperationHelper.createEmptyAsyncBatchCursor;
import static com.mongodb.operation.OperationHelper.createEmptyBatchCursor;
import static com.mongodb.operation.OperationHelper.cursorDocumentToAsyncBatchCursor;
import static com.mongodb.operation.OperationHelper.cursorDocumentToBatchCursor;
import static com.mongodb.operation.OperationHelper.releasingCallback;
import static com.mongodb.internal.operation.ServerVersionHelper.serverIsAtLeastVersionThreeDotZero;
import static com.mongodb.operation.OperationHelper.withConnection;
/**
* An operation that lists the indexes that have been created on a collection. For flexibility, the type of each document returned is
* generic.
*
* @param the operations result type.
* @since 3.0
* @mongodb.driver.manual reference/command/listIndexes/ List indexes
*/
public class ListIndexesOperation implements AsyncReadOperation>, ReadOperation> {
private final MongoNamespace namespace;
private final Decoder decoder;
private int batchSize;
private long maxTimeMS;
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param decoder the decoder for the result documents.
*/
public ListIndexesOperation(final MongoNamespace namespace, final Decoder decoder) {
this.namespace = notNull("namespace", namespace);
this.decoder = notNull("decoder", decoder);
}
/**
* Gets the number of documents to return per batch.
*
* @return the batch size
* @mongodb.server.release 3.0
* @mongodb.driver.manual reference/method/cursor.batchSize/#cursor.batchSize Batch Size
*/
public Integer getBatchSize() {
return batchSize;
}
/**
* Sets the number of documents to return per batch.
*
* @param batchSize the batch size
* @return this
* @mongodb.server.release 3.0
* @mongodb.driver.manual reference/method/cursor.batchSize/#cursor.batchSize Batch Size
*/
public ListIndexesOperation batchSize(final int batchSize) {
this.batchSize = batchSize;
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/operator/meta/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/operator/meta/maxTimeMS/ Max Time
*/
public ListIndexesOperation maxTime(final long maxTime, final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
this.maxTimeMS = TimeUnit.MILLISECONDS.convert(maxTime, timeUnit);
return this;
}
@Override
public BatchCursor execute(final ReadBinding binding) {
return withConnection(binding, new OperationHelper.CallableWithConnectionAndSource>() {
@Override
public BatchCursor call(final ConnectionSource source, final Connection connection) {
if (serverIsAtLeastVersionThreeDotZero(connection.getDescription())) {
try {
return executeWrappedCommandProtocol(binding, namespace.getDatabaseName(), getCommand(), createCommandDecoder(),
connection, transformer(source));
} catch (MongoCommandException e) {
return rethrowIfNotNamespaceError(e, createEmptyBatchCursor(namespace, decoder,
source.getServerDescription().getAddress(), batchSize));
}
} else {
return new QueryBatchCursor(connection.query(getIndexNamespace(),
asQueryDocument(connection.getDescription(), binding.getReadPreference()), null, 0, 0, batchSize,
binding.getReadPreference().isSlaveOk(), false, false, false, false, false, decoder), 0, batchSize, decoder,
source);
}
}
});
}
@Override
public void executeAsync(final AsyncReadBinding binding, final SingleResultCallback> callback) {
withConnection(binding, new AsyncCallableWithConnectionAndSource() {
@Override
public void call(final AsyncConnectionSource source, final AsyncConnection connection, final Throwable t) {
SingleResultCallback> errHandlingCallback = errorHandlingCallback(callback, LOGGER);
if (t != null) {
errHandlingCallback.onResult(null, t);
} else {
final SingleResultCallback> wrappedCallback = releasingCallback(errHandlingCallback,
source, connection);
if (serverIsAtLeastVersionThreeDotZero(connection.getDescription())) {
executeWrappedCommandProtocolAsync(binding, namespace.getDatabaseName(), getCommand(), createCommandDecoder(),
connection, asyncTransformer(source, connection),
new SingleResultCallback>() {
@Override
public void onResult(final AsyncBatchCursor result,
final Throwable t) {
if (t != null && !isNamespaceError(t)) {
wrappedCallback.onResult(null, t);
} else {
wrappedCallback.onResult(result != null
? result : emptyAsyncCursor(source),
null);
}
}
});
} else {
connection.queryAsync(getIndexNamespace(),
asQueryDocument(connection.getDescription(), binding.getReadPreference()), null, 0, 0, batchSize,
binding.getReadPreference().isSlaveOk(), false, false, false, false, false, decoder,
new SingleResultCallback>() {
@Override
public void onResult(final QueryResult result, final Throwable t) {
if (t != null) {
wrappedCallback.onResult(null, t);
} else {
wrappedCallback.onResult(new AsyncQueryBatchCursor(result, 0, batchSize, 0, decoder, source,
connection),
null);
}
}
});
}
}
}
});
}
private AsyncBatchCursor emptyAsyncCursor(final AsyncConnectionSource source) {
return createEmptyAsyncBatchCursor(namespace, source.getServerDescription().getAddress());
}
private BsonDocument asQueryDocument(final ConnectionDescription connectionDescription, final ReadPreference readPreference) {
BsonDocument document = new BsonDocument("$query", new BsonDocument("ns", new BsonString(namespace.getFullName())));
if (maxTimeMS > 0) {
document.put("$maxTimeMS", new BsonInt64(maxTimeMS));
}
if (connectionDescription.getServerType() == SHARD_ROUTER && !readPreference.equals(primary())) {
document.put("$readPreference", readPreference.toDocument());
}
return document;
}
private MongoNamespace getIndexNamespace() {
return new MongoNamespace(namespace.getDatabaseName(), "system.indexes");
}
private BsonDocument getCommand() {
BsonDocument command = new BsonDocument("listIndexes", new BsonString(namespace.getCollectionName()))
.append("cursor", getCursorDocumentFromBatchSize(batchSize == 0 ? null : batchSize));
if (maxTimeMS > 0) {
command.put("maxTimeMS", new BsonInt64(maxTimeMS));
}
return command;
}
private CommandTransformer> transformer(final ConnectionSource source) {
return new CommandTransformer>() {
@Override
public BatchCursor apply(final BsonDocument result, final ServerAddress serverAddress) {
return cursorDocumentToBatchCursor(result.getDocument("cursor"), decoder, source, batchSize);
}
};
}
private CommandTransformer> asyncTransformer(final AsyncConnectionSource source,
final AsyncConnection connection) {
return new CommandTransformer>() {
@Override
public AsyncBatchCursor apply(final BsonDocument result, final ServerAddress serverAddress) {
return cursorDocumentToAsyncBatchCursor(result.getDocument("cursor"), decoder, source, connection, batchSize);
}
};
}
private Codec createCommandDecoder() {
return CommandResultDocumentCodec.create(decoder, "firstBatch");
}
}