MongoDB C++ Driver  mongocxx-3.6.2
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 MONGOCXX_INLINE_NAMESPACE_BEGIN
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 
61  stdx::optional<bsoncxx::document::element> upserted_id() const;
62 
63  private:
64  result::bulk_write _result;
65 
66  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const update&, const update&);
67  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const update&, const update&);
68 };
69 
70 } // namespace result
71 MONGOCXX_INLINE_NAMESPACE_END
72 } // namespace mongocxx
73 
74 #include <mongocxx/config/postlude.hpp>
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
mongocxx::result::bulk_write
Class representing the result of a MongoDB bulk write operation.
Definition: bulk_write.hpp:34
mongocxx::result::update::matched_count
std::int32_t matched_count() const
Gets the number of documents that were matched during this operation.
mongocxx::result::update::modified_count
std::int32_t modified_count() const
Gets the number of documents that were modified during this operation.
mongocxx::result::update
Class representing the result of a MongoDB update operation.
Definition: update.hpp:31
mongocxx::result::update::upserted_id
stdx::optional< bsoncxx::document::element > upserted_id() const
If a document was upserted during this operation, gets the _id of the upserted document.
mongocxx::result::update::result
const result::bulk_write & result() const
Returns the bulk write result for this update operation.