Package com.mongodb.client

Interface ListCollectionNamesIterable

All Superinterfaces:
Iterable<String>, MongoIterable<String>
public interface ListCollectionNamesIterable extends MongoIterable<String>
Iterable for listing collection names.
Since:
5.0
MongoDB documentation
listCollections

  • Method Details

    • filter

      ListCollectionNamesIterable filter(@Nullable Bson filter)
      Sets the query filter to apply to the query.
      Parameters:
      filter - the filter, which may be null.
      Returns:
      this
      MongoDB documentation
      Filter

    • maxTime

      ListCollectionNamesIterable 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

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

    • comment

      ListCollectionNamesIterable 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 server release
      4.4

    • comment

      ListCollectionNamesIterable 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 server release
      4.4

    • authorizedCollections

      ListCollectionNamesIterable authorizedCollections(boolean authorizedCollections)
      Sets the authorizedCollections field of the listCollections command.
      Parameters:
      authorizedCollections - If true, allows executing the listCollections command, which has the nameOnly field set to true, without having the listCollections privilege on the database resource.
      Returns:
      this.
      Since server release
      4.0