MongoDB C++ Driver
mongocxx-3.10.2
|
Class representing a MongoDB search index view. More...
#include <search_index_view.hpp>
Public Member Functions | |
cursor | list (const options::aggregate &options=options::aggregate()) |
Returns a cursor over all the search indexes. More... | |
cursor | list (const client_session &session, const options::aggregate &options=options::aggregate()) |
Returns a cursor over all the search indexes. More... | |
cursor | list (bsoncxx::v_noabi::string::view_or_value name, const options::aggregate &options=options::aggregate()) |
Returns a cursor over all the search indexes. More... | |
cursor | list (const client_session &session, bsoncxx::v_noabi::string::view_or_value name, const options::aggregate &options=options::aggregate()) |
Returns a cursor over all the search indexes. More... | |
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. More... | |
std::string | create_one (const client_session &session, bsoncxx::v_noabi::document::view_or_value definition) |
This is a convenience method for creating a single search index with a default name. More... | |
std::string | create_one (bsoncxx::v_noabi::string::view_or_value name, bsoncxx::v_noabi::document::view_or_value definition) |
This is a convenience method for creating a single search index. More... | |
std::string | create_one (const client_session &session, bsoncxx::v_noabi::string::view_or_value name, bsoncxx::v_noabi::document::view_or_value definition) |
This is a convenience method for creating a single search index. More... | |
std::string | create_one (const search_index_model &model) |
This is a convenience method for creating a single search index. More... | |
std::string | create_one (const client_session &session, const search_index_model &model) |
This is a convenience method for creating a single search index. More... | |
std::vector< std::string > | create_many (const std::vector< search_index_model > &models) |
Creates multiple search indexes in the collection. More... | |
std::vector< std::string > | create_many (const client_session &session, const std::vector< search_index_model > &models) |
Creates multiple search indexes in the collection. More... | |
void | drop_one (bsoncxx::v_noabi::string::view_or_value name) |
Drops a single search index from the collection by the index name. More... | |
void | drop_one (const client_session &session, bsoncxx::v_noabi::string::view_or_value name) |
Drops a single search index from the collection by the index name. More... | |
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. More... | |
void | update_one (const client_session &session, 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. More... | |
Class representing a MongoDB search index view.
std::vector<std::string> mongocxx::v_noabi::search_index_view::create_many | ( | const client_session & | session, |
const std::vector< search_index_model > & | models | ||
) |
Creates multiple search indexes in the collection.
session | The mongocxx::v_noabi::client_session with which to perform the operation. |
models | The search index models to create. |
std::vector<std::string> mongocxx::v_noabi::search_index_view::create_many | ( | const std::vector< search_index_model > & | models | ) |
Creates multiple search indexes in the collection.
models | The search index models to create. |
std::string mongocxx::v_noabi::search_index_view::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.
definition | The document describing the search index to be created. |
std::string mongocxx::v_noabi::search_index_view::create_one | ( | bsoncxx::v_noabi::string::view_or_value | name, |
bsoncxx::v_noabi::document::view_or_value | definition | ||
) |
This is a convenience method for creating a single search index.
name | The name of the search index to create. |
definition | The document describing the search index to be created. |
std::string mongocxx::v_noabi::search_index_view::create_one | ( | const client_session & | session, |
bsoncxx::v_noabi::document::view_or_value | definition | ||
) |
This is a convenience method for creating a single search index with a default name.
session | The mongocxx::v_noabi::client_session with which to perform the operation. |
definition | The document describing the search index to be created. |
std::string mongocxx::v_noabi::search_index_view::create_one | ( | const client_session & | session, |
bsoncxx::v_noabi::string::view_or_value | name, | ||
bsoncxx::v_noabi::document::view_or_value | definition | ||
) |
This is a convenience method for creating a single search index.
session | The mongocxx::v_noabi::client_session with which to perform the operation. |
name | The name of the search index to create. |
definition | The document describing the search index to be created. |
std::string mongocxx::v_noabi::search_index_view::create_one | ( | const client_session & | session, |
const search_index_model & | model | ||
) |
This is a convenience method for creating a single search index.
session | The mongocxx::v_noabi::client_session with which to perform the operation. |
model | The search index model to create. |
std::string mongocxx::v_noabi::search_index_view::create_one | ( | const search_index_model & | model | ) |
This is a convenience method for creating a single search index.
model | The search index model to create. |
void mongocxx::v_noabi::search_index_view::drop_one | ( | bsoncxx::v_noabi::string::view_or_value | name | ) |
Drops a single search index from the collection by the index name.
name | The name of the search index to drop. |
void mongocxx::v_noabi::search_index_view::drop_one | ( | const client_session & | session, |
bsoncxx::v_noabi::string::view_or_value | name | ||
) |
Drops a single search index from the collection by the index name.
session | The mongocxx::v_noabi::client_session with which to perform the operation. |
name | The name of the search index to drop. |
cursor mongocxx::v_noabi::search_index_view::list | ( | bsoncxx::v_noabi::string::view_or_value | name, |
const options::aggregate & | options = options::aggregate() |
||
) |
Returns a cursor over all the search indexes.
name | The name of the search index to find. |
options | Options included in the aggregate operation. |
cursor mongocxx::v_noabi::search_index_view::list | ( | const client_session & | session, |
bsoncxx::v_noabi::string::view_or_value | name, | ||
const options::aggregate & | options = options::aggregate() |
||
) |
Returns a cursor over all the search indexes.
session | The mongocxx::v_noabi::client_session with which to perform the list operation. |
name | The name of the search index to find. |
options | Options included in the aggregate operation. |
cursor mongocxx::v_noabi::search_index_view::list | ( | const client_session & | session, |
const options::aggregate & | options = options::aggregate() |
||
) |
Returns a cursor over all the search indexes.
session | The mongocxx::v_noabi::client_session with which to perform the list operation. |
options | Options included in the aggregate operation. |
cursor mongocxx::v_noabi::search_index_view::list | ( | const options::aggregate & | options = options::aggregate() | ) |
Returns a cursor over all the search indexes.
options | Options included in the aggregate operation. |
void mongocxx::v_noabi::search_index_view::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.
name | The name of the search index to update. |
definition | The definition to update the search index to. |
void mongocxx::v_noabi::search_index_view::update_one | ( | const client_session & | session, |
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.
session | The mongocxx::v_noabi::client_session with which to perform the operation. |
name | The name of the search index to update. |
definition | The definition to update the search index to. |