version = 0
name = "Update"
documentation = "Update performs an update operation."

[properties]
enabled = ["write concern"]
retryable = {mode = "once per command", type = "writes"}
batches = "updates"

[command]
name = "update"
parameter = "collection"

[request.updates]
type = "document"
slice = true
constructor = true
variadic = true
required = true
documentation = """
Updates specifies an array of update statements to perform when this operation is executed.
Each update document must have the following structure: {q: <query>, u: <update>, multi: <boolean>, collation: Optional<Document>, arrayFitlers: Optional<Array>, hint: Optional<string/Document>}.\
"""

[request.ordered]
type = "boolean"
documentation = """
Ordered sets ordered. If true, when a write fails, the operation will return the error, when
false write failures do not stop execution of the operation.\
"""

[request.bypassDocumentValidation]
type = "boolean"
minWireVersion = 4
documentation = """
BypassDocumentValidation allows the operation to opt-out of document level validation. Valid
for server versions >= 3.2. For servers < 3.2, this setting is ignored.\
"""

[request.hint]
type = "boolean"
minWireVersionRequired = 5
documentation = """
Hint is a flag to indicate that the update document contains a hint. Hint is only supported by
servers >= 4.2. Older servers >= 3.4 will report an error for using the hint option. For servers <
3.4, the driver will return an error if the hint option is used.\
"""

[response]
name = "UpdateResult"

[response.field.n]
type = "int32"
documentation = "Number of documents matched."

[response.field.nModified]
type = "int32"
documentation = "Number of documents modified."