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
|
/**
* Copyright (C) 2023-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/clientcursor.h"
#include "mongo/db/metadata_consistency_types_gen.h"
#include "mongo/db/query/plan_executor_factory.h"
#include "mongo/s/catalog/type_chunk.h"
#include "mongo/s/catalog/type_collection.h"
#include "mongo/s/catalog/type_tags.h"
#include "mongo/s/request_types/sharded_ddl_commands_gen.h"
namespace mongo {
namespace metadata_consistency_util {
/**
* Creates a MetadataInconsistencyItem object from the given parameters.
*/
template <typename MetadataDetailsType>
MetadataInconsistencyItem makeInconsistency(const MetadataInconsistencyTypeEnum& type,
const MetadataDetailsType& details) {
return {type,
MetadataInconsistencyDescription_serializer(
static_cast<MetadataInconsistencyDescriptionEnum>(type))
.toString(),
details.toBSON()};
}
/**
* Returns the command level for the given namespace.
*/
MetadataConsistencyCommandLevelEnum getCommandLevel(const NamespaceString& nss);
/**
* Creates a queued data plan executor for the given list of inconsistencies
*/
std::unique_ptr<PlanExecutor, PlanExecutor::Deleter> makeQueuedPlanExecutor(
OperationContext* opCtx,
std::vector<MetadataInconsistencyItem>&& inconsistencies,
const NamespaceString& nss);
/**
* Construct a initial cursor reply from the given client cursor.
* The returned reply is populated with the first batch result.
*/
CursorInitialReply createInitialCursorReplyMongod(OperationContext* opCtx,
ClientCursorParams&& cursorParams,
long long batchSize);
/**
* Returns a list of inconsistencies between the collections' metadata on the shard and the
* collections' metadata in the config server.
*
* The list of inconsistencies is returned as a vector of MetadataInconsistencies objects. If
* there is no inconsistency, it is returned an empty vector.
*/
std::vector<MetadataInconsistencyItem> checkCollectionMetadataInconsistencies(
OperationContext* opCtx,
const ShardId& shardId,
const ShardId& primaryShardId,
const std::vector<CollectionType>& catalogClientCollections,
const std::vector<CollectionPtr>& localCollections);
/**
* Check different types of inconsistencies from a given set of chunks owned by a collection.
*
* The list of inconsistencies is returned as a vector of MetadataInconsistencies objects. If
* there is no inconsistency, it is returned an empty vector.
*/
std::vector<MetadataInconsistencyItem> checkChunksInconsistencies(
OperationContext* opCtx,
const CollectionType& collection,
const std::vector<ChunkType>& chunks);
/**
* Check different types of inconsistencies from a given set of zones owned by a collection.
*
* The list of inconsistencies is returned as a vector of MetadataInconsistencies objects. If
* there is no inconsistency, it is returned an empty vector.
*/
std::vector<MetadataInconsistencyItem> checkZonesInconsistencies(
OperationContext* opCtx, const CollectionType& collection, const std::vector<TagsType>& zones);
} // namespace metadata_consistency_util
} // namespace mongo
|