MongoDB C++ Driver  mongocxx-3.10.2
List of all members
mongocxx::v_noabi::search_index_view Class Reference

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...
 

Detailed Description

Class representing a MongoDB search index view.

Member Function Documentation

◆ 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
sessionThe mongocxx::v_noabi::client_session with which to perform the operation.
modelsThe search index models to create.
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
modelsThe 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::v_noabi::document::view_or_value  definition)

This is a convenience method for creating a single search index with a default name.

Parameters
definitionThe 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::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.

Parameters
nameThe name of the search index to create.
definitionThe 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::v_noabi::document::view_or_value  definition 
)

This is a convenience method for creating a single search index with a default name.

Parameters
sessionThe mongocxx::v_noabi::client_session with which to perform the operation.
definitionThe 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::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.

Parameters
sessionThe mongocxx::v_noabi::client_session with which to perform the operation.
nameThe name of the search index to create.
definitionThe document describing the search index to be created.
Returns
The name of the created search index.

◆ create_one() [5/6]

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.

Parameters
sessionThe mongocxx::v_noabi::client_session with which to perform the operation.
modelThe search index model to create.
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
modelThe 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::v_noabi::string::view_or_value  name)

Drops a single search index from the collection by the index name.

Parameters
nameThe 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::v_noabi::string::view_or_value  name 
)

Drops a single search index from the collection by the index name.

Parameters
sessionThe mongocxx::v_noabi::client_session with which to perform the operation.
nameThe name of the search index to drop.

◆ list() [1/4]

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.

Parameters
nameThe name of the search index to find.
optionsOptions included in the aggregate operation.
Returns
A cursor to the list of the search indexes returned.

◆ list() [2/4]

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.

Parameters
sessionThe mongocxx::v_noabi::client_session with which to perform the list operation.
nameThe name of the search index to find.
optionsOptions included in the aggregate operation.
Returns
A cursor to the list of the search indexes returned.

◆ list() [3/4]

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.

Parameters
sessionThe mongocxx::v_noabi::client_session with which to perform the list operation.
optionsOptions included in the aggregate operation.
Returns
A cursor to the list of the search indexes returned.

◆ list() [4/4]

cursor mongocxx::v_noabi::search_index_view::list ( const options::aggregate options = options::aggregate())

Returns a cursor over all the search indexes.

Parameters
optionsOptions 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::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.

Parameters
nameThe name of the search index to update.
definitionThe 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::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.

Parameters
sessionThe mongocxx::v_noabi::client_session with which to perform the operation.
nameThe name of the search index to update.
definitionThe definition to update the search index to.

The documentation for this class was generated from the following file: