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>>
@Deprecated public class ListCollectionsOperation<T> extends Object implements AsyncReadOperation<AsyncBatchCursor<T>>, ReadOperation<BatchCursor<T>>
Deprecated.
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 Details

    • ListCollectionsOperation

      public ListCollectionsOperation(String databaseName, Decoder<T> decoder)
      Deprecated.
      Construct a new instance.
      Parameters:
      databaseName - the name of the database for the operation.
      decoder - the decoder to use for the results

  • Method Details

    • getFilter

      public BsonDocument getFilter()
      Deprecated.
      Gets the query filter.
      Returns:
      the query filter

    • isNameOnly

      public boolean isNameOnly()
      Deprecated.
      Gets whether only the collection names should be returned.
      Returns:
      true if only the collection names should be returned
      Since:
      3.8

    • filter

      public ListCollectionsOperation<T> filter(BsonDocument filter)
      Deprecated.
      Sets the query filter to apply to the query.
      Parameters:
      filter - the filter, which may be null.
      Returns:
      this

    • nameOnly

      public ListCollectionsOperation<T> nameOnly(boolean nameOnly)
      Deprecated.
      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

    • getBatchSize

      public Integer getBatchSize()
      Deprecated.
      Gets the number of documents to return per batch.
      Returns:
      the batch size

    • batchSize

      public ListCollectionsOperation<T> batchSize(int batchSize)
      Deprecated.
      Sets the number of documents to return per batch.
      Parameters:
      batchSize - the batch size
      Returns:
      this

    • getMaxTime

      public long getMaxTime(TimeUnit timeUnit)
      Deprecated.
      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

    • maxTime

      public ListCollectionsOperation<T> maxTime(long maxTime, TimeUnit timeUnit)
      Deprecated.
      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

    • retryReads

      public ListCollectionsOperation<T> retryReads(boolean retryReads)
      Deprecated.
      Enables retryable reads if a read fails due to a network error.
      Parameters:
      retryReads - true if reads should be retried
      Returns:
      this
      Since:
      3.11

    • getRetryReads

      public boolean getRetryReads()
      Deprecated.
      Gets the value for retryable reads. The default is true.
      Returns:
      the retryable reads value
      Since:
      3.11

    • execute

      public BatchCursor<T> execute(ReadBinding binding)
      Deprecated.
      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)
      Deprecated.
      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