Package com.mongodb.client.model

Class UpdateOptions

java.lang.Object
com.mongodb.client.model.UpdateOptions
public class UpdateOptions extends Object
The options to apply when updating documents.
Since:
3.0
MongoDB documentation
Updates
Update Operators
Update Command

  • Constructor Details

    • UpdateOptions

      public UpdateOptions()

  • Method Details

    • isUpsert

      public boolean isUpsert()
      Returns true if a new document should be inserted if there are no matches to the query filter. The default is false.
      Returns:
      true if a new document should be inserted if there are no matches to the query filter

    • upsert

      public UpdateOptions upsert(boolean upsert)
      Set to true if a new document should be inserted if there are no matches to the query filter.
      Parameters:
      upsert - true if a new document should be inserted if there are no matches to the query filter
      Returns:
      this

    • getBypassDocumentValidation

      @Nullable public Boolean getBypassDocumentValidation()
      Gets the bypass document level validation flag
      Returns:
      the bypass document level validation flag
      Since:
      3.2
      Since server release
      3.2

    • bypassDocumentValidation

      public UpdateOptions bypassDocumentValidation(@Nullable Boolean bypassDocumentValidation)
      Sets the bypass document level validation flag.

      For bulk operations use: BulkWriteOptions.bypassDocumentValidation(Boolean)

      Parameters:
      bypassDocumentValidation - If true, allows the write to opt-out of document level validation.
      Returns:
      this
      Since:
      3.2
      Since server release
      3.2

    • getCollation

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

    • collation

      public UpdateOptions 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:
      3.4
      Since server release
      3.4

    • arrayFilters

      public UpdateOptions arrayFilters(@Nullable List<? extends Bson> arrayFilters)
      Sets the array filters option
      Parameters:
      arrayFilters - the array filters, which may be null
      Returns:
      this
      Since:
      3.6
      Since server release
      3.6

    • getArrayFilters

      @Nullable public List<? extends Bson> getArrayFilters()
      Returns the array filters option
      Returns:
      the array filters, which may be null
      Since:
      3.6
      Since server release
      3.6

    • getHint

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

    • hint

      public UpdateOptions hint(@Nullable Bson hint)
      Sets the hint for which index to use. A null value means no hint is set.
      Parameters:
      hint - the hint
      Returns:
      this
      Since:
      4.1

    • getHintString

      @Nullable public String getHintString()
      Gets the hint string to apply.
      Returns:
      the hint string, which should be the name of an existing index
      Since:
      4.1

    • hintString

      public UpdateOptions hintString(@Nullable String hint)
      Sets the hint to apply.
      Parameters:
      hint - the name of the index which should be used for the operation
      Returns:
      this
      Since:
      4.1

    • getComment

      @Nullable public BsonValue getComment()
      Returns:
      the comment for this operation. A null value means no comment is set.
      Since:
      4.6
      Since server release
      4.4

    • comment

      public UpdateOptions comment(@Nullable String comment)
      Sets the comment for this operation. A null value means no comment is set.

      For bulk operations use: BulkWriteOptions.comment(String)

      Parameters:
      comment - the comment
      Returns:
      this
      Since:
      4.6
      Since server release
      4.4

    • comment

      public UpdateOptions comment(@Nullable BsonValue comment)
      Sets the comment for this operation. A null value means no comment is set.

      For bulk operations use: BulkWriteOptions.comment(BsonValue)

      Parameters:
      comment - the comment
      Returns:
      this
      Since:
      4.6
      Since server release
      4.4

    • getLet

      @Nullable public Bson getLet()
      Add top-level variables to the operation

      The value of let will be passed to all update and delete, but not insert, commands.

      Returns:
      the top level variables if set or null.
      Since:
      4.6
      Since server release
      5.0

    • let

      public UpdateOptions let(Bson variables)
      Add top-level variables for the operation

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

      For bulk operations use: BulkWriteOptions.let(Bson)

      Parameters:
      variables - for the operation or null
      Returns:
      this
      Since:
      4.6
      Since server release
      5.0

    • getSort

      @Nullable public Bson getSort()
      Gets the sort criteria to apply to the operation.

      The sort criteria determines which document the operation updates if the query matches multiple documents. The first document matched by the sort criteria will be updated. The default is null, which means no specific sort criteria is applied.

      Returns:
      a document describing the sort criteria, or null if no sort is specified.
      Since:
      5.3
      See Also:
      MongoDB documentation
      Sort
      Since server release
      8.0

    • sort

      public UpdateOptions 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 updates if the query matches multiple documents. The first document matched by the specified sort criteria will be updated.

      Parameters:
      sort - the sort criteria, which may be null.
      Returns:
      this
      Since:
      5.3
      MongoDB documentation
      Sort
      Since server release
      8.0

    • toString

      public String toString()
      Overrides:
      toString in class Object