Package com.mongodb.client.model

Class DeleteOptions

java.lang.Object
com.mongodb.client.model.DeleteOptions
public class DeleteOptions extends Object
The options to apply when deleting documents.
Since:
3.4
MongoDB documentation
Remove documents
Delete Command

  • Constructor Details

    • DeleteOptions

      public DeleteOptions()

  • Method Details

    • getCollation

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

    • collation

      public DeleteOptions 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 server release
      3.4

    • getHint

      @Nullable public org.bson.conversions.Bson getHint()
      Gets the hint to apply.
      Returns:
      the hint, which should describe an existing index
      Since:
      4.1
      Since server release
      4.4

    • 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
      Since server release
      4.4

    • hint

      public DeleteOptions hint(@Nullable org.bson.conversions.Bson hint)
      Sets the hint to apply.
      Parameters:
      hint - a document describing the index which should be used for this operation.
      Returns:
      this
      Since:
      4.1
      Since server release
      4.4

    • hintString

      public DeleteOptions hintString(@Nullable String hint)
      Sets the hint to apply.

      Note: If hint(Bson) is set that will be used instead of any hint string.

      Parameters:
      hint - the name of the index which should be used for the operation
      Returns:
      this
      Since:
      4.1
      Since server release
      4.4

    • getComment

      @Nullable public org.bson.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 DeleteOptions 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 DeleteOptions comment(@Nullable org.bson.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 org.bson.conversions.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 DeleteOptions let(org.bson.conversions.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

    • toString

      public String toString()
      Overrides:
      toString in class Object