The Query Index Manager interface contains the means for managing indexes used for queries. More...

#include <couchbase/collection_query_index_manager.hxx>

Public Member Functions
void	get_all_indexes (const get_all_query_indexes_options &options, get_all_query_indexes_handler &&handler) const
	Get all indexes within the collection.

auto	get_all_indexes (const get_all_query_indexes_options &options) const -> std::future< std::pair< error, std::vector< couchbase::management::query_index > > >
	Get all indexes within the collection.

void	create_index (std::string index_name, std::vector< std::string > keys, const create_query_index_options &options, create_query_index_handler &&handler) const
	Create an index on the collection.

auto	create_index (std::string index_name, std::vector< std::string > keys, const create_query_index_options &options) const -> std::future< error >
	Create an index on the collection.

void	create_primary_index (const create_primary_query_index_options &options, create_primary_query_index_handler &&handler) const
	Create a primary index on the collection.

auto	create_primary_index (const create_primary_query_index_options &options) const -> std::future< error >
	Create a primary index on the collection.

void	drop_primary_index (const drop_primary_query_index_options &options, drop_primary_query_index_handler &&handler) const
	Drop primary index on the collection.

auto	drop_primary_index (const drop_primary_query_index_options &options) const -> std::future< error >
	Drop primary index on the collection.

void	drop_index (std::string index_name, const drop_query_index_options &options, drop_query_index_handler &&handler) const
	Drop specified query index in the collection.

auto	drop_index (std::string index_name, const drop_query_index_options &options) const -> std::future< error >
	Drop specified query index in the collection.

void	build_deferred_indexes (const build_query_index_options &options, build_deferred_query_indexes_handler &&handler) const
	Builds all currently deferred indexes in this collection.

auto	build_deferred_indexes (const build_query_index_options &options) const -> std::future< error >
	Builds all currently deferred indexes in this collection.

void	watch_indexes (std::vector< std::string > index_names, const watch_query_indexes_options &options, watch_query_indexes_handler &&handler) const
	Polls the state of a set of indexes, until they all are online.

auto	watch_indexes (std::vector< std::string > index_names, const watch_query_indexes_options &options) const -> std::future< error >
	Polls the state of a set of indexes, until they all are online.

Friends
class	collection

Detailed Description

The Query Index Manager interface contains the means for managing indexes used for queries.

Since: 1.0.0

Committed: Generally available API and should be preferred in production

Member Function Documentation

◆ build_deferred_indexes() [1/2]

auto build_deferred_indexes ( const build_query_index_options & options ) const -> std::future< error >

nodiscard

Builds all currently deferred indexes in this collection.

By default, this method will build the indexes on the collection.

Parameters

options optional parameters

Returns: future object that carries result of the operation

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ build_deferred_indexes() [2/2]

void build_deferred_indexes	(	const build_query_index_options &	options,
		build_deferred_query_indexes_handler &&	handler ) const

Builds all currently deferred indexes in this collection.

By default, this method will build the indexes on the collection.

Parameters

options	optional parameters
handler	the handler that implements build_deferred_query_indexes_handler

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ create_index() [1/2]

auto create_index	(	std::string	index_name,
		std::vector< std::string >	keys,
		const create_query_index_options &	options ) const -> std::future< error >

nodiscard

Create an index on the collection.

Parameters

index_name	name of the index
keys	the keys to create the index over
options	optional parameters

Returns: future object that carries result of the operation

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ create_index() [2/2]

void create_index	(	std::string	index_name,
		std::vector< std::string >	keys,
		const create_query_index_options &	options,
		create_query_index_handler &&	handler ) const

Create an index on the collection.

Parameters

index_name	name of the index
keys	the keys to create the index over
options	optional parameters
handler	the handler that implements create_query_index_handler

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ create_primary_index() [1/2]

auto create_primary_index ( const create_primary_query_index_options & options ) const -> std::future< error >

nodiscard

Create a primary index on the collection.

Parameters

options optional parameters

Returns: future object that carries result of the operation

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ create_primary_index() [2/2]

void create_primary_index	(	const create_primary_query_index_options &	options,
		create_primary_query_index_handler &&	handler ) const

Create a primary index on the collection.

Parameters

options	optional parameters
handler	the handler that implements create_query_index_handler

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ drop_index() [1/2]

auto drop_index	(	std::string	index_name,
		const drop_query_index_options &	options ) const -> std::future< error >

nodiscard

Drop specified query index in the collection.

Parameters

index_name	name of the index to drop
options	optional parameters

Returns: future object that carries result of the operation

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ drop_index() [2/2]

void drop_index	(	std::string	index_name,
		const drop_query_index_options &	options,
		drop_query_index_handler &&	handler ) const

Drop specified query index in the collection.

Parameters

index_name	name of the index to drop
options	optional parameters
handler	handler that implements drop_query_index_handler

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ drop_primary_index() [1/2]

auto drop_primary_index ( const drop_primary_query_index_options & options ) const -> std::future< error >

nodiscard

Drop primary index on the collection.

Parameters

options optional parameters

Returns: future object that carries result of the operation

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ drop_primary_index() [2/2]

void drop_primary_index	(	const drop_primary_query_index_options &	options,
		drop_primary_query_index_handler &&	handler ) const

Drop primary index on the collection.

Parameters

options	optional parameters
handler	the handler that implements drop_query_index_handler

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ get_all_indexes() [1/2]

auto get_all_indexes ( const get_all_query_indexes_options & options ) const -> std::future< std::pair< error, std::vector< couchbase::management::query_index > > >

nodiscard

Get all indexes within the collection.

Parameters

options optional parameters

Returns: future object that carries result of the operation

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ get_all_indexes() [2/2]

void get_all_indexes	(	const get_all_query_indexes_options &	options,
		get_all_query_indexes_handler &&	handler ) const

Get all indexes within the collection.

Parameters

options	optional parameters
handler	the handler that implements get_all_query_indexes_handler

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ watch_indexes() [1/2]

auto watch_indexes	(	std::vector< std::string >	index_names,
		const watch_query_indexes_options &	options ) const -> std::future< error >

nodiscard

Polls the state of a set of indexes, until they all are online.

Parameters

index_names	names of the indexes to watch
options	optional parameters

Returns: future object that carries result of the operation

Since: 1.0.0

Committed: Generally available API and should be preferred in production

◆ watch_indexes() [2/2]

void watch_indexes	(	std::vector< std::string >	index_names,
		const watch_query_indexes_options &	options,
		watch_query_indexes_handler &&	handler ) const

Polls the state of a set of indexes, until they all are online.

Parameters

index_names	names of the indexes to watch
options	optional parameters
handler	handler that implements watch_query_indexes_handler

Since: 1.0.0

Committed: Generally available API and should be preferred in production

Friends And Related Symbol Documentation

◆ collection

friend class collection

friend

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

couchbase/collection_query_index_manager.hxx

Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ build_deferred_indexes() [1/2]

◆ build_deferred_indexes() [2/2]

◆ create_index() [1/2]

◆ create_index() [2/2]

◆ create_primary_index() [1/2]

◆ create_primary_index() [2/2]

◆ drop_index() [1/2]

◆ drop_index() [2/2]

◆ drop_primary_index() [1/2]

◆ drop_primary_index() [2/2]

◆ get_all_indexes() [1/2]

◆ get_all_indexes() [2/2]

◆ watch_indexes() [1/2]

◆ watch_indexes() [2/2]

Friends And Related Symbol Documentation

◆ collection