Package com.mongodb.operation

Class ListCollectionsOperation<T>

java.lang.Object

com.mongodb.operation.ListCollectionsOperation<T>

Type Parameters:

T - the document type

All Implemented Interfaces:

AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>

public class ListCollectionsOperation<T>
extends Object
implements AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>

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 name field of each returned document is the simple name of the collection rather than the full namespace.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
ListCollectionsOperation(String databaseName, Decoder<T> decoder)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
ListCollectionsOperation<T>	batchSize(int batchSize)	Sets the number of documents to return per batch.
BatchCursor<T>	execute(ReadBinding binding)	General execute which can return anything of type T
void	executeAsync(AsyncReadBinding binding, SingleResultCallback<AsyncBatchCursor<T>> callback)	General execute which can return anything of type T
ListCollectionsOperation<T>	filter(BsonDocument filter)	Sets the query filter to apply to the query.
Integer	getBatchSize()	Gets the number of documents to return per batch.
BsonDocument	getFilter()	Gets the query filter.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
boolean	isNameOnly()	Gets whether only the collection names should be returned.
ListCollectionsOperation<T>	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
ListCollectionsOperation<T>	nameOnly(boolean nameOnly)	Sets the query filter to apply to the query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListCollectionsOperation

public ListCollectionsOperation(String databaseName,
                                Decoder<T> decoder)

Construct a new instance.

Parameters:

databaseName - the name of the database for the operation.

decoder - the decoder to use for the results

Method Detail

getFilter

public BsonDocument getFilter()

Gets the query filter.

Returns:

the query filter

MongoDB documentation

Filter

isNameOnly

public boolean isNameOnly()

Gets whether only the collection names should be returned.

Returns:

true if only the collection names should be returned

Since:

3.8

Since server release

4.0

filter

public ListCollectionsOperation<T> filter(BsonDocument filter)

Sets the query filter to apply to the query.

Parameters:

filter - the filter, which may be null.

Returns:

this

MongoDB documentation

Filter

nameOnly

public ListCollectionsOperation<T> nameOnly(boolean nameOnly)

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.

Parameters:

nameOnly - true if only the collection names should be requested from the server

Returns:

this

Since:

3.8

Since server release

4.0

getBatchSize

public Integer getBatchSize()

Gets the number of documents to return per batch.

Returns:

the batch size

MongoDB documentation

Batch Size

Since server release

3.0

batchSize

public ListCollectionsOperation<T> batchSize(int batchSize)

Sets the number of documents to return per batch.

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size

Since server release

3.0

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum execution time in the given time unit

MongoDB documentation

Max Time

maxTime

public ListCollectionsOperation<T> maxTime(long maxTime,
                                           TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

MongoDB documentation

Max Time

execute

public BatchCursor<T> execute(ReadBinding binding)

Description copied from interface: ReadOperation

General execute which can return anything of type T

Specified by:

execute in interface ReadOperation<T>

Parameters:

binding - the binding to execute in the context of

Returns:

T, the result of the execution

executeAsync

public void executeAsync(AsyncReadBinding binding,
                         SingleResultCallback<AsyncBatchCursor<T>> callback)

Description copied from interface: AsyncReadOperation

General execute which can return anything of type T

Specified by:

executeAsync in interface AsyncReadOperation<T>

Parameters:

binding - the binding to execute in the context of

callback - the callback to be called when the operation has been executed