Package dev.morphia.query

Class FindOptions

java.lang.Object
dev.morphia.query.FindOptions
All Implemented Interfaces:
dev.morphia.internal.CollectionConfigurable<FindOptions>, dev.morphia.internal.CollectionConfiguration, dev.morphia.internal.ReadConfigurable<FindOptions>
public final class FindOptions extends Object implements dev.morphia.internal.ReadConfigurable<FindOptions>, dev.morphia.internal.CollectionConfigurable<FindOptions>
The options to apply to a find operation (also commonly referred to as a query).
Since:
1.3

  • Constructor Details

    • FindOptions

      public FindOptions()

  • Method Details

    • allowDiskUse

      public FindOptions allowDiskUse(Boolean allowDiskUse)
      Enables writing to temporary files on the server. When set to true, the server can write temporary data to disk while executing the find operation.
      Parameters:
      allowDiskUse - true to allow disk use
      Returns:
      this
      Since:
      2.2

    • batchSize

      public FindOptions batchSize(int batchSize)
      Sets the batch size
      Parameters:
      batchSize - the size
      Returns:
      this

    • collation

      public FindOptions collation(Collation collation)
      Sets the collation to use
      Parameters:
      collation - the collation
      Returns:
      this

    • collection

      public FindOptions collection(String collection)
      Sets the alternate collection to use for the operation.
      Specified by:
      collection in interface dev.morphia.internal.CollectionConfigurable<FindOptions>
      Parameters:
      collection - the name of the collection to use
      Returns:
      this

    • comment

      public FindOptions comment(String comment)
      Sets the comment to log with the query
      Parameters:
      comment - the comment
      Returns:
      this

    • comment

      public FindOptions comment(BsonValue comment)
      Sets the comment to log with the query
      Parameters:
      comment - the comment
      Returns:
      this

    • cursorType

      public FindOptions cursorType(CursorType cursorType)
      Sets the cursor type
      Parameters:
      cursorType - the type
      Returns:
      this

    • hint

      public FindOptions hint(Document hint)
      Sets the index hint
      Parameters:
      hint - the hint
      Returns:
      this

    • hint

      public FindOptions hint(String hint)
      Defines the index hint value
      Parameters:
      hint - the hint
      Returns:
      this

    • hintString

      public FindOptions hintString(String hint)
      Defines the index hint value
      Parameters:
      hint - the hint
      Returns:
      this

    • let

      public FindOptions let(Document variables)
      Add top-level variables to the operation. A null value means no variables are set.

      Allows for improved command readability by separating the variables from the query text.

      Parameters:
      variables - for find operation or null
      Returns:
      this
      Since:
      2.3

    • limit

      public FindOptions limit(int limit)
      Sets the limit
      Parameters:
      limit - the limit
      Returns:
      this

    • logQuery

      public FindOptions logQuery()
      This is an experimental method. It's implementation and presence are subject to change.
      Returns:
      this

    • max

      public FindOptions max(Document max)
      Sets the max index value
      Parameters:
      max - the max
      Returns:
      this

    • maxAwaitTime

      public FindOptions maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit)
      Sets the max await time
      Parameters:
      maxAwaitTime - the max
      timeUnit - the unit
      Returns:
      this

    • maxTime

      public FindOptions maxTime(long maxTime, TimeUnit timeUnit)
      Sets the max time
      Parameters:
      maxTime - the max
      timeUnit - the unit
      Returns:
      this

    • min

      public FindOptions min(Document min)
      Sets the min index value
      Parameters:
      min - the min
      Returns:
      this

    • noCursorTimeout

      public FindOptions noCursorTimeout(boolean noCursorTimeout)
      Sets whether to disable cursor time out
      Parameters:
      noCursorTimeout - true if the time should be disabled
      Returns:
      this

    • oplogReplay

      @Deprecated(since="3.0") public FindOptions oplogReplay(boolean oplogReplay)
      Deprecated.
      removed from the driver
      Users should not set this under normal circumstances.
      Parameters:
      oplogReplay - if oplog replay is enabled
      Returns:
      this

    • partial

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

    • readConcern

      public FindOptions readConcern(ReadConcern readConcern)
      Sets the read concern to apply
      Specified by:
      readConcern in interface dev.morphia.internal.ReadConfigurable<FindOptions>
      Parameters:
      readConcern - the read concern
      Returns:
      this

    • readPreference

      public FindOptions readPreference(ReadPreference readPreference)
      Sets the read preference to apply
      Specified by:
      readPreference in interface dev.morphia.internal.ReadConfigurable<FindOptions>
      Parameters:
      readPreference - the read preference
      Returns:
      this

    • returnKey

      public FindOptions returnKey(boolean returnKey)
      Sets if only the key value should be returned
      Parameters:
      returnKey - true if only the key should be returned
      Returns:
      this

    • showRecordId

      public FindOptions showRecordId(boolean showRecordId)
      Sets if the record ID should be returned
      Parameters:
      showRecordId - true if the record id should be returned
      Returns:
      this

    • skip

      public FindOptions skip(int skip)
      Sets how many documents to skip
      Parameters:
      skip - the count
      Returns:
      this

    • sort

      public FindOptions sort(Meta meta)
      Sets to the sort to use
      Parameters:
      meta - the meta data to sort by
      Returns:
      this
      Since:
      2.0

    • sort

      public FindOptions sort(Meta meta, Sort... sorts)
      Sets to the sort to use
      Parameters:
      meta - the meta data to sort by
      sorts - additional sort elements
      Returns:
      this
      Since:
      2.4

    • sort

      public FindOptions sort(Document sort)
      Sets to the sort to use
      Parameters:
      sort - the sort document
      Returns:
      this

    • sort

      public FindOptions sort(Sort... sorts)
      Sets to the sort to use
      Parameters:
      sorts - the sorts to apply
      Returns:
      this