com.mongodb.operation.ListCollectionsOperation 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.ServerCursor;
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.BsonArray;
import org.bson.BsonBoolean;
import org.bson.BsonDocument;
import org.bson.BsonDocumentReader;
import org.bson.BsonInt32;
import org.bson.BsonInt64;
import org.bson.BsonRegularExpression;
import org.bson.BsonString;
import org.bson.codecs.BsonDocumentCodec;
import org.bson.codecs.Codec;
import org.bson.codecs.Decoder;
import org.bson.codecs.DecoderContext;
import java.util.ArrayList;
import java.util.List;
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.internal.operation.ServerVersionHelper.serverIsAtLeastVersionThreeDotZero;
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.CallableWithConnectionAndSource;
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.operation.OperationHelper.withConnection;
import static java.lang.String.format;
import static java.util.Arrays.asList;
/**
* An operation that provides a cursor allowing iteration through the metadata of all the collections in a database. This operation
* ensures that the value of the {@code name} field of each returned document is the simple name of the collection rather than the full
* namespace.
*
* @param the document type
* @since 3.0
*/
public class ListCollectionsOperation implements AsyncReadOperation>, ReadOperation> {
private final String databaseName;
private final Decoder decoder;
private BsonDocument filter;
private int batchSize;
private long maxTimeMS;
private boolean nameOnly;
/**
* Construct a new instance.
*
* @param databaseName the name of the database for the operation.
* @param decoder the decoder to use for the results
*/
public ListCollectionsOperation(final String databaseName, final Decoder decoder) {
this.databaseName = notNull("databaseName", databaseName);
this.decoder = notNull("decoder", decoder);
}
/**
* Gets the query filter.
*
* @return the query filter
* @mongodb.driver.manual reference/method/db.collection.find/ Filter
*/
public BsonDocument getFilter() {
return filter;
}
/**
* Gets whether only the collection names should be returned.
*
* @return true if only the collection names should be returned
* @since 3.8
* @mongodb.server.release 4.0
*/
public boolean isNameOnly() {
return nameOnly;
}
/**
* Sets the query 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 ListCollectionsOperation filter(final BsonDocument filter) {
this.filter = filter;
return this;
}
/**
* Sets the query filter to apply to the query.
*
* Note: this is advisory only, and should be considered an optimization. Server versions prior to MongoDB 4.0 will ignore
* this request.
*
*
* @param nameOnly true if only the collection names should be requested from the server
* @return this
* @since 3.8
* @mongodb.server.release 4.0
*/
public ListCollectionsOperation nameOnly(final boolean nameOnly) {
this.nameOnly = nameOnly;
return this;
}
/**
* 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 ListCollectionsOperation 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 ListCollectionsOperation 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 CallableWithConnectionAndSource>() {
@Override
public BatchCursor call(final ConnectionSource source, final Connection connection) {
if (serverIsAtLeastVersionThreeDotZero(connection.getDescription())) {
try {
return executeWrappedCommandProtocol(binding, databaseName, getCommand(), createCommandDecoder(), connection,
commandTransformer(source));
} catch (MongoCommandException e) {
return rethrowIfNotNamespaceError(e, createEmptyBatchCursor(createNamespace(), decoder,
source.getServerDescription().getAddress(), batchSize));
}
} else {
return new ProjectingBatchCursor(new QueryBatchCursor(connection.query(getNamespace(),
asQueryDocument(connection.getDescription(), binding.getReadPreference()), null, 0, 0, batchSize,
binding.getReadPreference().isSlaveOk(), false, false, false, false, false, new BsonDocumentCodec()), 0,
batchSize, new BsonDocumentCodec(), 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, databaseName, 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(getNamespace(), asQueryDocument(connection.getDescription(), binding.getReadPreference()),
null, 0, 0, batchSize, binding.getReadPreference().isSlaveOk(), false, false, false, false, false,
new BsonDocumentCodec(), new SingleResultCallback>() {
@Override
public void onResult(final QueryResult result, final Throwable t) {
if (t != null) {
wrappedCallback.onResult(null, t);
} else {
wrappedCallback.onResult(new ProjectingAsyncBatchCursor(
new AsyncQueryBatchCursor(result, 0,
batchSize, 0, new BsonDocumentCodec(), source, connection)
), null);
}
}
});
}
}
}
});
}
private AsyncBatchCursor emptyAsyncCursor(final AsyncConnectionSource source) {
return createEmptyAsyncBatchCursor(createNamespace(), source.getServerDescription().getAddress());
}
private MongoNamespace createNamespace() {
return new MongoNamespace(databaseName, "$cmd.listCollections");
}
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 CommandTransformer> commandTransformer(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 MongoNamespace getNamespace() {
return new MongoNamespace(databaseName, "system.namespaces");
}
private BsonDocument getCommand() {
BsonDocument command = new BsonDocument("listCollections", new BsonInt32(1))
.append("cursor", getCursorDocumentFromBatchSize(batchSize == 0 ? null : batchSize));
if (filter != null) {
command.append("filter", filter);
}
if (nameOnly) {
command.append("nameOnly", BsonBoolean.TRUE);
}
if (maxTimeMS > 0) {
command.put("maxTimeMS", new BsonInt64(maxTimeMS));
}
return command;
}
private BsonDocument asQueryDocument(final ConnectionDescription connectionDescription, final ReadPreference readPreference) {
BsonDocument document = new BsonDocument();
BsonDocument transformedFilter = null;
if (filter != null) {
if (filter.containsKey("name")) {
if (!filter.isString("name")) {
throw new IllegalArgumentException("When filtering collections on MongoDB versions < 3.0 the name field "
+ "must be a string");
}
transformedFilter = new BsonDocument();
transformedFilter.putAll(filter);
transformedFilter.put("name", new BsonString(format("%s.%s", databaseName, filter.getString("name").getValue())));
} else {
transformedFilter = filter;
}
}
BsonDocument indexExcludingRegex = new BsonDocument("name", new BsonRegularExpression("^[^$]*$"));
BsonDocument query = transformedFilter == null ? indexExcludingRegex
: new BsonDocument("$and", new BsonArray(asList(indexExcludingRegex,
transformedFilter)));
document.put("$query", query);
if (connectionDescription.getServerType() == SHARD_ROUTER && !readPreference.equals(primary())) {
document.put("$readPreference", readPreference.toDocument());
}
if (maxTimeMS > 0) {
document.put("$maxTimeMS", new BsonInt64(maxTimeMS));
}
return document;
}
private Codec createCommandDecoder() {
return CommandResultDocumentCodec.create(decoder, "firstBatch");
}
private final class ProjectingBatchCursor implements BatchCursor {
private final BatchCursor delegate;
private ProjectingBatchCursor(final BatchCursor delegate) {
this.delegate = delegate;
}
@Override
public void remove() {
delegate.remove();
}
@Override
public void close() {
delegate.close();
}
@Override
public boolean hasNext() {
return delegate.hasNext();
}
@Override
public List next() {
return projectFromFullNamespaceToCollectionName(delegate.next());
}
@Override
public void setBatchSize(final int batchSize) {
delegate.setBatchSize(batchSize);
}
@Override
public int getBatchSize() {
return delegate.getBatchSize();
}
@Override
public List tryNext() {
return projectFromFullNamespaceToCollectionName(delegate.tryNext());
}
@Override
public ServerCursor getServerCursor() {
return delegate.getServerCursor();
}
@Override
public ServerAddress getServerAddress() {
return delegate.getServerAddress();
}
}
private final class ProjectingAsyncBatchCursor implements AsyncBatchCursor {
private final AsyncBatchCursor delegate;
private ProjectingAsyncBatchCursor(final AsyncBatchCursor delegate) {
this.delegate = delegate;
}
@Override
public void next(final SingleResultCallback> callback) {
delegate.next(new SingleResultCallback>() {
@Override
public void onResult(final List result, final Throwable t) {
if (t != null) {
callback.onResult(null, t);
} else {
callback.onResult(projectFromFullNamespaceToCollectionName(result), null);
}
}
});
}
@Override
public void tryNext(final SingleResultCallback> callback) {
delegate.tryNext(new SingleResultCallback>() {
@Override
public void onResult(final List result, final Throwable t) {
if (t != null) {
callback.onResult(null, t);
} else {
callback.onResult(projectFromFullNamespaceToCollectionName(result), null);
}
}
});
}
@Override
public void setBatchSize(final int batchSize) {
delegate.setBatchSize(batchSize);
}
@Override
public int getBatchSize() {
return delegate.getBatchSize();
}
@Override
public boolean isClosed() {
return delegate.isClosed();
}
@Override
public void close() {
delegate.close();
}
}
private List projectFromFullNamespaceToCollectionName(final List unstripped) {
if (unstripped == null) {
return null;
}
List stripped = new ArrayList(unstripped.size());
String prefix = databaseName + ".";
for (BsonDocument cur : unstripped) {
String name = cur.getString("name").getValue();
String collectionName = name.substring(prefix.length());
cur.put("name", new BsonString(collectionName));
stripped.add(decoder.decode(new BsonDocumentReader(cur), DecoderContext.builder().build()));
}
return stripped;
}
}