MongoDB C++ Driver  mongocxx-3.10.2
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 <mongocxx/result/update-fwd.hpp>
20 
21 #include <bsoncxx/stdx/optional.hpp>
22 #include <bsoncxx/types.hpp>
23 #include <mongocxx/result/bulk_write.hpp>
24 #include <mongocxx/stdx.hpp>
25 
26 #include <mongocxx/config/prelude.hpp>
27 
28 namespace mongocxx {
29 namespace v_noabi {
30 namespace result {
31 
33 class update {
34  public:
35  // This constructor is public for testing purposes only
37 
43  const result::bulk_write& result() const;
44 
50  std::int32_t matched_count() const;
51 
56  std::int32_t modified_count() const;
57 
62  std::int32_t upserted_count() const;
63 
69  stdx::optional<bsoncxx::v_noabi::document::element> upserted_id() const;
70 
71  private:
72  result::bulk_write _result;
73 
74  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const update&, const update&);
75  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const update&, const update&);
76 };
77 
78 } // namespace result
79 } // namespace v_noabi
80 } // namespace mongocxx
81 
82 #include <mongocxx/config/postlude.hpp>
Class representing the result of a MongoDB bulk write operation.
Definition: bulk_write.hpp:36
Class representing the result of a MongoDB update operation.
Definition: update.hpp:33
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::v_noabi::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-fwd.hpp:19