summaryrefslogtreecommitdiff
path: root/src/mongo/db/repl/apply_ops.idl
blob: 901c604078137d2b95fab6054172c1de0a5d6f9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

# applyOps IDL File

global:
    cpp_namespace: "mongo::repl"

imports:
    - "mongo/db/basic_types.idl"

structs:
    ApplyOpsCommandInfoBase:
        description: A document that represents an applyOps command.
        immutable: true
        strict: false
        fields:
            applyOps:
                cpp_name: operations
                type: array<object>
                description: "The operations to apply"

            alwaysUpsert:
                cpp_name: alwaysUpsert
                type: bool
                default: true
                description: "Affects update operations. Set 'alwaysUpsert' to false in the command
                              object to never insert a new document if no document matches the query
                              criteria in an update operation."
            preCondition:
                cpp_name: preCondition
                type: array<object>
                optional: true
                description: "No longer supported, but kept here to improve the error message
                              returned to the client. In older versions, applyOps used to support
                              checking the documents of existing collections before proceeding to
                              execute the given operations."

            prepare:
                type: bool
                optional: true
                description: "Specifies that this operation should be put into a 'prepare' state"

            partialTxn:
                type: bool
                optional: true
                description: "Specifies that this applyOps command is part of a multi-statement
                              transaction that has not yet been committed or prepared."
            count:
                type: safeInt64
                optional: true
                description: "The number of operations contained in this multi-oplog-entry
                              transaction."