Package com.mongodb.client.model.bulk

Interface ClientReplaceOneOptions

@Sealed public interface ClientReplaceOneOptions
The options to apply when replacing a document.
Since:
5.3

  • Method Details

    • clientReplaceOneOptions

      static ClientReplaceOneOptions clientReplaceOneOptions()
      Creates the default options.
      Returns:
      The default options.

    • collation

      ClientReplaceOneOptions collation(@Nullable Collation collation)
      Sets the collation.
      Parameters:
      collation - The collation. null represents the server default.
      Returns:
      this.

    • hint

      ClientReplaceOneOptions hint(@Nullable Bson hint)
      Sets the index specification, null-ifies hint string.
      Parameters:
      hint - The index specification. null represents the server default.
      Returns:
      this.

    • hintString

      ClientReplaceOneOptions hintString(@Nullable String hintString)
      Sets the index name, null-ifies hint.
      Parameters:
      hintString - The index name. null represents the server default.
      Returns:
      this.

    • upsert

      ClientReplaceOneOptions upsert(@Nullable Boolean upsert)
      Enables or disables creation of a document if no documents match the filter.
      Parameters:
      upsert - The upsert flag. null represents the server default.
      Returns:
      this.

    • sort

      ClientReplaceOneOptions sort(@Nullable Bson sort)
      Sets the sort criteria to apply to the operation. A null value means no sort criteria is set.

      The sort criteria determines which document the operation replaces if the query matches multiple documents. The first document matched by the specified sort criteria will be replaced.

      Parameters:
      sort - The sort criteria. null represents the server default.
      Returns:
      this
      Since:
      5.4
      MongoDB documentation
      Sort
      Since server release
      8.0