1version = 0
2name = "Delete"
3documentation = "Delete performs a delete operation"
4
5[properties]
6enabled = ["write concern"]
7retryable = {mode = "once per command", type = "writes"}
8batches = "deletes"
9
10[command]
11name = "delete"
12parameter = "collection"
13
14[request.deletes]
15type = "document"
16slice = true
17constructor = true
18variadic = true
19required = true
20documentation = """
21Deletes adds documents to this operation that will be used to determine what documents to delete when this operation
22is executed. These documents should have the form {q: <query>, limit: <integer limit>, collation: <document>}. The
23collation field is optional. If limit is 0, there will be no limit on the number of documents deleted.\
24"""
25
26[request.ordered]
27type = "boolean"
28documentation = """
29Ordered sets ordered. If true, when a write fails, the operation will return the error, when
30false write failures do not stop execution of the operation.\
31"""
32
33[request.hint]
34type = "boolean"
35minWireVersionRequired = 5
36documentation = """
37Hint is a flag to indicate that the update document contains a hint. Hint is only supported by
38servers >= 4.4. Older servers >= 3.4 will report an error for using the hint option. For servers <
393.4, the driver will return an error if the hint option is used.\
40"""
41
42[response]
43name = "DeleteResult"
44
45[response.field.n]
46type = "int32"
47documentation = "Number of documents successfully deleted."
48