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
|
# 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"
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_common_types.idl"
structs:
CollectionTypeBase:
description: "Represents the layout and contents of documents contained in the config
server's config.collections collection."
strict: false
fields:
_id:
cpp_name: nss
type: namespacestring
description: "The full namespace (with the database prefix)."
optional: false
lastmodEpoch:
cpp_name: pre22CompatibleEpoch
type: objectid
description: "Uniquely identifies this incarnation of the collection. Only changes
in case of drop and create, or shard key refine.
It is optional for parsing purposes, because in versions of MongoDB
prior to 2.2, this value wasn't being written. In such cases, it will
default to an all-zero OID."
optional: true
lastmod:
cpp_name: updatedAt
type: date
description: "Contains the time of when the collection was either created."
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."
uuid:
cpp_name: pre50CompatibleUuid
type: uuid
description: "The UUID that will be used to create the local collection on each of
the shards which have chunks.
It is optional for parsing purposes, because in versions of MongoDB
prior to 5.0, this value would be missing for entries where 'dropped'
is set to true, because dropped collections' entries were being
written as dropped with certain fields missing instead of deleted."
optional: true
key:
cpp_name: pre50CompatibleKeyPattern
type: KeyPattern
description: "The shard key pattern for the collection.
It is optional for parsing purposes, because in versions of MongoDB
prior to 5.0, this value would be missing for entries where 'dropped'
is set to true, because dropped collections' entries were being
written as dropped with certain fields missing instead of deleted."
optional: true
defaultCollation:
cpp_name: pre50CompatibleDefaultCollation
type: object_owned
description: "Optional collection default collation. If missing or set to the empty
BSON, implies simple collation.
It is optional for serialisation purposes, because in versions of
MongoDB prior to 5.0, this value must be missing for the default
(empty BSON) collation."
optional: true
unique:
type: bool
description: "Uniqueness of the sharding key."
default: false
maxChunkSizeBytes:
type: safeInt64
description: "Max chunk size in bytes."
optional: true
noAutoSplit:
type: bool
description: "Specifies whether the auto-splitter should be running or not for this collection."
default: false
noBalance:
type: bool
description: "Consulted by the Balancer only and indicates whether this collection
should be considered for balancing or not."
default: false
reshardingFields:
type: TypeCollectionReshardingFields
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."
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 is optional for serialisation purposes, because in versions of
MongoDB prior to 5.0, this value would be missing."
optional: true
timeseriesFields:
type: TypeCollectionTimeseriesFields
description: "Time-series collection fields. Only set when this is a time-series
buckets collection."
optional: true
supportingLongName:
type: SupportingLongNameStatus
description: "When set, the maximum name length of sharded collections is aligned
with that of non-sharded collections, which is 255 bytes from MongoDB
version 4.4 and 120 bytes with earlier versions. Otherwise, the limit
for shared collections is reduced by 20 bytes, regardless of the
version of MongoDB.
With version 5.1, the support for long names is implicitly enabled on
all collections by upgrading the feature compatibility version (FCV).
With FCV lower than 5.1 but using binaries supporting the feature,
the support for long names is disabled by default and requires an
explicit enabling on the specific collection. Otherwise, the feature
cannot be enabled in any way as unsupported by the binaries.
From a technical perspective, enabling the feature, the
system.cache.chunks.<NS> collections are created or renamed using the
sharded collection UUID, instead of the namespace, as part of their
names, i.e., system.cache.chunks.<UUID>."
optional: true
|
