Package com.mongodb.client.model
Class UpdateOptions
java.lang.Object
com.mongodb.client.model.UpdateOptions
The options to apply when updating documents.
- Since:
- 3.0
- MongoDB documentation
- Updates
- Update Operators
- Update Command
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionarrayFilters
(List<? extends Bson> arrayFilters) Sets the array filters optionbypassDocumentValidation
(Boolean bypassDocumentValidation) Sets the bypass document level validation flag.Sets the collation optionsSets the comment for this operation.Sets the comment for this operation.Returns the array filters optionGets the bypass document level validation flagReturns the collation optionsgetHint()
Returns the hint for which index to use.Gets the hint string to apply.getLet()
Add top-level variables to the operationSets the hint for which index to use.hintString
(String hint) Sets the hint to apply.boolean
isUpsert()
Returns true if a new document should be inserted if there are no matches to the query filter.Add top-level variables for the operationtoString()
upsert
(boolean upsert) Set to true if a new document should be inserted if there are no matches to the query filter.
-
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
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
Gets the bypass document level validation flag- Returns:
- the bypass document level validation flag
- Since:
- 3.2
- Since server release
- 3.2
-
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
Returns the collation options- Returns:
- the collation options
- Since:
- 3.4
- Since server release
- 3.4
-
collation
Sets the collation optionsA null value represents the server default.
- Parameters:
collation
- the collation options to use- Returns:
- this
- Since:
- 3.4
- Since server release
- 3.4
-
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
Returns the array filters option- Returns:
- the array filters, which may be null
- Since:
- 3.6
- Since server release
- 3.6
-
getHint
Returns the hint for which index to use. The default is not to set a hint.- Returns:
- the hint
- Since:
- 4.1
-
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
Gets the hint string to apply.- Returns:
- the hint string, which should be the name of an existing index
- Since:
- 4.1
-
hintString
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
- Returns:
- the comment for this operation. A null value means no comment is set.
- Since:
- 4.6
- Since server release
- 4.4
-
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
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
Add top-level variables to the operationThe 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
Add top-level variables for the operationAllows 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
-