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) 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.
#
global:
cpp_namespace: "mongo"
cpp_includes:
- "mongo/client/read_preference.h"
- "mongo/db/repl/tenant_migration_util.h"
- "mongo/db/repl/optime.h"
imports:
- "mongo/client/read_preference_setting.idl"
- "mongo/db/repl/tenant_migration_pem_payload.idl"
- "mongo/db/serverless/serverless_types.idl"
- "mongo/idl/basic_types.idl"
- "mongo/s/sharding_types.idl"
- "mongo/db/repl/replication_types.idl"
- "mongo/util/net/hostandport.idl"
structs:
recipientSyncDataResponse:
description: "Response for the 'recipientSyncData' command"
strict: false
fields:
majorityAppliedDonorOpTime:
type: optime
description: "Majority applied donor optime by the recipient"
MigrationRecipientCommonData:
description: "Command data for tenant migration recipient commands."
strict: true
fields:
migrationId:
description: "Unique identifier for the tenant migration."
type: uuid
donorConnectionString:
description: >-
The URI string that the recipient will utilize to create a connection with the
donor.
type: string
validator:
callback: "tenant_migration_util::validateConnectionString"
tenantId:
description: >-
The prefix from which the migrating database will be matched. The prefixes 'admin',
'local', 'config', the empty string, are not allowed.
type: string
default: '""'
validator:
callback: "tenant_migration_util::validateDatabasePrefix"
readPreference:
description: >-
The read preference settings that the donor will pass on to the recipient.
type: readPreference
recipientCertificateForDonor:
description: >-
The SSL certificate and private key that the recipient should use to authenticate to the
donor.
type: TenantMigrationPEMPayload
# TODO (SERVER-54085): Remove server parameter tenantMigrationDisableX509Auth.
optional: true
protocol:
description: "Which migration protocol to use, default 'multitenant migrations'."
type: MigrationProtocol
optional: true
validator:
callback: "tenant_migration_util::validateProtocolFCVCompatibility"
commands:
recipientSyncData:
description: "Parser for the 'recipientSyncData' command."
command_name: recipientSyncData
strict: true
namespace: ignored
api_version: ""
inline_chained_structs: true
chained_structs:
MigrationRecipientCommonData: MigrationRecipientCommonData
fields:
returnAfterReachingDonorTimestamp:
description: >-
If provided, the recipient should return after syncing up to this donor timestamp.
Otherwise, the recipient will return once its copy of the data is consistent.
type: timestamp
optional: true
validator:
callback: "tenant_migration_util::validateTimestampNotNull"
startMigrationDonorTimestamp:
type: timestamp
description: >-
Recipient must not start cloning/fetching oplog entries from the donor until this
timestamp is majority committed.
validator:
callback: "tenant_migration_util::validateTimestampNotNull"
recipientVoteImportedFiles:
command_name: recipientVoteImportedFiles
cpp_name: RecipientVoteImportedFiles
description: "An internal mongod command to coordinate recipient steps of a multitenant
migration."
strict: true
namespace: ignored
api_version: ""
reply_type: OkReply
fields:
migrationId:
description: "Unique identifier for the tenant migration."
type: uuid
from:
type: HostAndPort
description: "Replica set member identification."
success:
type: safeBool
description: "Whether the calling node succeeded at importing all files."
reason:
type: string
optional: true
description: "Optional failure reason string."
recipientForgetMigration:
description: "Parser for the 'recipientForgetMigration' command."
command_name: recipientForgetMigration
strict: true
namespace: ignored
api_version: ""
inline_chained_structs: true
chained_structs:
MigrationRecipientCommonData: MigrationRecipientCommonData
|
