com.mongodb.rx.client.gridfs

Interface GridFSFindObservable

All Superinterfaces:

MongoObservable<com.mongodb.client.gridfs.model.GridFSFile>

public interface GridFSFindObservable
extends MongoObservable<com.mongodb.client.gridfs.model.GridFSFile>

Iterable for the GridFS Files Collection.

Since:

1.3

Method Summary

Modifier and Type	Method and Description
GridFSFindObservable	collation(com.mongodb.client.model.Collation collation) Sets the collation options
GridFSFindObservable	filter(org.bson.conversions.Bson filter) Sets the query filter to apply to the query.
rx.Observable<com.mongodb.client.gridfs.model.GridFSFile>	first() Helper to return an observable limited first from the query.
GridFSFindObservable	limit(int limit) Sets the limit to apply.
GridFSFindObservable	maxTime(long maxTime, TimeUnit timeUnit) Sets the maximum execution time on the server for this operation.
GridFSFindObservable	noCursorTimeout(boolean noCursorTimeout) The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
GridFSFindObservable	skip(int skip) Sets the number of documents to skip.
GridFSFindObservable	sort(org.bson.conversions.Bson sort) Sets the sort criteria to apply to the query.

Methods inherited from interface com.mongodb.rx.client.MongoObservable

subscribe, toObservable

Method Detail

first

rx.Observable<com.mongodb.client.gridfs.model.GridFSFile> first()

Helper to return an observable limited first from the query.

Returns:

an observable with a single element

filter

GridFSFindObservable filter(org.bson.conversions.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

GridFSFindObservable limit(int limit)

Sets the limit to apply.

Parameters:

limit - the limit, which may be null

Returns:

this

MongoDB documentation

Limit

skip

GridFSFindObservable skip(int skip)

Sets the number of documents to skip.

Parameters:

skip - the number of documents to skip

Returns:

this

MongoDB documentation

Skip

sort

GridFSFindObservable sort(org.bson.conversions.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

GridFSFindObservable 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

GridFSFindObservable 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

GridFSFindObservable collation(com.mongodb.client.model.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