mongocxx::v_noabi::search_index_view Class Reference

#include <mongocxx/v_noabi/mongocxx/search_index_view.hpp>

Description

Class representing a MongoDB search index view.

Public Member Functions
std::vector< std::string >	create_many (const client_session &session, const std::vector< search_index_model > &models)
	Creates multiple search indexes in the collection.
std::vector< std::string >	create_many (const std::vector< search_index_model > &models)
	Creates multiple search indexes in the collection.
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.
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.
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.
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.
std::string	create_one (const client_session &session, const search_index_model &model)
	This is a convenience method for creating a single search index.
std::string	create_one (const search_index_model &model)
	This is a convenience method for creating a single search index.
void	drop_one (bsoncxx::v_noabi::string::view_or_value name)
	Drops a single search index from the collection by the index name.
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.
cursor	list (bsoncxx::v_noabi::string::view_or_value name, const options::aggregate &options=options::aggregate())
	Returns a cursor over all the search indexes.
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.
cursor	list (const client_session &session, const options::aggregate &options=options::aggregate())
	Returns a cursor over all the search indexes.
cursor	list (const options::aggregate &options=options::aggregate())
	Returns a cursor over all the search indexes.
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.
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.

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

session	The mongocxx::v_noabi::client_session with which to perform the operation.
models	The 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

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::v_noabi::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::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

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::v_noabi::document::view_or_value	definition )

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

Parameters

session	The mongocxx::v_noabi::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::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

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.

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

session	The mongocxx::v_noabi::client_session with which to perform the operation.
model	The 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

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

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

Parameters

session	The mongocxx::v_noabi::client_session with which to perform the operation.
name	The 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

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]

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

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.

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

session	The mongocxx::v_noabi::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]

cursor mongocxx::v_noabi::search_index_view::list

(

const options::aggregate &

options = options::aggregate()

)

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

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

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.

---

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

• mongocxx/v_noabi/mongocxx/search_index_view.hpp