userver: userver/storages/mongo/operations.hpp Source File
Loading...
Searching...
No Matches
operations.hpp
Go to the documentation of this file.
1#pragma once
2
3/// @file userver/storages/mongo/operations.hpp
4/// @brief Collection operation models
5
6#include <userver/formats/bson/document.hpp>
7#include <userver/formats/bson/value.hpp>
8#include <userver/storages/mongo/options.hpp>
9#include <userver/utils/fast_pimpl.hpp>
10
11USERVER_NAMESPACE_BEGIN
12
13namespace storages::mongo::impl::cdriver {
14class CDriverCollectionImpl;
15} // namespace storages::mongo::impl::cdriver
16
17/// Collection operations
18namespace storages::mongo::operations {
19
20/// Counts documents matching the filter
21class Count {
22public:
23 explicit Count(formats::bson::Document filter);
24 ~Count();
25
26 Count(const Count&);
27 Count(Count&&) noexcept;
28 Count& operator=(const Count&);
29 Count& operator=(Count&&) noexcept;
30
31 void SetOption(const options::ReadPreference&);
32 void SetOption(options::ReadPreference::Mode);
33 void SetOption(options::ReadConcern);
34 void SetOption(options::Skip);
35 void SetOption(options::Limit);
36 void SetOption(const options::MaxServerTime&);
37 void SetOption(const options::Hint&);
38
39private:
40 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
41
42 class Impl;
43 static constexpr size_t kSize = 96;
44 static constexpr size_t kAlignment = 8;
45 // MAC_COMPAT: std::string size differs
46 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
47};
48
49/// Returns approximate number of documents in a collection
50class CountApprox {
51public:
52 CountApprox();
53 ~CountApprox();
54
55 CountApprox(const CountApprox&);
56 CountApprox(CountApprox&&) noexcept;
57 CountApprox& operator=(const CountApprox&);
58 CountApprox& operator=(CountApprox&&) noexcept;
59
60 void SetOption(const options::ReadPreference&);
61 void SetOption(options::ReadPreference::Mode);
62 void SetOption(options::ReadConcern);
63 void SetOption(options::Skip);
64 void SetOption(options::Limit);
65 void SetOption(const options::MaxServerTime&);
66
67private:
68 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
69
70 class Impl;
71 static constexpr size_t kSize = 72;
72 static constexpr size_t kAlignment = 8;
73 // MAC_COMPAT: std::string size differs
74 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
75};
76
77/// Retrieves documents matching the filter
78class Find {
79public:
80 explicit Find(formats::bson::Document filter);
81 ~Find();
82
83 Find(const Find&);
84 Find(Find&&) noexcept;
85 Find& operator=(const Find&);
86 Find& operator=(Find&&) noexcept;
87
88 void SetOption(const options::ReadPreference&);
89 void SetOption(options::ReadPreference::Mode);
90 void SetOption(options::ReadConcern);
91 void SetOption(options::Skip);
92 void SetOption(options::Limit);
93 void SetOption(options::Projection);
94 void SetOption(const options::Sort&);
95 void SetOption(const options::Hint&);
96 void SetOption(options::AllowPartialResults);
97 void SetOption(options::Tailable);
98 void SetOption(const options::Comment&);
99 void SetOption(const options::MaxServerTime&);
100
101private:
102 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
103
104 class Impl;
105 static constexpr size_t kSize = 96;
106 static constexpr size_t kAlignment = 8;
107 // MAC_COMPAT: std::string size differs
108 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
109};
110
111/// Inserts a single document
112class InsertOne {
113public:
114 explicit InsertOne(formats::bson::Document document);
115 ~InsertOne();
116
117 InsertOne(const InsertOne&);
118 InsertOne(InsertOne&&) noexcept;
119 InsertOne& operator=(const InsertOne&);
120 InsertOne& operator=(InsertOne&&) noexcept;
121
122 void SetOption(options::WriteConcern::Level);
123 void SetOption(const options::WriteConcern&);
124 void SetOption(options::SuppressServerExceptions);
125
126private:
127 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
128
129 class Impl;
130 static constexpr size_t kSize = 80;
131 static constexpr size_t kAlignment = 8;
132 // MAC_COMPAT: std::string size differs
133 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
134};
135
136/// Inserts multiple documents
137class InsertMany {
138public:
139 InsertMany();
140 explicit InsertMany(std::vector<formats::bson::Document> documents);
141 ~InsertMany();
142
143 InsertMany(const InsertMany&);
144 InsertMany(InsertMany&&) noexcept;
145 InsertMany& operator=(const InsertMany&);
146 InsertMany& operator=(InsertMany&&) noexcept;
147
148 void Append(formats::bson::Document document);
149
150 void SetOption(options::Unordered);
151 void SetOption(options::WriteConcern::Level);
152 void SetOption(const options::WriteConcern&);
153 void SetOption(options::SuppressServerExceptions);
154
155private:
156 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
157
158 class Impl;
159 static constexpr size_t kSize = 88;
160 static constexpr size_t kAlignment = 8;
161 // MAC_COMPAT: std::string size differs
162 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
163};
164
165/// Replaces a single document
166class ReplaceOne {
167public:
168 ReplaceOne(formats::bson::Document selector, formats::bson::Document replacement);
169 ~ReplaceOne();
170
171 ReplaceOne(const ReplaceOne&);
172 ReplaceOne(ReplaceOne&&) noexcept;
173 ReplaceOne& operator=(const ReplaceOne&);
174 ReplaceOne& operator=(ReplaceOne&&) noexcept;
175
176 void SetOption(options::Upsert);
177 void SetOption(options::WriteConcern::Level);
178 void SetOption(const options::WriteConcern&);
179 void SetOption(options::SuppressServerExceptions);
180
181private:
182 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
183
184 class Impl;
185 static constexpr size_t kSize = 96;
186 static constexpr size_t kAlignment = 8;
187 // MAC_COMPAT: std::string size differs
188 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
189};
190
191/// Updates documents
192class Update {
193public:
194 enum class Mode { kSingle, kMulti };
195
196 Update(Mode mode, formats::bson::Document selector, formats::bson::Document update);
197 ~Update();
198
199 Update(const Update&);
200 Update(Update&&) noexcept;
201 Update& operator=(const Update&);
202 Update& operator=(Update&&) noexcept;
203
204 void SetOption(options::Upsert);
205 void SetOption(options::RetryDuplicateKey);
206 void SetOption(options::WriteConcern::Level);
207 void SetOption(const options::WriteConcern&);
208 void SetOption(options::SuppressServerExceptions);
209 void SetOption(const options::ArrayFilters&);
210
211 /// @note Available starting in MongoDB 4.2.1
212 void SetOption(const options::Hint&);
213
214private:
215 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
216
217 class Impl;
218 static constexpr size_t kSize = 96;
219 static constexpr size_t kAlignment = 8;
220 // MAC_COMPAT: std::string size differs
221 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
222};
223
224/// Deletes documents
225class Delete {
226public:
227 enum class Mode { kSingle, kMulti };
228
229 Delete(Mode mode, formats::bson::Document selector);
230 ~Delete();
231
232 Delete(const Delete&);
233 Delete(Delete&&) noexcept;
234 Delete& operator=(const Delete&);
235 Delete& operator=(Delete&&) noexcept;
236
237 void SetOption(options::WriteConcern::Level);
238 void SetOption(const options::WriteConcern&);
239 void SetOption(options::SuppressServerExceptions);
240
241 /// @note Available starting in MongoDB 4.4
242 void SetOption(const options::Hint&);
243
244private:
245 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
246
247 class Impl;
248 static constexpr size_t kSize = 80;
249 static constexpr size_t kAlignment = 8;
250 // MAC_COMPAT: std::string size differs
251 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
252};
253
254/// Atomically updates a document and returns either previous or new version
255class FindAndModify {
256public:
257 FindAndModify(formats::bson::Document query, const formats::bson::Document& update);
258 ~FindAndModify();
259
260 FindAndModify(const FindAndModify&) = delete;
261 FindAndModify(FindAndModify&&) noexcept;
262 FindAndModify& operator=(const FindAndModify&) = delete;
263 FindAndModify& operator=(FindAndModify&&) noexcept;
264
265 void SetOption(options::ReturnNew);
266 void SetOption(options::Upsert);
267 void SetOption(options::RetryDuplicateKey);
268 void SetOption(const options::Sort&);
269 void SetOption(options::Projection);
270 void SetOption(options::WriteConcern::Level);
271 void SetOption(const options::WriteConcern&);
272 void SetOption(const options::MaxServerTime&);
273 void SetOption(const options::ArrayFilters&);
274
275private:
276 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
277
278 class Impl;
279 static constexpr size_t kSize = 80;
280 static constexpr size_t kAlignment = 8;
281 // MAC_COMPAT: std::string size differs
282 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
283};
284
285/// Atomically removes a document and returns it
286class FindAndRemove {
287public:
288 explicit FindAndRemove(formats::bson::Document query);
289 ~FindAndRemove();
290
291 FindAndRemove(const FindAndRemove&) = delete;
292 FindAndRemove(FindAndRemove&&) noexcept;
293 FindAndRemove& operator=(const FindAndRemove&) = delete;
294 FindAndRemove& operator=(FindAndRemove&&) noexcept;
295
296 void SetOption(const options::Sort&);
297 void SetOption(options::Projection);
298 void SetOption(options::WriteConcern::Level);
299 void SetOption(const options::WriteConcern&);
300 void SetOption(const options::MaxServerTime&);
301
302private:
303 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
304
305 class Impl;
306 static constexpr size_t kSize = 72;
307 static constexpr size_t kAlignment = 8;
308 // MAC_COMPAT: std::string size differs
309 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
310};
311
312/// Runs an aggregation pipeline
313class Aggregate {
314public:
315 explicit Aggregate(formats::bson::Value pipeline);
316 ~Aggregate();
317
318 Aggregate(const Aggregate&);
319 Aggregate(Aggregate&&) noexcept;
320 Aggregate& operator=(const Aggregate&);
321 Aggregate& operator=(Aggregate&&) noexcept;
322
323 void SetOption(const options::ReadPreference&);
324 void SetOption(options::ReadPreference::Mode);
325 void SetOption(options::ReadConcern);
326 void SetOption(const options::WriteConcern&);
327 void SetOption(options::WriteConcern::Level);
328 void SetOption(const options::Hint&);
329 void SetOption(const options::Comment&);
330 void SetOption(const options::MaxServerTime&);
331
332private:
333 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
334
335 class Impl;
336 static constexpr size_t kSize = 120;
337 static constexpr size_t kAlignment = 8;
338 // MAC_COMPAT: std::string size differs
339 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
340};
341
342/// Retrieves distinct values for a specified field
343class Distinct final {
344public:
345 explicit Distinct(std::string field);
346 Distinct(std::string field, formats::bson::Document filter);
347 ~Distinct();
348
349 Distinct(const Distinct&);
350 Distinct(Distinct&&) noexcept;
351 Distinct& operator=(const Distinct&);
352 Distinct& operator=(Distinct&&) noexcept;
353
354 void SetOption(const options::ReadPreference&);
355 void SetOption(options::ReadPreference::Mode);
356 void SetOption(options::ReadConcern);
357 void SetOption(const options::Collation&);
358 void SetOption(const options::Comment&);
359 void SetOption(const options::MaxServerTime&);
360
361private:
362 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
363
364 class Impl;
365 static constexpr size_t kSize = 104;
366 static constexpr size_t kAlignment = 8;
367 // MAC_COMPAT: std::string size differs
368 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
369};
370
371class Drop {
372public:
373 Drop();
374 ~Drop();
375
376 Drop(const Drop&);
377 Drop(Drop&&) noexcept;
378 Drop& operator=(const Drop&);
379 Drop& operator=(Drop&&) noexcept;
380
381 void SetOption(const options::WriteConcern&);
382 void SetOption(options::WriteConcern::Level);
383
384private:
385 friend class storages::mongo::impl::cdriver::CDriverCollectionImpl;
386
387 class Impl;
388 static constexpr size_t kSize = 56;
389 static constexpr size_t kAlignment = 8;
390 // MAC_COMPAT: std::string size differs
391 utils::FastPimpl<Impl, kSize, kAlignment, false> impl_;
392};
393
394} // namespace storages::mongo::operations
395
396USERVER_NAMESPACE_END