com.mongodb.reactivestreams.client

Interface ListDatabasesPublisher<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

org.reactivestreams.Publisher<TResult>

public interface ListDatabasesPublisher<TResult>
extends org.reactivestreams.Publisher<TResult>

Publisher interface for ListDatabases.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
ListDatabasesPublisher<TResult>	batchSize(int batchSize) Sets the number of documents to return per batch.
ListDatabasesPublisher<TResult>	filter(Bson filter) Sets the query filter to apply to the returned database names.
org.reactivestreams.Publisher<TResult>	first() Helper to return a publisher limited to the first result.
ListDatabasesPublisher<TResult>	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
ListDatabasesPublisher<TResult>	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 interface org.reactivestreams.Publisher

subscribe

Method Detail

maxTime

ListDatabasesPublisher<TResult> 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

ListDatabasesPublisher<TResult> filter(Bson filter)

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

Parameters:

filter - the filter, which may be null.

Returns:

this

Since:

1.7

Since server release

3.4.2

nameOnly

ListDatabasesPublisher<TResult> 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:

1.7

Since server release

3.4.3

batchSize

ListDatabasesPublisher<TResult> batchSize(int batchSize)

Sets the number of documents to return per batch.

Overrides the Subscription.request(long) value for setting the batch size, allowing for fine grained control over the underlying cursor.

Parameters:

batchSize - the batch size

Returns:

this

Since:

1.8

MongoDB documentation

Batch Size

first

org.reactivestreams.Publisher<TResult> first()

Helper to return a publisher limited to the first result.

Returns:

a Publisher which will contain a single item.

Since:

1.8