MongoDB C++ Driver
mongocxx-3.6.4
|
20 #include <bsoncxx/builder/basic/array.hpp>
21 #include <bsoncxx/builder/basic/document.hpp>
22 #include <bsoncxx/builder/basic/kvp.hpp>
23 #include <bsoncxx/builder/concatenate.hpp>
24 #include <bsoncxx/document/view_or_value.hpp>
25 #include <bsoncxx/oid.hpp>
26 #include <bsoncxx/stdx/optional.hpp>
27 #include <bsoncxx/string/view_or_value.hpp>
28 #include <mongocxx/bulk_write.hpp>
29 #include <mongocxx/change_stream.hpp>
30 #include <mongocxx/client_session.hpp>
31 #include <mongocxx/cursor.hpp>
32 #include <mongocxx/index_view.hpp>
33 #include <mongocxx/model/insert_one.hpp>
34 #include <mongocxx/options/aggregate.hpp>
35 #include <mongocxx/options/bulk_write.hpp>
36 #include <mongocxx/options/change_stream.hpp>
37 #include <mongocxx/options/count.hpp>
38 #include <mongocxx/options/delete.hpp>
39 #include <mongocxx/options/distinct.hpp>
40 #include <mongocxx/options/estimated_document_count.hpp>
41 #include <mongocxx/options/find.hpp>
42 #include <mongocxx/options/find_one_and_delete.hpp>
43 #include <mongocxx/options/find_one_and_replace.hpp>
44 #include <mongocxx/options/find_one_and_update.hpp>
45 #include <mongocxx/options/index.hpp>
46 #include <mongocxx/options/index_view.hpp>
47 #include <mongocxx/options/insert.hpp>
48 #include <mongocxx/options/replace.hpp>
49 #include <mongocxx/options/update.hpp>
50 #include <mongocxx/pipeline.hpp>
51 #include <mongocxx/read_concern.hpp>
52 #include <mongocxx/read_preference.hpp>
53 #include <mongocxx/result/bulk_write.hpp>
54 #include <mongocxx/result/delete.hpp>
55 #include <mongocxx/result/insert_many.hpp>
56 #include <mongocxx/result/insert_one.hpp>
57 #include <mongocxx/result/replace_one.hpp>
58 #include <mongocxx/result/update.hpp>
59 #include <mongocxx/write_concern.hpp>
61 #include <mongocxx/config/prelude.hpp>
64 MONGOCXX_INLINE_NAMESPACE_BEGIN
96 class _empty_doc_tag {
97 _empty_doc_tag() =
default;
138 explicit operator
bool() const noexcept;
162 const options::aggregate& options = options::aggregate());
187 const options::aggregate& options = options::aggregate());
246 MONGOCXX_INLINE stdx::optional<result::bulk_write> write(
247 const model::write& write,
const options::bulk_write& options = options::bulk_write());
271 MONGOCXX_INLINE stdx::optional<result::bulk_write> write(
272 const client_session& session,
273 const model::write& write,
274 const options::bulk_write& options = options::bulk_write());
302 template <
typename container_type>
303 MONGOCXX_INLINE stdx::optional<result::bulk_write> bulk_write(
304 const container_type& writes,
const options::bulk_write& options = options::bulk_write());
329 template <
typename container_type>
330 MONGOCXX_INLINE stdx::optional<result::bulk_write> bulk_write(
331 const client_session& session,
332 const container_type& writes,
333 const options::bulk_write& options = options::bulk_write());
362 template <
typename write_model_iterator_type>
363 MONGOCXX_INLINE stdx::optional<result::bulk_write> bulk_write(
364 write_model_iterator_type begin,
365 write_model_iterator_type end,
366 const options::bulk_write& options = options::bulk_write());
392 template <
typename write_model_iterator_type>
393 MONGOCXX_INLINE stdx::optional<result::bulk_write> bulk_write(
394 const client_session& session,
395 write_model_iterator_type begin,
396 write_model_iterator_type end,
397 const options::bulk_write& options = options::bulk_write());
701 const bsoncxx::stdx::optional<mongocxx::write_concern>&
write_concern = {});
980 std::initializer_list<_empty_doc_tag> update,
1064 std::initializer_list<_empty_doc_tag> update,
1137 template <
typename container_type>
1138 MONGOCXX_INLINE stdx::optional<result::insert_many> insert_many(
1162 template <
typename container_type>
1163 MONGOCXX_INLINE stdx::optional<result::insert_many> insert_many(
1165 const container_type& container,
1193 template <
typename document_view_iterator_type>
1194 MONGOCXX_INLINE stdx::optional<result::insert_many> insert_many(
1195 document_view_iterator_type begin,
1196 document_view_iterator_type end,
1220 template <
typename document_view_iterator_type>
1221 MONGOCXX_INLINE stdx::optional<result::insert_many> insert_many(
1223 document_view_iterator_type begin,
1224 document_view_iterator_type end,
1289 bool drop_target_before_rename =
false,
1290 const bsoncxx::stdx::optional<write_concern>&
write_concern = {});
1315 bool drop_target_before_rename =
false,
1316 const bsoncxx::stdx::optional<write_concern>&
write_concern = {});
1489 std::initializer_list<_empty_doc_tag> update,
1570 std::initializer_list<_empty_doc_tag> update,
1648 std::initializer_list<_empty_doc_tag> update,
1729 std::initializer_list<_empty_doc_tag> update,
1839 MONGOCXX_PRIVATE std::int64_t _count(
const client_session* session,
1843 MONGOCXX_PRIVATE std::int64_t _count_documents(
const client_session* session,
1853 MONGOCXX_PRIVATE stdx::optional<result::delete_result> _delete_many(
1858 MONGOCXX_PRIVATE stdx::optional<result::delete_result> _delete_one(
1868 MONGOCXX_PRIVATE
void _drop(
1870 const bsoncxx::stdx::optional<mongocxx::write_concern>&
write_concern);
1876 MONGOCXX_PRIVATE stdx::optional<bsoncxx::document::value> _find_one(
1881 MONGOCXX_PRIVATE stdx::optional<bsoncxx::document::value> _find_one_and_delete(
1886 MONGOCXX_PRIVATE stdx::optional<bsoncxx::document::value> _find_one_and_replace(
1892 MONGOCXX_PRIVATE stdx::optional<bsoncxx::document::value> _find_one_and_update(
1898 MONGOCXX_PRIVATE stdx::optional<result::insert_one> _insert_one(
1903 MONGOCXX_PRIVATE
void _rename(
1906 bool drop_target_before_rename,
1907 const bsoncxx::stdx::optional<class write_concern>&
write_concern);
1909 MONGOCXX_PRIVATE stdx::optional<result::replace_one> _replace_one(
1914 MONGOCXX_PRIVATE stdx::optional<result::replace_one> _replace_one(
1920 MONGOCXX_PRIVATE stdx::optional<result::update> _update_one(
1926 MONGOCXX_PRIVATE stdx::optional<result::update> _update_many(
1937 class bulk_write _init_insert_many(const options::insert& options,
1940 void _insert_many_doc_handler(class bulk_write& writes,
1941 bsoncxx::builder::basic::array& inserted_ids,
1942 bsoncxx::document::view doc) const;
1944 stdx::optional<result::insert_many> _exec_insert_many(
1945 class bulk_write& writes, bsoncxx::builder::basic::array& inserted_ids);
1947 template <typename document_view_iterator_type>
1948 MONGOCXX_PRIVATE stdx::optional<result::insert_many> _insert_many(
1949 const client_session* session,
1950 document_view_iterator_type begin,
1951 document_view_iterator_type end,
1952 const options::insert& options);
1954 class MONGOCXX_PRIVATE impl;
1956 MONGOCXX_PRIVATE impl& _get_impl();
1957 MONGOCXX_PRIVATE const impl& _get_impl() const;
1959 std::unique_ptr<impl> _impl;
1963 const model::write& write, const options::bulk_write& options) {
1964 return create_bulk_write(options).append(write).execute();
1969 return create_bulk_write(session, options).append(write).execute();
1972 template <
typename container_type>
1973 MONGOCXX_INLINE stdx::optional<result::bulk_write> collection::bulk_write(
1975 return bulk_write(requests.begin(), requests.end(), options);
1978 template <
typename container_type>
1979 MONGOCXX_INLINE stdx::optional<result::bulk_write> collection::bulk_write(
1981 const container_type& requests,
1983 return bulk_write(session, requests.begin(), requests.end(), options);
1986 template <
typename write_model_iterator_type>
1987 MONGOCXX_INLINE stdx::optional<result::bulk_write> collection::bulk_write(
1988 write_model_iterator_type begin,
1989 write_model_iterator_type end,
1991 auto writes = create_bulk_write(options);
1992 std::for_each(begin, end, [&](
const model::write& current) { writes.append(current); });
1993 return writes.execute();
1996 template <
typename write_model_iterator_type>
1997 MONGOCXX_INLINE stdx::optional<result::bulk_write> collection::bulk_write(
1999 write_model_iterator_type begin,
2000 write_model_iterator_type end,
2002 auto writes = create_bulk_write(session, options);
2003 std::for_each(begin, end, [&](
const model::write& current) { writes.append(current); });
2004 return writes.execute();
2007 template <
typename container_type>
2010 return insert_many(container.begin(), container.end(), options);
2013 template <
typename container_type>
2016 const container_type& container,
2018 return insert_many(session, container.begin(), container.end(), options);
2021 template <
typename document_view_iterator_type>
2022 MONGOCXX_INLINE stdx::optional<result::insert_many> collection::_insert_many(
2025 document_view_iterator_type begin,
2026 document_view_iterator_type end,
2029 auto writes = _init_insert_many(options, session);
2031 _insert_many_doc_handler(writes, inserted_ids, doc);
2033 return _exec_insert_many(writes, inserted_ids);
2036 template <
typename document_view_iterator_type>
2038 document_view_iterator_type begin,
2039 document_view_iterator_type end,
2041 return _insert_many(
nullptr, begin, end, options);
2044 template <
typename document_view_iterator_type>
2047 document_view_iterator_type begin,
2048 document_view_iterator_type end,
2050 return _insert_many(&session, begin, end, options);
2053 MONGOCXX_INLINE_NAMESPACE_END
2056 #include <mongocxx/config/postlude.hpp>
change_stream watch(const client_session &session, const pipeline &pipe, const options::change_stream &options={})
Gets a change stream on this collection.
stdx::optional< result::update > update_many(bsoncxx::document::view_or_value filter, std::initializer_list< _empty_doc_tag > update, const options::update &options=options::update())
Updates multiple documents matching the provided filter in this collection.
stdx::optional< result::bulk_write > write(const model::write &write, const options::bulk_write &options=options::bulk_write())
Sends a write to the server as a bulk write operation.
Definition: collection.hpp:1962
stdx::optional< result::delete_result > delete_one(const client_session &session, bsoncxx::document::view_or_value filter, const options::delete_options &options=options::delete_options())
Deletes a single matching document from the collection.
stdx::optional< result::update > update_many(const client_session &session, bsoncxx::document::view_or_value filter, std::initializer_list< _empty_doc_tag > update, const options::update &options=options::update())
Updates multiple documents matching the provided filter in this collection.
void drop(const bsoncxx::stdx::optional< mongocxx::write_concern > &write_concern={})
Drops this collection and all its contained documents from the database.
Definition: change_stream.hpp:31
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
change_stream watch(const options::change_stream &options={})
Gets a change stream on this collection with an empty pipeline.
stdx::optional< result::update > update_one(const client_session &session, bsoncxx::document::view_or_value filter, std::initializer_list< _empty_doc_tag > update, const options::update &options=options::update())
Updates a single document matching the provided filter in this collection.
stdx::optional< result::insert_one > insert_one(bsoncxx::document::view_or_value document, const options::insert &options={})
Inserts a single document into the collection.
Class representing the optional arguments to a MongoDB aggregation operation.
Definition: aggregate.hpp:38
Class representing the optional arguments to a MongoDB insert operation.
Definition: insert.hpp:31
Class representing the optional arguments to mongocxx::collection::estimated_document_count.
Definition: estimated_document_count.hpp:32
Class representing the server-side requirement for reporting the success of a write operation.
Definition: write_concern.hpp:56
change_stream watch(const pipeline &pipe, const options::change_stream &options={})
Gets a change stream on this collection.
collection() noexcept
Default constructs a collection object.
cursor distinct(bsoncxx::string::view_or_value name, bsoncxx::document::view_or_value filter, const options::distinct &options=options::distinct())
Finds the distinct values for a specified field across the collection.
stdx::optional< result::replace_one > replace_one(bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value replacement, const options::replace &options=options::replace{})
Replaces a single document matching the provided filter in this collection.
Class representing the optional arguments to a MongoDB find_and_modify delete operation.
Definition: find_one_and_delete.hpp:34
change_stream watch(const client_session &session, const options::change_stream &options={})
stdx::string_view name() const
Returns the name of this collection.
index_view indexes()
Gets an index_view to the collection.
cursor list_indexes(const client_session &session) const
Returns a list of the indexes currently on this collection.
Class representing the optional arguments to a MongoDB distinct command.
Definition: distinct.hpp:34
stdx::optional< result::update > update_one(bsoncxx::document::view_or_value filter, std::initializer_list< _empty_doc_tag > update, const options::update &options=options::update())
Updates a single document matching the provided filter in this collection.
std::int64_t count_documents(const client_session &session, bsoncxx::document::view_or_value filter, const options::count &options=options::count())
Counts the number of documents matching the provided filter.
Class representing optional arguments to IndexView operations.
Definition: index_view.hpp:31
class write_concern write_concern() const
Gets the write_concern for the collection.
stdx::optional< bsoncxx::document::value > find_one(const client_session &session, bsoncxx::document::view_or_value filter, const options::find &options=options::find())
Finds a single document in this collection that match the provided filter.
A class to represent the read concern.
Definition: read_concern.hpp:54
stdx::optional< result::update > update_one(bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value update, const options::update &options=options::update())
Updates a single document matching the provided filter in this collection.
stdx::optional< result::delete_result > delete_many(bsoncxx::document::view_or_value filter, const options::delete_options &options=options::delete_options())
Deletes all matching documents from the collection.
stdx::optional< result::insert_many > insert_many(const container_type &container, const options::insert &options=options::insert())
Inserts multiple documents into the collection.
Definition: collection.hpp:2008
A read-only BSON document that owns its underlying buffer.
Definition: value.hpp:33
stdx::optional< bsoncxx::document::value > find_one_and_update(bsoncxx::document::view_or_value filter, const pipeline &update, const options::find_one_and_update &options=options::find_one_and_update())
Finds a single document matching the filter, updates it, and returns either the original or the newly...
class read_concern read_concern() const
Gets the read_concern for the collection.
Models a single write operation within a mongocxx::bulk_write.
Definition: write.hpp:37
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition: read_preference.hpp:62
std::int64_t count_documents(bsoncxx::document::view_or_value filter, const options::count &options=options::count())
Counts the number of documents matching the provided filter.
stdx::optional< bsoncxx::document::value > find_one_and_update(bsoncxx::document::view_or_value filter, std::initializer_list< _empty_doc_tag > update, const options::find_one_and_update &options=options::find_one_and_update())
Finds a single document matching the filter, updates it, and returns either the original or the newly...
Class representing a view-or-value variant type for strings.
Definition: view_or_value.hpp:36
Class representing the optional arguments to a MongoDB find_and_modify update operation.
Definition: find_one_and_update.hpp:37
stdx::optional< bsoncxx::document::value > find_one(bsoncxx::document::view_or_value filter, const options::find &options=options::find())
Finds a single document in this collection that match the provided filter.
stdx::optional< result::replace_one > replace_one(const client_session &session, bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value replacement, const options::replace &options=options::replace{})
Replaces a single document matching the provided filter in this collection.
stdx::optional< result::delete_result > delete_one(bsoncxx::document::view_or_value filter, const options::delete_options &options=options::delete_options())
Deletes a single matching document from the collection.
stdx::optional< result::delete_result > delete_many(const client_session &session, bsoncxx::document::view_or_value filter, const options::delete_options &options=options::delete_options())
Deletes all matching documents from the collection.
Class representing the optional arguments to a MongoDB query.
Definition: find.hpp:36
Definition: index_view.hpp:32
stdx::optional< result::update > update_many(bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value update, const options::update &options=options::update())
Updates multiple documents matching the provided filter in this collection.
stdx::optional< bsoncxx::document::value > find_one_and_replace(bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value replacement, const options::find_one_and_replace &options=options::find_one_and_replace())
Finds a single document matching the filter, replaces it, and returns either the original or the repl...
std::int64_t estimated_document_count(const options::estimated_document_count &options=options::estimated_document_count())
Returns an estimate of the number of documents in the collection.
stdx::optional< result::update > update_many(bsoncxx::document::view_or_value filter, const pipeline &update, const options::update &options=options::update())
Updates multiple documents matching the provided filter in this collection.
stdx::optional< bsoncxx::document::value > find_one_and_delete(bsoncxx::document::view_or_value filter, const options::find_one_and_delete &options=options::find_one_and_delete())
Finds a single document matching the filter, deletes it, and returns the original.
stdx::optional< result::update > update_one(const client_session &session, bsoncxx::document::view_or_value filter, const pipeline &update, const options::update &options=options::update())
Updates a single document matching the provided filter in this collection.
stdx::optional< result::insert_one > insert_one(const client_session &session, bsoncxx::document::view_or_value document, const options::insert &options={})
Inserts a single document into the collection.
Class representing the optional arguments to a MongoDB update operation.
Definition: update.hpp:33
void rename(const client_session &session, bsoncxx::string::view_or_value new_name, bool drop_target_before_rename=false, const bsoncxx::stdx::optional< write_concern > &write_concern={})
Rename this collection.
stdx::optional< bsoncxx::document::value > find_one_and_update(bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value update, const options::find_one_and_update &options=options::find_one_and_update())
Finds a single document matching the filter, updates it, and returns either the original or the newly...
Class representing a MongoDB aggregation pipeline.
Definition: pipeline.hpp:38
A traditional builder-style interface for constructing a BSON array.
Definition: array.hpp:35
Definition: change_stream.hpp:35
Use a session for a sequence of operations, optionally with causal consistency.
Definition: client_session.hpp:39
Class representing a batch of write operations that can be sent to the server as a group.
Definition: bulk_write.hpp:43
cursor find(const client_session &session, bsoncxx::document::view_or_value filter, const options::find &options=options::find())
Finds the documents in this collection which match the provided filter.
Class representing a MongoDB database.
Definition: database.hpp:43
cursor find(bsoncxx::document::view_or_value filter, const options::find &options=options::find())
Finds the documents in this collection which match the provided filter.
stdx::optional< result::update > update_many(const client_session &session, bsoncxx::document::view_or_value filter, const pipeline &update, const options::update &options=options::update())
Updates multiple documents matching the provided filter in this collection.
stdx::optional< result::update > update_one(bsoncxx::document::view_or_value filter, const pipeline &update, const options::update &options=options::update())
Updates a single document matching the provided filter in this collection.
stdx::optional< bsoncxx::document::value > find_one_and_update(const client_session &session, bsoncxx::document::view_or_value filter, std::initializer_list< _empty_doc_tag > update, const options::find_one_and_update &options=options::find_one_and_update())
Finds a single document matching the filter, updates it, and returns either the original or the newly...
stdx::optional< bsoncxx::document::value > find_one_and_update(const client_session &session, bsoncxx::document::view_or_value filter, const pipeline &update, const options::find_one_and_update &options=options::find_one_and_update())
Finds a single document matching the filter, updates it, and returns either the original or the newly...
stdx::optional< bsoncxx::document::value > find_one_and_delete(const client_session &session, bsoncxx::document::view_or_value filter, const options::find_one_and_delete &options=options::find_one_and_delete())
Finds a single document matching the filter, deletes it, and returns the original.
Class representing the optional arguments to a MongoDB delete operation.
Definition: delete.hpp:31
Class representing server side document groupings within a MongoDB database.
Definition: collection.hpp:83
Class representing a MongoDB update operation that replaces a single document.
Definition: replace_one.hpp:31
bsoncxx::document::value create_index(const client_session &session, bsoncxx::document::view_or_value keys, bsoncxx::document::view_or_value index_options={}, options::index_view operation_options=options::index_view{})
Creates an index over the collection for the provided keys with the provided options.
stdx::optional< result::update > update_one(const client_session &session, bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value update, const options::update &options=options::update())
Updates a single document matching the provided filter in this collection.
Class representing the optional arguments to a MongoDB replace operation.
Definition: replace.hpp:33
stdx::optional< bsoncxx::document::value > find_one_and_update(const client_session &session, bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value update, const options::find_one_and_update &options=options::find_one_and_update())
Finds a single document matching the filter, updates it, and returns either the original or the newly...
void drop(const client_session &session, const bsoncxx::stdx::optional< mongocxx::write_concern > &write_concern={})
Drops this collection and all its contained documents from the database.
Class representing the optional arguments to a MongoDB bulk write.
Definition: bulk_write.hpp:29
Class representing the optional arguments to a MongoDB find_and_modify replace operation.
Definition: find_one_and_replace.hpp:36
stdx::optional< result::update > update_many(const client_session &session, bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value update, const options::update &options=options::update())
Updates multiple documents matching the provided filter in this collection.
Class representing the optional arguments to mongocxx::collection::count_documents.
Definition: count.hpp:36
Class representing a pointer to the result set of a query on a MongoDB server.
Definition: cursor.hpp:36
class read_preference read_preference() const
Gets the read_preference for the collection.
cursor list_indexes() const
Returns a list of the indexes currently on this collection.
bsoncxx::document::value create_index(bsoncxx::document::view_or_value keys, bsoncxx::document::view_or_value index_options={}, options::index_view operation_options=options::index_view{})
Creates an index over the collection for the provided keys with the provided options.
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
cursor distinct(const client_session &session, bsoncxx::string::view_or_value name, bsoncxx::document::view_or_value filter, const options::distinct &options=options::distinct())
Finds the distinct values for a specified field across the collection.
void rename(bsoncxx::string::view_or_value new_name, bool drop_target_before_rename=false, const bsoncxx::stdx::optional< write_concern > &write_concern={})
Rename this collection.
stdx::optional< bsoncxx::document::value > find_one_and_replace(const client_session &session, bsoncxx::document::view_or_value filter, bsoncxx::document::view_or_value replacement, const options::find_one_and_replace &options=options::find_one_and_replace())
Finds a single document matching the filter, replaces it, and returns either the original or the repl...