query_index_manager Class Reference

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

#include <couchbase/query_index_manager.hxx>

Public Member Functions
void	get_all_indexes (const std::string &bucket_name, const get_all_query_indexes_options &options, get_all_query_indexes_handler &&handler) const
	Get all indexes within a bucket.
auto	get_all_indexes (const std::string &bucket_name, const get_all_query_indexes_options &options) const -> std::future< std::pair< error, std::vector< management::query_index > > >
	Get all indexes within a bucket.
void	create_index (const std::string &bucket_name, 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 a bucket.
auto	create_index (const std::string &bucket_name, std::string index_name, std::vector< std::string > keys, const create_query_index_options &options) const -> std::future< error >
	Create an index on a bucket.
void	create_primary_index (const std::string &bucket_name, const create_primary_query_index_options &options, create_primary_query_index_handler &&handler) const
	Create a primary index on a bucket.
auto	create_primary_index (const std::string &bucket_name, const create_primary_query_index_options &options) const -> std::future< error >
	Create a primary index on a bucket.
void	drop_primary_index (const std::string &bucket_name, const drop_primary_query_index_options &options, drop_primary_query_index_handler &&handler) const
	Drop primary index on a bucket.
auto	drop_primary_index (const std::string &bucket_name, const drop_primary_query_index_options &options) const -> std::future< error >
	Drop primary index on a bucket.
void	drop_index (const std::string &bucket_name, std::string index_name, const drop_query_index_options &options, drop_query_index_handler &&handler) const
	Drop specified query index.
auto	drop_index (const std::string &bucket_name, std::string index_name, const drop_query_index_options &options) const -> std::future< error >
	Drop specified query index.
void	build_deferred_indexes (const std::string &bucket_name, const build_query_index_options &options, build_deferred_query_indexes_handler &&handler) const
	Builds all currently deferred indexes.
auto	build_deferred_indexes (const std::string &bucket_name, const build_query_index_options &options) const -> std::future< error >
	Builds all currently deferred indexes.
void	watch_indexes (const std::string &bucket_name, 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 (const std::string &bucket_name, 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	cluster

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 std::string &	bucket_name,
		const build_query_index_options &	options ) const -> std::future< error >

Builds all currently deferred indexes.

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

Parameters

bucket_name	name of the bucket
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 std::string &	bucket_name,
		const build_query_index_options &	options,
		build_deferred_query_indexes_handler &&	handler ) const

Builds all currently deferred indexes.

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

Parameters

bucket_name	name of the bucket
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	(	const std::string &	bucket_name,
		std::string	index_name,
		std::vector< std::string >	keys,
		const create_query_index_options &	options ) const -> std::future< error >

Create an index on a bucket.

Parameters

bucket_name	specifies the bucket in which to create the index
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	(	const std::string &	bucket_name,
		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 a bucket.

Parameters

bucket_name	specifies the bucket in which to create the index
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 std::string &	bucket_name,
		const create_primary_query_index_options &	options ) const -> std::future< error >

Create a primary index on a bucket.

Parameters

bucket_name	specifies the bucket in which to create the index
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 std::string &	bucket_name,
		const create_primary_query_index_options &	options,
		create_primary_query_index_handler &&	handler ) const

Create a primary index on a bucket.

Parameters

bucket_name	specifies the bucket in which to create the index
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	(	const std::string &	bucket_name,
		std::string	index_name,
		const drop_query_index_options &	options ) const -> std::future< error >

Drop specified query index.

Parameters

bucket_name	name of the bucket in which to drop the index
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	(	const std::string &	bucket_name,
		std::string	index_name,
		const drop_query_index_options &	options,
		drop_query_index_handler &&	handler ) const

Drop specified query index.

Parameters

bucket_name	name of the bucket in which to drop the index
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 std::string &	bucket_name,
		const drop_primary_query_index_options &	options ) const -> std::future< error >

Drop primary index on a bucket.

Parameters

bucket_name	name of the bucket in which to drop the primary index
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 std::string &	bucket_name,
		const drop_primary_query_index_options &	options,
		drop_primary_query_index_handler &&	handler ) const

Drop primary index on a bucket.

Parameters

bucket_name	name of the bucket in which to drop the primary index
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 std::string &	bucket_name,
		const get_all_query_indexes_options &	options ) const -> std::future< std::pair< error, std::vector< management::query_index > > >

Get all indexes within a bucket.

Parameters

bucket_name	specifies the bucket in which we look for the indexes
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 std::string &	bucket_name,
		const get_all_query_indexes_options &	options,
		get_all_query_indexes_handler &&	handler ) const

Get all indexes within a bucket.

Parameters

bucket_name	specifies the bucket in which we look for the indexes
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	(	const std::string &	bucket_name,
		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.

Parameters

bucket_name	name of the bucket in which to look for the indexes
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	(	const std::string &	bucket_name,
		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

bucket_name	name of the bucket in which to look for the indexes
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

cluster

friend class cluster

friend

---

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

• couchbase/query_index_manager.hxx