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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/**
* Copyright (C) 2023-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 <boost/optional.hpp>
#include <string>
#include "mongo/base/status.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/db/ops/write_ops_gen.h"
namespace mongo {
inline Status validateUpdateReturn(const std::string& value) {
if (value != "pre" && value != "post") {
return {ErrorCodes::BadValue, "\"return\" should be either \"pre\" or \"post\""};
}
return Status::OK();
}
/**
* A single item in a batch of results in a 'bulkWrite' command response.
*/
class BulkWriteReplyItem {
public:
static constexpr auto kCodeFieldName = "code"_sd;
static constexpr auto kErrmsgFieldName = "errmsg"_sd;
static constexpr auto kIdxFieldName = "idx"_sd;
static constexpr auto kNFieldName = "n"_sd;
static constexpr auto kNModifiedFieldName = "nModified"_sd;
static constexpr auto kOkFieldName = "ok"_sd;
static constexpr auto kUpsertedFieldName = "upserted"_sd;
static constexpr auto kValueFieldName = "value"_sd;
BulkWriteReplyItem();
BulkWriteReplyItem(std::int32_t idx, Status status = Status::OK());
BSONObj serialize() const;
BSONObj toBSON() const;
/**
* Factory function that parses a BulkWriteReplyItem from a BSONObj. A BulkWriteReplyItem parsed
* this way is strictly a view onto that BSONObj; the BSONObj must be kept valid to
* ensure the validity any members of this struct that point-into the BSONObj (i.e.
* unowned
* objects).
*/
static BulkWriteReplyItem parse(const BSONObj& bsonObject);
double getOk() const {
return _ok;
}
void setOk(double value) {
validateOk(value);
_ok = std::move(value);
_hasOk = true;
}
/**
* Holds the index of the batch entry.
*/
std::int32_t getIdx() const {
return _idx;
}
void setIdx(std::int32_t value) {
validateIdx(value);
_idx = std::move(value);
_hasIdx = true;
}
/**
* For insert: number of documents inserted.
* For update: number of documents that matched the query predicate.
* For delete: number of documents deleted.
*/
boost::optional<std::int32_t> getN() const {
return _n;
}
void setN(boost::optional<std::int32_t> value) {
_n = std::move(value);
}
/**
* Number of updated documents.
*/
boost::optional<std::int32_t> getNModified() const {
return _nModified;
}
void setNModified(boost::optional<std::int32_t> value) {
_nModified = std::move(value);
}
/**
* Contains documents that have been upserted.
*/
const boost::optional<mongo::write_ops::Upserted>& getUpserted() const {
return _upserted;
}
void setUpserted(boost::optional<mongo::write_ops::Upserted> value) {
_upserted = std::move(value);
}
/**
* The document after the write, if the 'return' field of the request is 'post'.
* Otherwise, the document before the write.
*/
const boost::optional<mongo::BSONObj>& getValue() const {
return _value;
}
void setValue(boost::optional<mongo::BSONObj> value) {
_value = std::move(value);
}
/**
* The status associated with the reply potentially containing error data for why the
* operation failed.
*/
const Status& getStatus() const {
return _status;
}
void setStatus(const Status status) {
_status = std::move(status);
}
protected:
void parseProtected(const BSONObj& bsonObject);
private:
void validateOk(double value);
void validateIdx(std::int32_t value);
private:
double _ok;
std::int32_t _idx;
boost::optional<std::int32_t> _n;
boost::optional<std::int32_t> _nModified;
boost::optional<mongo::write_ops::Upserted> _upserted;
boost::optional<BSONObj> _value;
Status _status = Status::OK();
bool _hasOk : 1;
bool _hasIdx : 1;
};
} // namespace mongo
|
