MongoDB C++ Driver 4.1.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
search_index_view.hpp
Go to the documentation of this file.
1#pragma once
2
3#include <string>
4#include <vector>
5
8
11
12#include <mongocxx/cursor.hpp>
15
17
18namespace mongocxx {
19namespace v_noabi {
20
26class search_index_view {
27 public:
28 MONGOCXX_ABI_EXPORT_CDECL() search_index_view(search_index_view&&) noexcept;
29 MONGOCXX_ABI_EXPORT_CDECL(search_index_view&) operator=(search_index_view&&) noexcept;
30
31 MONGOCXX_ABI_EXPORT_CDECL() search_index_view(search_index_view const&);
32 MONGOCXX_ABI_EXPORT_CDECL(search_index_view&) operator=(search_index_view const&);
33
34 MONGOCXX_ABI_EXPORT_CDECL() ~search_index_view();
35
45 list(options::aggregate const& options = options::aggregate());
46
58 list(client_session const& session, options::aggregate const& options = options::aggregate());
59
71 list(bsoncxx::v_noabi::string::view_or_value name, options::aggregate const& options = options::aggregate());
72
87 client_session const& session,
88 bsoncxx::v_noabi::string::view_or_value name,
89 options::aggregate const& options = options::aggregate());
90
99 MONGOCXX_ABI_EXPORT_CDECL(std::string)
100 create_one(bsoncxx::v_noabi::document::view_or_value definition);
101
112 MONGOCXX_ABI_EXPORT_CDECL(std::string)
113 create_one(client_session const& session, bsoncxx::v_noabi::document::view_or_value definition);
114
125 MONGOCXX_ABI_EXPORT_CDECL(std::string)
126 create_one(bsoncxx::v_noabi::string::view_or_value name, bsoncxx::v_noabi::document::view_or_value definition);
127
140 MONGOCXX_ABI_EXPORT_CDECL(std::string)
142 client_session const& session,
143 bsoncxx::v_noabi::string::view_or_value name,
144 bsoncxx::v_noabi::document::view_or_value definition);
145
155
166 MONGOCXX_ABI_EXPORT_CDECL(std::string)
168
177 MONGOCXX_ABI_EXPORT_CDECL(std::vector<std::string>)
178 create_many(std::vector<search_index_model> const& models);
179
190 MONGOCXX_ABI_EXPORT_CDECL(std::vector<std::string>)
191 create_many(client_session const& session, std::vector<search_index_model> const& models);
192
199 MONGOCXX_ABI_EXPORT_CDECL(void) drop_one(bsoncxx::v_noabi::string::view_or_value name);
200
210 drop_one(client_session const& session, bsoncxx::v_noabi::string::view_or_value name);
211
221 update_one(bsoncxx::v_noabi::string::view_or_value name, bsoncxx::v_noabi::document::view_or_value definition);
222
235 client_session const& session,
236 bsoncxx::v_noabi::string::view_or_value name,
237 bsoncxx::v_noabi::document::view_or_value definition);
238
239 private:
240 friend ::mongocxx::v_noabi::collection;
241
242 class impl;
243
244 search_index_view(void* coll, void* client);
245
246 std::vector<std::string> _create_many_helper(bsoncxx::v_noabi::array::view created_indexes);
247
248 impl const& _get_impl() const;
249
250 impl& _get_impl();
251
252 private:
253 std::unique_ptr<impl> _impl;
254};
255
256} // namespace v_noabi
257} // namespace mongocxx
258
259#include <mongocxx/config/postlude.hpp>
260
Provides mongocxx::v_noabi::options::aggregate.
Supports MongoDB client session operations.
Definition client_session.hpp:50
A client connection to a MongoDB server.
Definition client.hpp:61
A MongoDB collection.
Definition collection.hpp:87
A cursor over the documents returned by a query to a MongoDB server.
Definition cursor.hpp:42
Used by mongocxx::v_noabi::search_index_view.
Definition search_index_model.hpp:20
std::vector< std::string > create_many(std::vector< search_index_model > const &models)
Creates multiple search indexes in the collection.
void drop_one(bsoncxx::v_noabi::string::view_or_value name)
Drops a single search index from the collection by the index name.
cursor list(options::aggregate const &options=options::aggregate())
Returns a cursor over all the search indexes.
std::string create_one(bsoncxx::v_noabi::document::view_or_value definition)
This is a convenience method for creating a single search index with a default name.
void update_one(bsoncxx::v_noabi::string::view_or_value name, bsoncxx::v_noabi::document::view_or_value definition)
Updates a single search index from the collection by the search index name.
Declares mongocxx::v_noabi::collection.
Provides mongocxx::v_noabi::cursor.
Provides bsoncxx::v_noabi::document::view_or_value.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
The mongocxx v_noabi macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
Declares entities representing bulk write operations.
Declares entities representing options to use with various commands.
Declares entities whose ABI stability is NOT guaranteed.
The top-level namespace within which all mongocxx library entities are declared.
Provides mongocxx::v_noabi::search_index_model.
Declares mongocxx::v_noabi::search_index_view.
Provides std::optional-related polyfills for library API usage.