summaryrefslogtreecommitdiff
path: root/src/mongo/db/s/sharded_rename_collection.idl
blob: 0d972dc6f64851099b6e30456c562d465e2182e6 (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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# Copyright (C) 2021-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.
#

# This file defines the format of documents stored in config.ddl.dropCollections on the coordinator
# shard for a drop collection operation.

global:
    cpp_namespace: "mongo"
    cpp_includes:
        - "mongo/s/catalog/type_collection.h"

imports:
    - "mongo/idl/basic_types.idl"
    - "mongo/db/s/sharding_ddl_coordinator.idl"
    - "mongo/s/request_types/sharded_ddl_commands.idl"

enums:
    RenameCollectionCoordinatorPhase:
        description: "The current state of a rename collection operation on the coordinator."
        type: string
        values:
            kUnset: "unset"
            kCheckPreconditions: "checkPreconditions"
            kFreezeMigrations: "freezeMigrations"
            kBlockCrudAndRename: "blockCRUDAndRename"
            kRenameMetadata: "renameMetadata"
            kUnblockCRUD: "unblockCRUD"
            kSetResponse: "setResponse"

    RenameCollectionParticipantPhase:
        description: "The current state of a rename collection operation on a participant."
        type: string
        values:
            kUnset: "unset"
            kBlockCRUDAndSnapshotRangeDeletions: "blockCRUDAndSnapshotRangeDeletions"
            kRenameLocalAndRestoreRangeDeletions: "renameLocalAndRestoreRangeDeletions"
            kDeleteFromRangeDeletions: "deleteFromRangeDeletions"
            kUnblockCRUD: "unblockCRUD"

commands:
    _shardsvrRenameCollectionParticipant:
        command_name: _shardsvrRenameCollectionParticipant
        cpp_name: ShardsvrRenameCollectionParticipant
        description: "Internal command sent to shard participating in a rename collection procedure"
        strict: false
        api_version: ""
        namespace: concatenate_with_db
        chained_structs:
            RenameCollectionRequest: RenameCollectionRequest
        fields:
            sourceUUID:
                type: uuid
                description: "ID of the collection getting renamed."
            targetUUID:
                type: uuid
                description: "ID of the existing collection getting dropped."
                optional: true

    _shardsvrRenameCollectionParticipantUnblock:
        command_name: _shardsvrRenameCollectionParticipantUnblock
        cpp_name: ShardsvrRenameCollectionUnblockParticipant
        description: "Parser for the _shardsvrRenameCollectionParticipantUnblock command"
        strict: false
        api_version: ""
        namespace: concatenate_with_db
        chained_structs:
            RenameCollectionRequest: RenameCollectionRequest
        fields:
            sourceUUID:
                type: uuid
                description: "ID of the collection getting renamed."

structs:
    RenameCollectionCoordinatorDocument:
        description: "Represents a rename collection operation on the coordinator shard."
        generate_comparison_operators: false
        strict: false
        chained_structs:
            ShardingDDLCoordinatorMetadata: ShardingDDLCoordinatorMetadata
            RenameCollectionRequest: RenameCollectionRequest
        fields:
            phase:
                type: RenameCollectionCoordinatorPhase
                default: kUnset
            targetIsSharded:
                description: "Indicates whether the target collection (to override) is sharded or not."
                type: bool
                default: false
            optShardedCollInfo:
                description: "CollectionType of the collection currently being renamed (if sharded)."
                type: CollectionType
                optional: true
            sourceUUID:
                type: uuid
                description: "ID of the collection getting renamed."
                optional: true
            targetUUID:
                type: uuid
                description: "ID of the existing collection getting dropped."
                optional: true
            allowEncryptedCollectionRename:
                description: "Encrypted Collection renames are usually disallowed to minimize user error.
                              C2C needs to do the renames to replicate create collection."
                type: bool
                optional: true

    RenameCollectionParticipantDocument:
        description: "Represents a rename collection operation on a participant shard."
        generate_comparison_operators: false
        strict: false
        chained_structs:
            RenameCollectionRequest: RenameCollectionRequest
        fields:
            _id:
                type: namespacestring
                cpp_name: fromNss
            phase:
                type: RenameCollectionParticipantPhase
                default: kUnset
            forwardableOpMetadata:
                type: ForwardableOperationMetadata
            sourceUUID:
                type: uuid
                description: "ID of the collection getting renamed."
            targetUUID:
                type: uuid
                description: "ID of the existing collection getting dropped."
                optional: true