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
173
174
175
176
177
178
179
180
181
182
183
|
/**
* Copyright (C) 2018-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 <map>
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/bsonobj_comparator_interface.h"
#include "mongo/bson/simple_bsonobj_comparator.h"
#include "mongo/db/namespace_string.h"
#include "mongo/s/catalog_cache.h"
#include "mongo/s/ns_targeter.h"
namespace mongo {
struct TargeterStats {
// Map of chunk shard minKey -> approximate delta. This is used for deciding whether a chunk
// might need splitting or not.
BSONObjIndexedMap<int> chunkSizeDelta{
SimpleBSONObjComparator::kInstance.makeBSONObjIndexedMap<int>()};
};
/**
* NSTargeter based on a ChunkManager implementation. Wraps all exception codepaths and returns
* NamespaceNotFound status on applicable failures.
*
* Must be initialized before use, and initialization may fail.
*/
class ChunkManagerTargeter : public NSTargeter {
public:
enum class UpdateType { kReplacement, kOpStyle, kUnknown };
/**
* If 'targetEpoch' is not boost::none, throws a 'StaleEpoch' exception if the collection given
* by 'nss' is ever found to not have the target epoch.
*/
ChunkManagerTargeter(const NamespaceString& nss,
boost::optional<OID> targetEpoch = boost::none);
/**
* Initializes the ChunkManagerTargeter with the latest targeting information for the
* namespace. May need to block and load information from a remote config server.
*
* Throws a 'StaleEpoch' exception if the collection targeted has an epoch which does not match
* '_targetEpoch'
* Returns !OK if the information could not be initialized.
*/
Status init(OperationContext* opCtx);
const NamespaceString& getNS() const override;
// Returns ShardKeyNotFound if document does not have a full shard key.
StatusWith<ShardEndpoint> targetInsert(OperationContext* opCtx,
const BSONObj& doc) const override;
// Returns ShardKeyNotFound if the update can't be targeted without a shard key.
StatusWith<std::vector<ShardEndpoint>> targetUpdate(
OperationContext* opCtx, const write_ops::UpdateOpEntry& updateDoc) const override;
// Returns ShardKeyNotFound if the delete can't be targeted without a shard key.
StatusWith<std::vector<ShardEndpoint>> targetDelete(
OperationContext* opCtx, const write_ops::DeleteOpEntry& deleteDoc) const override;
StatusWith<std::vector<ShardEndpoint>> targetCollection() const override;
StatusWith<std::vector<ShardEndpoint>> targetAllShards(OperationContext* opCtx) const override;
void noteCouldNotTarget() override;
void noteStaleResponse(const ShardEndpoint& endpoint,
const StaleConfigInfo& staleInfo) override;
/**
* Replaces the targeting information with the latest information from the cache. If this
* information is stale WRT the noted stale responses or a remote refresh is needed due
* to a targeting failure, will contact the config servers to reload the metadata.
*
* Reports wasChanged = true if the metadata is different after this reload.
*
* Also see NSTargeter::refreshIfNeeded().
*/
Status refreshIfNeeded(OperationContext* opCtx, bool* wasChanged) override;
private:
using ShardVersionMap = std::map<ShardId, ChunkVersion>;
/**
* Performs an actual refresh from the config server.
*/
Status _refreshNow(OperationContext* opCtx);
/**
* Attempts to route an update operation by extracting an exact shard key from the given query
* and/or update expression. Should only be called on sharded collections, and with a valid
* updateType. Returns not-OK if the user's query is invalid, if the extracted shard key exceeds
* the maximum allowed length, or if the update could not be targeted by exact shard key.
*/
StatusWith<std::vector<ShardEndpoint>> _targetUpdateByShardKey(OperationContext* opCtx,
const UpdateType updateType,
const BSONObj query,
const BSONObj collation,
const BSONObj updateExpr,
const bool isUpsert) const;
/**
* Returns a vector of ShardEndpoints where a document might need to be placed.
*
* Returns !OK with message if replacement could not be targeted
*
* If 'collation' is empty, we use the collection default collation for targeting.
*/
StatusWith<std::vector<ShardEndpoint>> _targetDoc(OperationContext* opCtx,
const BSONObj& doc,
const BSONObj& collation) const;
/**
* Returns a vector of ShardEndpoints for a potentially multi-shard query.
*
* Returns !OK with message if query could not be targeted.
*
* If 'collation' is empty, we use the collection default collation for targeting.
*/
StatusWith<std::vector<ShardEndpoint>> _targetQuery(OperationContext* opCtx,
const BSONObj& query,
const BSONObj& collation) const;
/**
* Returns a ShardEndpoint for an exact shard key query.
*
* Also has the side effect of updating the chunks stats with an estimate of the amount of
* data targeted at this shard key.
*
* If 'collation' is empty, we use the collection default collation for targeting.
*/
ShardEndpoint _targetShardKey(const BSONObj& shardKey,
const BSONObj& collation,
long long estDataSize) const;
// Full namespace of the collection for this targeter
const NamespaceString _nss;
// Stores whether we need to check the remote server on refresh
bool _needsTargetingRefresh;
// The latest loaded routing cache entry
boost::optional<CachedCollectionRoutingInfo> _routingInfo;
// Set to the epoch of the namespace we are targeting. If we ever refresh the catalog cache and
// find a new epoch, we immediately throw a StaleEpoch exception.
boost::optional<OID> _targetEpoch;
// Map of shard->remote shard version reported from stale errors
ShardVersionMap _remoteShardVersions;
};
} // namespace mongo
|
