Package com.mongodb.client

Interface ListDatabasesIterable<TResult>

Type Parameters:
TResult - The type of the result.
All Superinterfaces:
Iterable<TResult>, MongoIterable<TResult>
public interface ListDatabasesIterable<TResult> extends MongoIterable<TResult>
Iterable for ListDatabases.
Since:
3.0

  • Method Details

    • maxTime

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

    • batchSize

      ListDatabasesIterable<TResult> batchSize(int batchSize)
      Sets the number of documents to return per batch.
      Specified by:
      batchSize in interface MongoIterable<TResult>
      Parameters:
      batchSize - the batch size
      Returns:
      this
      MongoDB documentation
      Batch Size

    • filter

      ListDatabasesIterable<TResult> filter(@Nullable Bson 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.4.2

    • nameOnly

      ListDatabasesIterable<TResult> nameOnly(@Nullable 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.4.3

    • authorizedDatabasesOnly

      ListDatabasesIterable<TResult> authorizedDatabasesOnly(@Nullable Boolean authorizedDatabasesOnly)
      Sets the authorizedDatabasesOnly flag that indicates whether the command should return just the databases which the user is authorized to see.
      Parameters:
      authorizedDatabasesOnly - the authorizedDatabasesOnly flag, which may be null
      Returns:
      this
      Since:
      4.1
      Since server release
      4.0

    • comment

      ListDatabasesIterable<TResult> comment(@Nullable String comment)
      Sets the comment for this operation. A null value means no comment is set.
      Parameters:
      comment - the comment
      Returns:
      this
      Since:
      4.6
      Since server release
      4.4

    • comment

      ListDatabasesIterable<TResult> comment(@Nullable BsonValue comment)
      Sets the comment for this operation. A null value means no comment is set.
      Parameters:
      comment - the comment
      Returns:
      this
      Since:
      4.6
      Since server release
      4.4

    • timeoutMode

      @Alpha(CLIENT) ListDatabasesIterable<TResult> timeoutMode(TimeoutMode timeoutMode)
      Sets the timeoutMode for the cursor.

      Requires the timeout to be set, either in the MongoClientSettings, via MongoDatabase or via MongoCollection

      Parameters:
      timeoutMode - the timeout mode
      Returns:
      this
      Since:
      5.2