Package com.mongodb.client.model

Class DBCollectionFindOptions

  • public final class DBCollectionFindOptions
extends Object
    The options to apply to a find operation (also commonly referred to as a query).
    Since:
    3.4
    MongoDB documentation
    Find
    OP_QUERY

    • Constructor Detail

      • DBCollectionFindOptions

        public DBCollectionFindOptions()
        Construct a new instance

    • Method Detail

      • copy

        public DBCollectionFindOptions copy()
        Copy this DBCollectionFindOptions instance into a new instance.
        Returns:
        the new DBCollectionFindOptions with the same settings as this instance.

      • getLimit

        public int getLimit()
        Gets the limit to apply. The default is null.
        Returns:
        the limit
        MongoDB documentation
        Limit

      • limit

        public DBCollectionFindOptions limit​(int limit)
        Sets the limit to apply.
        Parameters:
        limit - the limit
        Returns:
        this
        MongoDB documentation
        Limit

      • getSkip

        public int getSkip()
        Gets the number of documents to skip. The default is 0.
        Returns:
        the number of documents to skip
        MongoDB documentation
        Skip

      • skip

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

      • getMaxTime

        public long getMaxTime​(TimeUnit timeUnit)
        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
        MongoDB documentation
        Max Time

      • maxTime

        public DBCollectionFindOptions 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

      • getMaxAwaitTime

        public long getMaxAwaitTime​(TimeUnit timeUnit)
        The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor, this option is ignored. On servers >= 3.2, this option will be specified on the getMore command as "maxTimeMS". The default is no value: no "maxTimeMS" is sent to the server with the getMore command. On servers < 3.2, this option is ignored, and indicates that the driver should respect the server's default value A zero value will be ignored.
        Parameters:
        timeUnit - the time unit to return the result in
        Returns:
        the maximum await execution time in the given time unit
        MongoDB documentation
        Max Time

      • maxAwaitTime

        public DBCollectionFindOptions maxAwaitTime​(long maxAwaitTime,
                                            TimeUnit timeUnit)
        Sets the maximum await execution time on the server for this operation.
        Parameters:
        maxAwaitTime - the max await time. A zero value will be ignored, and indicates that the driver should respect the server's default value
        timeUnit - the time unit, which may not be null
        Returns:
        this
        MongoDB documentation
        Max Time

      • getBatchSize

        public int getBatchSize()
        Gets the number of documents to return per batch. Default to 0, which indicates that the server chooses an appropriate batch size.
        Returns:
        the batch size
        MongoDB documentation
        Batch Size

      • batchSize

        public DBCollectionFindOptions batchSize​(int batchSize)
        Sets the number of documents to return per batch.
        Parameters:
        batchSize - the batch size
        Returns:
        this
        MongoDB documentation
        Batch Size

      • getProjection

        @Nullable
public DBObject getProjection()
        Gets a document describing the fields to return for all matching documents.
        Returns:
        the project document, which may be null
        MongoDB documentation
        Projection

      • projection

        public DBCollectionFindOptions projection​(@Nullable
                                          DBObject projection)
        Sets a document describing the fields to return for all matching documents.
        Parameters:
        projection - the project document, which may be null.
        Returns:
        this
        MongoDB documentation
        Projection

      • getSort

        @Nullable
public DBObject getSort()
        Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.
        Returns:
        a document describing the sort criteria
        MongoDB documentation
        Sort

      • isNoCursorTimeout

        public boolean isNoCursorTimeout()
        The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. If true, that timeout is disabled.
        Returns:
        true if cursor timeout is disabled

      • noCursorTimeout

        public DBCollectionFindOptions 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

      • isOplogReplay

        @Deprecated
public boolean isOplogReplay()
        Deprecated.
        oplogReplay has been deprecated in MongoDB 4.4.
        Users should not set this under normal circumstances.
        Returns:
        if oplog replay is enabled

      • oplogReplay

        @Deprecated
public DBCollectionFindOptions oplogReplay​(boolean oplogReplay)
        Deprecated.
        oplogReplay has been deprecated in MongoDB 4.4.
        Users should not set this under normal circumstances.
        Parameters:
        oplogReplay - if oplog replay is enabled
        Returns:
        this

      • isPartial

        public boolean isPartial()
        Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
        Returns:
        if partial results for sharded clusters is enabled

      • partial

        public DBCollectionFindOptions partial​(boolean partial)
        Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
        Parameters:
        partial - if partial results for sharded clusters is enabled
        Returns:
        this

      • getCursorType

        public CursorType getCursorType()
        Get the cursor type.
        Returns:
        the cursor type

      • getReadPreference

        @Nullable
public ReadPreference getReadPreference()
        Returns the readPreference
        Returns:
        the readPreference

      • getReadConcern

        @Nullable
public ReadConcern getReadConcern()
        Returns the readConcern
        Returns:
        the readConcern
        Since server release
        3.2

      • getCollation

        @Nullable
public Collation getCollation()
        Returns the collation options
        Returns:
        the collation options
        Since server release
        3.4

      • getComment

        @Nullable
public String getComment()
        Returns the comment to send with the query. The default is not to include a comment with the query.
        Returns:
        the comment
        Since:
        3.9

      • comment

        public DBCollectionFindOptions comment​(@Nullable
                                       String comment)
        Sets the comment to the query. A null value means no comment is set.
        Parameters:
        comment - the comment
        Returns:
        this
        Since:
        3.9

      • getHint

        @Nullable
public DBObject getHint()
        Returns the hint for which index to use. The default is not to set a hint.
        Returns:
        the hint
        Since:
        3.9

      • getHintString

        @Nullable
public String getHintString()
        Returns the hint string for the name of the index to use. The default is not to set a hint.
        Returns:
        the hint string
        Since:
        4.4

      • hintString

        public DBCollectionFindOptions hintString​(@Nullable
                                          String hintString)
        Sets the hint for the name of the index to use. A null value means no hint is set.
        Parameters:
        hintString - the hint string
        Returns:
        this
        Since:
        4.4

      • getMax

        @Nullable
public DBObject getMax()
        Returns the exclusive upper bound for a specific index. By default there is no max bound.
        Returns:
        the max
        Since:
        3.9

      • max

        public DBCollectionFindOptions max​(@Nullable
                                   DBObject max)
        Sets the exclusive upper bound for a specific index. A null value means no max is set.
        Parameters:
        max - the max
        Returns:
        this
        Since:
        3.9

      • getMin

        @Nullable
public DBObject getMin()
        Returns the minimum inclusive lower bound for a specific index. By default there is no min bound.
        Returns:
        the min
        Since:
        3.9

      • min

        public DBCollectionFindOptions min​(@Nullable
                                   DBObject min)
        Sets the minimum inclusive lower bound for a specific index. A null value means no max is set.
        Parameters:
        min - the min
        Returns:
        this
        Since:
        3.9

      • isReturnKey

        public boolean isReturnKey()
        Returns the returnKey. If true the find operation will return only the index keys in the resulting documents. Default value is false. If returnKey is true and the find command does not use an index, the returned documents will be empty.
        Returns:
        the returnKey
        Since:
        3.9

      • returnKey

        public DBCollectionFindOptions returnKey​(boolean returnKey)
        Sets the returnKey. If true the find operation will return only the index keys in the resulting documents.
        Parameters:
        returnKey - the returnKey
        Returns:
        this
        Since:
        3.9

      • isShowRecordId

        public boolean isShowRecordId()
        Returns the showRecordId. Determines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents. The default is false.
        Returns:
        the showRecordId
        Since:
        3.9

      • showRecordId

        public DBCollectionFindOptions showRecordId​(boolean showRecordId)
        Sets the showRecordId. Set to true to add a field $recordId to the returned documents.
        Parameters:
        showRecordId - the showRecordId
        Returns:
        this
        Since:
        3.9