Package com.mongodb.client

Interface MongoIterable<TResult>

Type Parameters:
TResult - The type that this iterable will decode documents to.
All Superinterfaces:
Iterable<TResult>
All Known Subinterfaces:
AggregateIterable<TResult>, ChangeStreamIterable<TResult>, DistinctIterable<TResult>, FindIterable<TResult>, GridFSFindIterable, ListCollectionNamesIterable, ListCollectionsIterable<TResult>, ListDatabasesIterable<TResult>, ListIndexesIterable<TResult>, ListSearchIndexesIterable<TResult>, MapReduceIterable<TResult>
public interface MongoIterable<TResult> extends Iterable<TResult>
The MongoIterable is the results from an operation, such as a query.
Since:
3.0

  • Method Details

    • iterator

      MongoCursor<TResult> iterator()
      Specified by:
      iterator in interface Iterable<TResult>
      Returns:
      A MongoCursor that must be closed.

    • cursor

      MongoCursor<TResult> cursor()
      Returns a cursor used for iterating over elements of type TResult. The cursor is primarily used for change streams.
      Returns:
      a cursor equivalent to that returned from iterator().
      Since:
      3.11

    • first

      @Nullable TResult first()
      Helper to return the first item in the iterator or null.
      Returns:
      T the first item or null.

    • map

      <U> MongoIterable<U> map(com.mongodb.Function<TResult,U> mapper)
      Maps this iterable from the source document type to the target document type.
      Type Parameters:
      U - the target document type
      Parameters:
      mapper - a function that maps from the source to the target document type
      Returns:
      an iterable which maps T to U

    • into

      <A extends Collection<? super TResult>> A into(A target)
      Iterates over all the documents, adding each to the given target.
      Type Parameters:
      A - the collection type
      Parameters:
      target - the collection to insert into
      Returns:
      the target

    • batchSize

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