Class representing a MongoDB search index view.
More...
#include <search_index_view.hpp>
Class representing a MongoDB search index view.
◆ create_many() [1/2]
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.
- Parameters
-
- Returns
- The names of the created indexes.
◆ create_many() [2/2]
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.
- Parameters
-
models | The search index models to create. |
- Returns
- The names of the created indexes.
◆ create_one() [1/6]
std::string mongocxx::v_noabi::search_index_view::create_one |
( |
bsoncxx::document::view_or_value |
definition | ) |
|
This is a convenience method for creating a single search index with a default name.
- Parameters
-
definition | The document describing the search index to be created. |
- Returns
- The name of the created search index.
◆ create_one() [2/6]
std::string mongocxx::v_noabi::search_index_view::create_one |
( |
bsoncxx::string::view_or_value |
name, |
|
|
bsoncxx::document::view_or_value |
definition |
|
) |
| |
This is a convenience method for creating a single search index.
- Parameters
-
name | The name of the search index to create. |
definition | The document describing the search index to be created. |
- Returns
- The name of the created search index.
◆ create_one() [3/6]
std::string mongocxx::v_noabi::search_index_view::create_one |
( |
const client_session & |
session, |
|
|
bsoncxx::document::view_or_value |
definition |
|
) |
| |
This is a convenience method for creating a single search index with a default name.
- Parameters
-
session | The mongocxx::client_session with which to perform the operation. |
definition | The document describing the search index to be created. |
- Returns
- The name of the created search index.
◆ create_one() [4/6]
std::string mongocxx::v_noabi::search_index_view::create_one |
( |
const client_session & |
session, |
|
|
bsoncxx::string::view_or_value |
name, |
|
|
bsoncxx::document::view_or_value |
definition |
|
) |
| |
This is a convenience method for creating a single search index.
- Parameters
-
session | The mongocxx::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. |
- Returns
- The name of the created search index.
◆ create_one() [5/6]
This is a convenience method for creating a single search index.
- Parameters
-
- Returns
- The name of the created index.
◆ create_one() [6/6]
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.
- Parameters
-
model | The search index model to create. |
- Returns
- The name of the created index.
◆ drop_one() [1/2]
void mongocxx::v_noabi::search_index_view::drop_one |
( |
bsoncxx::string::view_or_value |
name | ) |
|
Drops a single search index from the collection by the index name.
- Parameters
-
name | The name of the search index to drop. |
◆ drop_one() [2/2]
void mongocxx::v_noabi::search_index_view::drop_one |
( |
const client_session & |
session, |
|
|
bsoncxx::string::view_or_value |
name |
|
) |
| |
Drops a single search index from the collection by the index name.
- Parameters
-
◆ list() [1/4]
Returns a cursor over all the search indexes.
- Parameters
-
name | The name of the search index to find. |
options | Options included in the aggregate operation. |
- Returns
- A cursor to the list of the search indexes returned.
◆ list() [2/4]
Returns a cursor over all the search indexes.
- Parameters
-
session | The mongocxx::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. |
- Returns
- A cursor to the list of the search indexes returned.
◆ list() [3/4]
Returns a cursor over all the search indexes.
- Parameters
-
session | The mongocxx::client_session with which to perform the list operation. |
options | Options included in the aggregate operation. |
- Returns
- A cursor to the list of the search indexes returned.
◆ list() [4/4]
Returns a cursor over all the search indexes.
- Parameters
-
options | Options included in the aggregate operation. |
- Returns
- A cursor to the list of the search indexes returned.
◆ update_one() [1/2]
void mongocxx::v_noabi::search_index_view::update_one |
( |
bsoncxx::string::view_or_value |
name, |
|
|
bsoncxx::document::view_or_value |
definition |
|
) |
| |
Updates a single search index from the collection by the search index name.
- Parameters
-
name | The name of the search index to update. |
definition | The definition to update the search index to. |
◆ update_one() [2/2]
void mongocxx::v_noabi::search_index_view::update_one |
( |
const client_session & |
session, |
|
|
bsoncxx::string::view_or_value |
name, |
|
|
bsoncxx::document::view_or_value |
definition |
|
) |
| |
Updates a single search index from the collection by the search index name.
- Parameters
-
session | The mongocxx::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. |
The documentation for this class was generated from the following file: