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
|
/**
* Copyright (C) 2022-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.
*/
#pragma once
#include "mongo/db/operation_context.h"
#include "mongo/util/uuid.h"
namespace mongo::global_index {
// The container (collection) fields of an index key. The document key is stored as a BSON object.
// The index key is stored in its KeyString representation, hence the need to store TypeBits.
constexpr auto kContainerIndexDocKeyFieldName = "_id"_sd;
constexpr auto kContainerIndexKeyFieldName = "ik"_sd;
constexpr auto kContainerIndexKeyTypeBitsFieldName = "tb"_sd;
// The oplog entry fields representing an insert or delete of an index key. The index key and the
// document key are BSON objects.
constexpr auto kOplogEntryDocKeyFieldName = "dk"_sd;
constexpr auto kOplogEntryIndexKeyFieldName = kContainerIndexKeyFieldName;
/**
* Creates the internal collection implements the global index container with the given UUID on the
* shard. Replicates as a 'createGlobalIndex' command. This container-backing collection:
* - is clustered by _id. The _id field stores the cluster-unique document key of the index entry;
* - has a secondary unique index on the 'ik' field which stores a binary-comparable
* representation of the index key value.
*/
void createContainer(OperationContext* opCtx, const UUID& indexUUID);
/**
* Drops the internal collection acting as the global index container with the given UUID on the
* shard. Replicates as a 'dropGlobalIndex' command.
*/
void dropContainer(OperationContext* opCtx, const UUID& indexUUID);
/**
* Inserts a key into the global index container identified by UUID. Replicates as an 'xi' command.
* - 'key' is the unique index key.
* - 'docKey' is the document key of the index entry.
*/
void insertKey(OperationContext* opCtx,
const UUID& indexUUID,
const BSONObj& key,
const BSONObj& docKey);
/**
* Variant of the above where the lock for the global index container is already granted. Unlike
* the above, this variant requires the call to be wrapped inside a writeConflictRetry.
*/
void insertKey(OperationContext* opCtx,
const CollectionPtr& container,
const BSONObj& key,
const BSONObj& docKey);
/**
* Deletes a key from the global index container identified by UUID. Replicates as an 'xd' command.
* - 'key' is the unique index key.
* - 'docKey' is the document key of the index entry.
*/
void deleteKey(OperationContext* opCtx,
const UUID& indexUUID,
const BSONObj& key,
const BSONObj& docKey);
/**
* Variant of the above where the lock for the global index container is already granted. Unlike
* the above, this variant requires the call to be wrapped inside a writeConflictRetry.
*/
void deleteKey(OperationContext* opCtx,
const CollectionPtr& container,
const BSONObj& key,
const BSONObj& docKey);
} // namespace mongo::global_index
|
