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
|
/**
* Copyright (C) 2015 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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 <string>
#include <vector>
#include "mongo/base/status.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/db/jsobj.h"
#include "mongo/s/async_requests_sender.h"
#include "mongo/s/chunk_version.h"
#include "mongo/s/commands/strategy.h"
#include "mongo/stdx/memory.h"
namespace mongo {
class CachedCollectionRoutingInfo;
class CachedDatabaseInfo;
class OperationContext;
class ShardId;
/**
* This function appends the provided writeConcernError BSONElement to the sharded response.
*/
void appendWriteConcernErrorToCmdResponse(const ShardId& shardID,
const BSONElement& wcErrorElem,
BSONObjBuilder& responseBuilder);
/**
* Returns a copy of 'cmdObj' with 'version' appended.
*/
BSONObj appendShardVersion(BSONObj cmdObj, ChunkVersion version);
/**
* Utility for dispatching unversioned commands to all shards in a cluster.
*
* Returns a non-OK status if a failure occurs on *this* node during execution. Otherwise, returns
* success and a list of responses from shards (including errors from the shards or errors reaching
* the shards).
*
* Note, if this mongos has not refreshed its shard list since
* 1) a shard has been *added* through a different mongos, a request will not be sent to the added
* shard
* 2) a shard has been *removed* through a different mongos, this function will return a
* ShardNotFound error status.
*/
std::vector<AsyncRequestsSender::Response> scatterGatherUnversionedTargetAllShards(
OperationContext* opCtx,
const std::string& dbName,
boost::optional<NamespaceString> nss,
const BSONObj& cmdObj,
const ReadPreferenceSetting& readPref,
Shard::RetryPolicy retryPolicy);
/**
* Utility for dispatching versioned commands on a namespace, deciding which shards to
* target by applying the passed-in query and collation to the local routing table cache.
*
* Does not retry on StaleConfigException.
*
* Return value is the same as scatterGatherUnversionedTargetAllShards().
*/
std::vector<AsyncRequestsSender::Response> scatterGatherVersionedTargetByRoutingTable(
OperationContext* opCtx,
const std::string& dbName,
const NamespaceString& nss,
const BSONObj& cmdObj,
const ReadPreferenceSetting& readPref,
Shard::RetryPolicy retryPolicy,
const BSONObj& query,
const BSONObj& collation);
/**
* Utility for dispatching commands on a namespace, but with special hybrid versioning:
* - If the namespace is unsharded, a version is attached (so this node can find out if its routing
* table was stale, and the namespace is actually sharded), and only the primary shard is targeted.
* - If the namespace is sharded, no version is attached, and the request is broadcast to all
* shards.
*
* Does not retry on StaleConfigException.
*
* Return value is the same as scatterGatherUnversionedTargetAllShards().
*/
std::vector<AsyncRequestsSender::Response> scatterGatherOnlyVersionIfUnsharded(
OperationContext* opCtx,
const std::string& dbName,
const NamespaceString& nss,
const BSONObj& cmdObj,
const ReadPreferenceSetting& readPref,
Shard::RetryPolicy retryPolicy);
/**
* Attaches each shard's response or error status by the shard's connection string in a top-level
* field called 'raw' in 'output'.
*
* If all shards that errored had the same error, writes the common error code to 'output'. Writes a
* string representation of all errors to 'errmsg.' Errors codes in 'ignoredErrors' are not treated
* as errors if any shard returned success.
*
* Returns true if any shard reports success and only ignored errors occur.
*/
bool appendRawResponses(OperationContext* opCtx,
std::string* errmsg,
BSONObjBuilder* output,
std::vector<AsyncRequestsSender::Response> shardResponses,
std::set<ErrorCodes::Error> ignoredErrors = {});
/**
* Utility function to compute a single error code from a vector of command results.
*
* @return If there is an error code common to all of the error results, returns that error
* code; otherwise, returns 0.
*/
int getUniqueCodeFromCommandResults(const std::vector<Strategy::CommandResult>& results);
/**
* Utility function to return an empty result set from a command.
*/
bool appendEmptyResultSet(BSONObjBuilder& result, Status status, const std::string& ns);
/**
* If the specified database exists already, loads it in the cache (if not already there) and
* returns it. Otherwise, if it does not exist, this call will implicitly create it as non-sharded.
*/
StatusWith<CachedDatabaseInfo> createShardDatabase(OperationContext* opCtx, StringData dbName);
} // namespace mongo
|
