Package com.mongodb.operation

Class ListDatabasesOperation<T>

java.lang.Object

com.mongodb.operation.ListDatabasesOperation<T>

Type Parameters:

T - the document type

All Implemented Interfaces:

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

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

An operation that provides a cursor allowing iteration through the metadata of all the databases for a MongoClient.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
ListDatabasesOperation(Decoder<T> decoder)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
BatchCursor<T>	execute(ReadBinding binding)	Executing this will return a list of all the databases names in the MongoDB instance.
void	executeAsync(AsyncReadBinding binding, SingleResultCallback<AsyncBatchCursor<T>> callback)	General execute which can return anything of type T
ListDatabasesOperation<T>	filter(BsonDocument filter)	Sets the query filter to apply to the returned database names.
BsonDocument	getFilter()	Gets the query filter to apply to the returned database names.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
Boolean	getNameOnly()	Gets the nameOnly flag that indicates whether the command should return just the database names or return the database names and size information.
ListDatabasesOperation<T>	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
ListDatabasesOperation<T>	nameOnly(Boolean nameOnly)	Sets the nameOnly flag that indicates whether the command should return just the database names or return the database names and size information.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListDatabasesOperation

public ListDatabasesOperation(Decoder<T> decoder)

Construct a new instance.

Parameters:

decoder - the decoder to use for the results

Method Detail

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 ListDatabasesOperation<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

filter

public ListDatabasesOperation<T> filter(BsonDocument filter)

Sets the query filter to apply to the returned database names.

Parameters:

filter - the filter, which may be null.

Returns:

this

Since:

3.6

Since server release

3.6

getFilter

public BsonDocument getFilter()

Gets the query filter to apply to the returned database names.

Returns:

this

Since:

3.6

Since server release

3.6

nameOnly

public ListDatabasesOperation<T> nameOnly(Boolean nameOnly)

Sets the nameOnly flag that indicates whether the command should return just the database names or return the database names and size information.

Parameters:

nameOnly - the nameOnly flag, which may be null

Returns:

this

Since:

3.6

Since server release

3.6

getNameOnly

public Boolean getNameOnly()

Gets the nameOnly flag that indicates whether the command should return just the database names or return the database names and size information.

Returns:

this

Since:

3.6

Since server release

3.6

execute

public BatchCursor<T> execute(ReadBinding binding)

Executing this will return a list of all the databases names in the MongoDB instance.

Specified by:

execute in interface ReadOperation<T>

Parameters:

binding - the binding.

Returns:

a List of Strings of the names of all the databases in the MongoDB instance.

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