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
|
# 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/util/uuid.h"
imports:
- "mongo/db/basic_types.idl"
- "mongo/db/record_id.idl"
- "mongo/db/sorter/sorter.idl"
enums:
IndexBuildPhase:
description: "Phase of a hybrid index build"
type: string
values:
kInitialized: "initialized"
kCollectionScan: "collection scan"
kBulkLoad: "bulk load"
kDrainWrites: "drain writes"
structs:
MultikeyPath:
description: "One set of multikey components for the multikey paths."
strict: true
fields:
multikeyComponents:
description: "The path-level components of the multikey paths."
type: array<int>
IndexStateInfo:
description: "The state of the index build needed to resume it."
strict: true
fields:
sideWritesTable:
description: "The name of the ident associated with the side writes table for this
index build"
type: string
duplicateKeyTrackerTable:
description: "The name of the ident associated with the duplicate key tracker table
for this index build"
type: string
optional: true
skippedRecordTrackerTable:
description: "The name of the ident associated with the skipped record tracker table
for this index build"
type: string
optional: true
fileName:
description: "The name of the file that sorted data is written to"
type: string
optional: true
numKeys:
description: "The number of keys that were that were already sorted and spilled to disk"
type: long
optional: true
ranges:
description: "All ranges of data that were already sorted and spilled to disk"
type: array<SorterRange>
optional: true
spec:
description: "The index specification"
type: object_owned
isMultikey:
description: "Whether the index was already marked as multikey."
type: bool
multikeyPaths:
description: "The multikey paths for the index, if supported."
type: array<MultikeyPath>
ResumeIndexInfo:
description: "Information needed to resume index builds"
strict: true
fields:
_id:
description: "A UUID that uniquely identifies the index build across replica set
members."
cpp_name: buildUUID
type: uuid
phase:
description: "The phase the index build was in when the node shut down"
type: IndexBuildPhase
collectionUUID:
description: "A UUID that uniquely identifies which collection the index is being
built on"
type: uuid
collectionScanPosition:
description: "The last record id inserted into the sorter before shutdown"
type: RecordId
optional: true
indexes:
description: "The information needed to resume each specific index in this build"
type: array<IndexStateInfo>
|