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
|
/**
* 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 <vector>
#include "mongo/s/chunk_manager.h"
#include "mongo/s/stale_exception.h"
#include "mongo/s/write_ops/batched_command_request.h"
namespace mongo {
/**
* The NSTargeter interface is used by a WriteOp to generate and target child write operations
* to a particular collection.
*
* The lifecyle of a NSTargeter is:
*
* 0. targetDoc/targetQuery as many times as is required
*
* 1a. On targeting failure we may need to refresh, note that it happened.
* 1b. On stale config from a child write operation we may need to refresh, note the error.
*
* 2. refreshIfNeeded() to get newer targeting information
*
* 3. Goto 0.
*
* The refreshIfNeeded() operation must try to make progress against noted targeting or stale
* config failures, see comments below. No functions may block for shared resources or network
* calls except refreshIfNeeded().
*
* Implementers are free to define more specific targeting error codes to allow more complex
* error handling.
*
* The interface must not be used from multiple threads.
*/
class NSTargeter {
public:
virtual ~NSTargeter() = default;
/**
* Returns the namespace targeted.
*/
virtual const NamespaceString& getNS() const = 0;
virtual bool isShardedTimeSeriesBucketsNamespace() const = 0;
/**
* Returns a ShardEndpoint for a single document write or throws ShardKeyNotFound if 'doc' is
* malformed with respect to the shard key pattern of the collection.
* If 'chunkRanges' is not null, populates it with ChunkRanges that would be targeted by the
* insert.
*/
virtual ShardEndpoint targetInsert(OperationContext* opCtx,
const BSONObj& doc,
std::set<ChunkRange>* chunkRanges = nullptr) const = 0;
/**
* Returns a vector of ShardEndpoints for a potentially multi-shard update or throws
* ShardKeyNotFound if 'updateOp' misses a shard key, but the type of update requires it.
* If 'chunkRanges' is not null, populates it with ChunkRanges that would be targeted by the
* update.
*/
virtual std::vector<ShardEndpoint> targetUpdate(
OperationContext* opCtx,
const BatchItemRef& itemRef,
std::set<ChunkRange>* chunkRanges = nullptr) const = 0;
/**
* Returns a vector of ShardEndpoints for a potentially multi-shard delete or throws
* ShardKeyNotFound if 'deleteOp' misses a shard key, but the type of delete requires it.
* If 'chunkRanges' is not null, populates it with ChunkRanges that would be targeted by the
* delete.
*/
virtual std::vector<ShardEndpoint> targetDelete(
OperationContext* opCtx,
const BatchItemRef& itemRef,
std::set<ChunkRange>* chunkRanges = nullptr) const = 0;
/**
* Returns a vector of ShardEndpoints for all shards.
*/
virtual std::vector<ShardEndpoint> targetAllShards(
OperationContext* opCtx, std::set<ChunkRange>* chunkRanges = nullptr) const = 0;
/**
* Informs the targeter that a targeting failure occurred during one of the last targeting
* operations. If this is noted, we cannot note stale responses.
*/
virtual void noteCouldNotTarget() = 0;
/**
* Informs the targeter of stale config responses for this namespace from an endpoint, with
* further information available in the returned staleInfo.
*
* Any stale responses noted here will be taken into account on the next refresh.
*
* If stale responses are is noted, we must not have noted that we cannot target.
*/
virtual void noteStaleShardResponse(OperationContext* opCtx,
const ShardEndpoint& endpoint,
const StaleConfigInfo& staleInfo) = 0;
/**
* Informs the targeter of stale db routing version responses for this db from an endpoint,
* with further information available in the returned staleInfo.
*
* Any stale responses noted here will be taken into account on the next refresh.
*
* If stale responses are is noted, we must not have noted that we cannot target.
*/
virtual void noteStaleDbResponse(OperationContext* optCtx,
const ShardEndpoint& endpoint,
const StaleDbRoutingVersion& staleInfo) = 0;
/**
* Refreshes the targeting metadata for the namespace if needed, based on previously-noted
* stale responses and targeting failures.
*
* After this function is called, the targeter should be in a state such that the noted
* stale responses are not seen again and if a targeting failure occurred it reloaded -
* it should try to make progress.
*
* Returns if the targeting used here was changed.
*
* NOTE: This function may block for shared resources or network calls.
*/
virtual bool refreshIfNeeded(OperationContext* opCtx) = 0;
/**
* Returns the number of shards that own one or more chunks for the targeted collection.
*/
virtual int getNShardsOwningChunks() const = 0;
};
} // namespace mongo
|
