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
|
/**
* Copyright (C) 2013 10gen 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 "mongo/db/commands.h"
#include "mongo/db/client_basic.h"
#include "mongo/s/write_ops/batched_command_request.h"
namespace mongo {
/**
* Base class for write commands. Write commands support batch writes and write concern,
* and return per-item error information. All write commands use the (non-virtual) entry
* point WriteCmd::run().
*
* Command parsing is performed by the WriteBatch class (command syntax documented there),
* and command execution is performed by the WriteBatchExecutor class.
*/
class WriteCmd : public Command {
MONGO_DISALLOW_COPYING(WriteCmd);
public:
virtual ~WriteCmd() {}
protected:
/**
* Instantiates a command that can be invoked by "name", which will be capable of issuing
* write batches of type "writeType", and will require privilege "action" to run.
*/
WriteCmd(StringData name, BatchedCommandRequest::BatchType writeType);
// Full log of write command can be quite large.
static void redactTooLongLog(mutablebson::Document* cmdObj, StringData fieldName);
private:
virtual bool slaveOk() const;
virtual bool isWriteCommandForConfigServer() const;
virtual Status checkAuthForCommand(ClientBasic* client,
const std::string& dbname,
const BSONObj& cmdObj);
virtual bool shouldAffectCommandCounter() const;
// Write command entry point.
virtual bool run(OperationContext* txn,
const std::string& dbname,
BSONObj& cmdObj,
int options,
std::string& errmsg,
BSONObjBuilder& result);
// Write commands can be explained.
virtual Status explain(OperationContext* txn,
const std::string& dbname,
const BSONObj& cmdObj,
ExplainCommon::Verbosity verbosity,
BSONObjBuilder* out) const;
// Type of batch (e.g. insert).
BatchedCommandRequest::BatchType _writeType;
};
class CmdInsert : public WriteCmd {
MONGO_DISALLOW_COPYING(CmdInsert);
public:
CmdInsert();
void redactForLogging(mutablebson::Document* cmdObj);
private:
virtual void help(std::stringstream& help) const;
};
class CmdUpdate : public WriteCmd {
MONGO_DISALLOW_COPYING(CmdUpdate);
public:
CmdUpdate();
void redactForLogging(mutablebson::Document* cmdObj);
private:
virtual void help(std::stringstream& help) const;
};
class CmdDelete : public WriteCmd {
MONGO_DISALLOW_COPYING(CmdDelete);
public:
CmdDelete();
void redactForLogging(mutablebson::Document* cmdObj);
private:
virtual void help(std::stringstream& help) const;
};
} // namespace mongo
|