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
|
/**
* Copyright (C) 2010-2014 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 <atomic>
#include "mongo/client/connection_string.h"
#include "mongo/db/query/explain_options.h"
#include "mongo/s/client/shard.h"
namespace mongo {
class DbMessage;
struct DbResponse;
class Message;
class NamespaceString;
class OperationContext;
class QueryRequest;
/**
* Legacy interface for processing client read/write/cmd requests.
*/
class Strategy {
public:
/**
* Handles a legacy-style opQuery request and sends the response back on success or throws on
* error.
*
* Must not be called with legacy '.$cmd' commands.
*/
static DbResponse queryOp(OperationContext* opCtx, const NamespaceString& nss, DbMessage* dbm);
/**
* Handles a legacy-style getMore request and sends the response back on success (or cursor not
* found) or throws on error.
*/
static DbResponse getMore(OperationContext* opCtx, const NamespaceString& nss, DbMessage* dbm);
/**
* Handles a legacy-style killCursors request. Doesn't send any response on success or throws on
* error.
*/
static void killCursors(OperationContext* opCtx, DbMessage* dbm);
/**
* Handles a legacy-style write operation request and updates the last error state on the client
* with the result from the operation. Doesn't send any response back and does not throw on
* errors.
*/
static void writeOp(OperationContext* opCtx, DbMessage* dbm);
/**
* Executes a command from either OP_QUERY or OP_MSG wire protocols.
*
* Catches StaleConfigException errors and retries the command automatically after refreshing
* the metadata for the failing namespace.
*/
static DbResponse clientCommand(OperationContext* opCtx, const Message& message);
/**
* Helper to run an explain of a find operation on the shards. Fills 'out' with the result of
* the of the explain command on success. On failure, throws and does not modify 'out'.
*
* Used both if mongos receives an explain command and if it receives an OP_QUERY find with the
* $explain modifier.
*/
static void explainFind(OperationContext* opCtx,
const BSONObj& findCommand,
const QueryRequest& qr,
ExplainOptions::Verbosity verbosity,
const ReadPreferenceSetting& readPref,
BSONObjBuilder* out);
struct CommandResult {
CommandResult() = default;
CommandResult(ShardId shardId, ConnectionString target, BSONObj result)
: shardTargetId(std::move(shardId)),
target(std::move(target)),
result(std::move(result)) {}
ShardId shardTargetId;
ConnectionString target;
BSONObj result;
};
/**
* Executes a command against a particular database, and targets the command based on a
* collection in that database, according to 'targetingQuery' and 'targetingCollation'. If
* 'targetingCollation' is empty, the collection default collation is used for targeting.
*
* This version should be used by internal commands when possible.
*
* TODO: Replace these methods and all other methods of command dispatch with a more general
* command op framework.
*/
static void commandOp(OperationContext* opCtx,
const std::string& db,
const BSONObj& command,
const std::string& versionedNS,
const BSONObj& targetingQuery,
const BSONObj& targetingCollation,
std::vector<CommandResult>* results);
};
} // namespace mongo
|
