Package com.mongodb.reactivestreams.client.gridfs

Interface GridFSFindPublisher

  • All Superinterfaces:
    org.reactivestreams.Publisher<GridFSFile>
    public interface GridFSFindPublisher
extends org.reactivestreams.Publisher<GridFSFile>
    Iterable for the GridFS Files Collection.
    Since:
    1.3

    • Method Detail

      • first

        org.reactivestreams.Publisher<GridFSFile> first()
        Helper to return a publisher limited first from the query.
        Returns:
        a publisher with a single element

      • filter

        GridFSFindPublisher filter​(@Nullable
                           Bson filter)
        Sets the query filter to apply to the query.

        Below is an example of filtering against the filename and some nested metadata that can also be stored along with the file data: 

          
      Filters.and(Filters.eq("filename", "mongodb.png"), Filters.eq("metadata.contentType", "image/png"));
        Parameters:
        filter - the filter, which may be null.
        Returns:
        this
        See Also:
        Filters
        MongoDB documentation
        Filter

      • limit

        GridFSFindPublisher limit​(int limit)
        Sets the limit to apply.
        Parameters:
        limit - the limit, which may be null
        Returns:
        this
        MongoDB documentation
        Limit

      • skip

        GridFSFindPublisher skip​(int skip)
        Sets the number of documents to skip.
        Parameters:
        skip - the number of documents to skip
        Returns:
        this
        MongoDB documentation
        Skip

      • sort

        GridFSFindPublisher sort​(@Nullable
                         Bson sort)
        Sets the sort criteria to apply to the query.
        Parameters:
        sort - the sort criteria, which may be null.
        Returns:
        this
        MongoDB documentation
        Sort

      • noCursorTimeout

        GridFSFindPublisher noCursorTimeout​(boolean noCursorTimeout)
        The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
        Parameters:
        noCursorTimeout - true if cursor timeout is disabled
        Returns:
        this

      • maxTime

        GridFSFindPublisher 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

      • collation

        GridFSFindPublisher collation​(@Nullable
                              Collation collation)
        Sets the collation options

        A null value represents the server default.

        Parameters:
        collation - the collation options to use
        Returns:
        this
        Since:
        1.3
        Since server release
        3.4

      • batchSize

        GridFSFindPublisher 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