summaryrefslogtreecommitdiff
path: root/src/mongo/s/resharding/common_types.idl
blob: 41368c2c60a56de14df260dca5230ec11a456e84 (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
# Copyright (C) 2020-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 types used among various resharding-related IDL structs.

global:
    cpp_namespace: "mongo"

imports:
    - "mongo/db/keypattern.idl"
    - "mongo/idl/basic_types.idl"
    - "mongo/s/sharding_types.idl"

enums:
    CoordinatorState:
        description: "The current state of a resharding operation on the coordinator."
        type: string
        values:
            kUnused: "unused"
            kInitializing: "initializing"
            kPreparingToDonate: "preparing-to-donate"
            kCloning: "cloning"
            kApplying: "applying"
            kMirroring: "mirroring"
            kCommitted: "committed"
            kRenaming: "renaming"
            kDone: "done"
            kError: "error"

    DonorState:
        description: "The current state of a donor shard for a resharding operation."
        type: string
        values:
            kUnused: "unused"
            kPreparingToDonate: "preparing-to-donate"
            kDonatingInitialData: "donating-initial-data"
            kDonatingOplogEntries: "donating-oplog-entries"
            kPreparingToMirror: "preparing-to-mirror"
            kMirroring: "mirroring"
            kDropping: "dropping"
            kDone: "done"
            kError: "error"

    RecipientState:
        description: "The current state of a recipient shard for a resharding operation."
        type: string
        values:
            kUnused: "unused"
            kCreatingCollection: "creating-collection"
            kCloning: "cloning"
            kApplying: "applying"
            kSteadyState: "steady-state"
            kStrictConsistency: "strict-consistency"
            kRenaming: "renaming"
            kDone: "done"
            kError: "error"

structs:
    CommonReshardingMetadata:
        description: "Metadata shared across all node types for a resharding operation."
        generate_comparison_operators: false
        strict: true
        fields:
            _id:
                type: uuid
                description: "A unique identifier for the resharding operation."
            nss:
                type: namespacestring
                description: "The namespace of the collection being resharded."
            existingUUID:
                type: uuid
                description: "The UUID of the original collection being resharded."
            reshardingKey:
                type: KeyPattern
                description: "The index specification document to use as the new shard key."

    MinFetchTimestamp:
        description: "Not meant to be used directly. Only use internal fields."
        strict: true
        fields:
            minFetchTimestamp:
                type: timestamp
                description: "Timestamp after which a donor shard has guaranteed that oplog
                              entries contain recipient shard information."
                optional: true

    FetchTimestamp:
        description: "Not meant to be used directly. Only use internal fields."
        strict: true
        fields:
            fetchTimestamp:
                type: timestamp
                description: "Timestamp after which it is acceptable for recipient shards to
                              retrieve documents from donor shards."
                optional: true

    StrictConsistencyTimestamp:
        description: "Not meant to be used directly. Only use internal fields."
        strict: true
        fields:
            strictConsistencyTimestamp:
                type: timestamp
                description: "Timestamp after which all writes to a particular recipient shard for
                              the original resharding collection will be executed as distributed
                              transactions."
                optional: true

    ReshardingSourceId:
        description: "Identifier for a shard involved in a particular resharding operation."
        fields:
            reshardingUUID:
                type: uuid
                description: "Identifier for a resharding operation."
            shardId:
                type: shard_id
                description: "A shard identifier."