MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
update.hpp
1 // Copyright 2014 MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <cstdint>
18 
19 #include <bsoncxx/stdx/optional.hpp>
20 #include <bsoncxx/types.hpp>
21 #include <mongocxx/result/bulk_write.hpp>
22 #include <mongocxx/stdx.hpp>
23 
24 #include <mongocxx/config/prelude.hpp>
25 
26 namespace mongocxx {
27 inline namespace v_noabi {
28 namespace result {
29 
31 class MONGOCXX_API update {
32  public:
33  // This constructor is public for testing purposes only
34  explicit update(result::bulk_write result);
35 
41  const result::bulk_write& result() const;
42 
48  std::int32_t matched_count() const;
49 
54  std::int32_t modified_count() const;
55 
60  std::int32_t upserted_count() const;
61 
67  stdx::optional<bsoncxx::document::element> upserted_id() const;
68 
69  private:
70  result::bulk_write _result;
71 
72  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const update&, const update&);
73  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const update&, const update&);
74 };
75 
76 } // namespace result
77 } // namespace v_noabi
78 } // namespace mongocxx
79 
80 #include <mongocxx/config/postlude.hpp>
Class representing the result of a MongoDB bulk write operation.
Definition: bulk_write.hpp:34
Class representing the result of a MongoDB update operation.
Definition: update.hpp:31
std::int32_t matched_count() const
Gets the number of documents that were matched during this operation.
std::int32_t modified_count() const
Gets the number of documents that were modified during this operation.
const result::bulk_write & result() const
Returns the bulk write result for this update operation.
stdx::optional< bsoncxx::document::element > upserted_id() const
If a document was upserted during this operation, gets the _id of the upserted document.
std::int32_t upserted_count() const
Gets the number of documents that were upserted during this operation.
The top-level namespace for mongocxx library entities.
Definition: bulk_write.hpp:24