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
|
/**
* 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 <vector>
#include "mongo/base/string_data.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/namespace_string.h"
#include "mongo/s/bson_serializable.h"
#include "mongo/s/write_ops/batched_request_metadata.h"
#include "mongo/s/write_ops/batched_update_document.h"
namespace mongo {
/**
* This class represents the layout and content of a batched update runCommand,
* the request side.
*/
class BatchedUpdateRequest : public BSONSerializable {
MONGO_DISALLOW_COPYING(BatchedUpdateRequest);
public:
//
// schema declarations
//
// Name used for the batched update invocation.
static const std::string BATCHED_UPDATE_REQUEST;
// Field names and types in the batched update command type.
static const BSONField<std::string> collName;
static const BSONField<std::vector<BatchedUpdateDocument*> > updates;
static const BSONField<BSONObj> writeConcern;
static const BSONField<bool> ordered;
static const BSONField<BSONObj> metadata;
//
// construction / destruction
//
BatchedUpdateRequest();
virtual ~BatchedUpdateRequest();
/** Copies all the fields present in 'this' to 'other'. */
void cloneTo(BatchedUpdateRequest* other) const;
//
// bson serializable interface implementation
//
virtual bool isValid(std::string* errMsg) const;
virtual BSONObj toBSON() const;
virtual bool parseBSON(const BSONObj& source, std::string* errMsg);
virtual void clear();
virtual std::string toString() const;
//
// individual field accessors
//
void setCollName(StringData collName);
void setCollNameNS(const NamespaceString& collName);
const std::string& getCollName() const;
const NamespaceString& getCollNameNS() const;
const NamespaceString& getTargetingNSS() const;
void setUpdates(const std::vector<BatchedUpdateDocument*>& updates);
/**
* updates ownership is transferred to here.
*/
void addToUpdates(BatchedUpdateDocument* updates);
void unsetUpdates();
bool isUpdatesSet() const;
std::size_t sizeUpdates() const;
const std::vector<BatchedUpdateDocument*>& getUpdates() const;
const BatchedUpdateDocument* getUpdatesAt(std::size_t pos) const;
void setWriteConcern(const BSONObj& writeConcern);
void unsetWriteConcern();
bool isWriteConcernSet() const;
const BSONObj& getWriteConcern() const;
void setOrdered(bool ordered);
void unsetOrdered();
bool isOrderedSet() const;
bool getOrdered() const;
void setShouldBypassValidation(bool newVal) { _shouldBypassValidation = newVal; }
bool shouldBypassValidation() const { return _shouldBypassValidation; }
/*
* metadata ownership will be transferred to this.
*/
void setMetadata(BatchedRequestMetadata* metadata);
void unsetMetadata();
bool isMetadataSet() const;
BatchedRequestMetadata* getMetadata() const;
private:
// Convention: (M)andatory, (O)ptional
// (M) collection we're updating from
NamespaceString _collName;
bool _isCollNameSet;
// (M) array of individual updates
std::vector<BatchedUpdateDocument*> _updates;
bool _isUpdatesSet;
// (O) to be issued after the batch applied
BSONObj _writeConcern;
bool _isWriteConcernSet;
// (O) whether batch is issued in parallel or not
bool _ordered;
bool _isOrderedSet;
// (O) should document validation be bypassed (default false)
bool _shouldBypassValidation;
// (O) metadata associated with this request for internal use.
std::unique_ptr<BatchedRequestMetadata> _metadata;
};
} // namespace mongo
|
