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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
# Copyright (C) 2019-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.
#
# ShardCollectionType type
#
# This type represents the layout and contents of documents contained in the shard server's
# config.collections collection. All manipulation of documents coming from that collection should
# be done with this class.
#
# Expected shard server config.collections collection format:
# {
# "_id" : "foo.bar",
# "uuid" : UUID, // optional in 3.6
# "epoch" : ObjectId("58b6fd76132358839e409e47"), // will remove when UUID becomes available
# "key" : {
# "_id" : 1
# },
# "defaultCollation" : {
# "locale" : "fr_CA"
# },
# "unique" : false,
# "refreshing" : true, // optional
# "lastRefreshedCollectionVersion" : Timestamp(1, 0), // optional
# "enterCriticalSectionCounter" : 4 // optional
# "reshardingFields": { // optional
# "uuid" : UUID,
# "state" : CoordinatorState<kInitialized>,
# // Only populated if the coordinator has encountered an error.
# "abortReason": BSONObj
# // Only populated if this collection is the original sharded collection.
# "donorFields" : {
# "reshardingKey" : {
# "_notTheID" : 1
# }
# },
# // Only populated if:
# // a) This collection is the temporary resharding collection, or
# // b) This is the original collection and the coordinator has
# // chosen to commit
# "recipientFields" : {
# "fetchTimestamp" : Timestamp(3, 4),
# "originalNamespace" : "foo.bar",
# }
# }
# }
#
global:
cpp_namespace: "mongo"
imports:
- "mongo/idl/basic_types.idl"
- "mongo/db/keypattern.idl"
- "mongo/s/chunk_version.idl"
- "mongo/s/resharding/type_collection_fields.idl"
- "mongo/s/type_collection_timeseries_fields.idl"
structs:
ShardCollectionTypeBase:
description: "Represents the layout and contents of documents contained in the shard
server's config.cache.collections collection."
strict: false
fields:
_id:
cpp_name: nss
type: namespacestring
description: "The full namespace (with the database prefix)."
optional: false
epoch:
type: objectid
description: "Uniquely identifies this instance of the collection, in case of
drop/create or shard key refine."
optional: false
timestamp:
type: timestamp
description: "Uniquely identifies this incarnation of the collection. Only changes
in case of drop and create, or shard key refine.
This field will store the ClusterTime of the Config Server when the
collection was created or it's shard key last refined. Because
timestamps are comparable, we are able to define a total order in time
in the collection. This field will replace Epoch, which are not
comparable.
It is optional for parsing purposes, because in versions of MongoDB
prior to 5.0, this value wasn't being written."
optional: true
uuid:
type: uuid
description: "The UUID that will be used to create the local collection on each of
the shards which have chunks."
optional: false
key:
cpp_name: keyPattern
type: KeyPattern
description: "Sharding key. If collection is dropped, this is no longer required."
optional: false
defaultCollation:
type: object_owned
description: "Optional collection default collation. If missing or set to the empty
BSON, implies simple collation."
default: BSONObj()
unique:
type: bool
description: "Uniqueness of the sharding key."
optional: false
refreshing:
type: bool
description: "Set by primaries and used by shard secondaries to safely refresh chunk
metadata. Indicates whether the chunks collection is current being
updated, which means read results won't provide a complete view of the
chunk metadata."
optional: true
lastRefreshedCollectionVersion:
type: ChunkVersionLegacy
description: "Set by primaries and used by shard secondaries to safely refresh chunk
metadata. Indicates the collection version of the last complete chunk
metadata refresh, and is used to indicate if a refresh occurred if the
value is different than when the caller last checked -- because
'refreshing' will be false both before and after a refresh occurs."
optional: true
enterCriticalSectionCounter:
type: int
description: "Currently just an OpObserver signal, thus otherwise ignored."
optional: true
reshardingFields:
description: "Resharding-related fields. Only set when this collection is either the
original collection undergoing a resharding operation or this
collection is the temporary resharding collection."
type: TypeCollectionReshardingFields
optional: true
allowMigrations:
cpp_name: pre50CompatibleAllowMigrations
type: bool
description: "Whether this collection allows chunks to move. It is required by
almost all DDL operations in order to guarantee that the set of
shards, which comprise a collection will not change.
If the flag is not present it defaults to true.
It must be optional and not present when running in FCV 4.4, because
binaries prior to 5.0 use strict parsing and will fail."
optional: true
timeseriesFields:
type: TypeCollectionTimeseriesFields
description: "Time-series collection fields. Only set when this is a time-series
buckets collection."
optional: true
|
