MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
insert_many.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 #include <map>
19 
20 #include <bsoncxx/array/value.hpp>
21 #include <bsoncxx/types.hpp>
22 #include <mongocxx/result/bulk_write.hpp>
23 
24 #include <mongocxx/config/prelude.hpp>
25 
26 namespace mongocxx {
27 inline namespace v_noabi {
28 class collection;
29 
30 namespace result {
31 
36 class MONGOCXX_API insert_many {
37  public:
38  using id_map = std::map<std::size_t, bsoncxx::document::element>;
39 
40  insert_many(result::bulk_write result, bsoncxx::array::value inserted_ids);
41 
42  insert_many(const insert_many&);
43  insert_many(insert_many&&) = default;
44 
45  insert_many& operator=(const insert_many&);
46  insert_many& operator=(insert_many&&) = default;
47 
53  const result::bulk_write& result() const;
54 
60  std::int32_t inserted_count() const;
61 
69  id_map inserted_ids() const;
70 
71  private:
72  friend collection;
73 
74  // Construct _inserted_ids from _inserted_ids_owned
75  MONGOCXX_PRIVATE void _buildInsertedIds();
76 
77  result::bulk_write _result;
78 
79  // Array containing documents with the values of the _id field for the inserted documents. This
80  // array is in the following format: [{"_id": ...}, {"_id": ...}, ...].
81  bsoncxx::array::value _inserted_ids_owned;
82 
83  // Points into _inserted_ids_owned.
84  id_map _inserted_ids;
85 
86  friend MONGOCXX_API bool MONGOCXX_CALL operator==(const insert_many&, const insert_many&);
87  friend MONGOCXX_API bool MONGOCXX_CALL operator!=(const insert_many&, const insert_many&);
88 };
89 
90 } // namespace result
91 } // namespace v_noabi
92 } // namespace mongocxx
93 
94 #include <mongocxx/config/postlude.hpp>
Class representing server side document groupings within a MongoDB database.
Definition: collection.hpp:85
Class representing the result of a MongoDB bulk write operation.
Definition: bulk_write.hpp:34
Class representing the result of a MongoDB insert many operation (executed as a bulk write).
Definition: insert_many.hpp:36
std::int32_t inserted_count() const
Gets the number of documents that were inserted during this operation.
id_map inserted_ids() const
Gets the _ids of the inserted documents.
const result::bulk_write & result() const
Returns the bulk write result for this insert many operation.
The top-level namespace for mongocxx library entities.
Definition: bulk_write.hpp:24