analytics_index_manager Class Reference

#include <couchbase/analytics_index_manager.hxx>

Public Member Functions
void	create_dataverse (const std::string &dataverse_name, const create_dataverse_analytics_options &options, create_dataverse_analytics_handler &&handler) const
	Creates a new dataset (analytics scope).
auto	create_dataverse (const std::string &dataverse_name, const create_dataverse_analytics_options &options) const -> std::future< error >
	Creates a new dataset (analytics scope).
void	drop_dataverse (const std::string &dataverse_name, const drop_dataverse_analytics_options &options, drop_dataverse_analytics_handler &&handler) const
	Drops (deletes) a dataverse.
auto	drop_dataverse (const std::string &dataverse_name, const drop_dataverse_analytics_options &options) const -> std::future< error >
	Drops (deletes) a dataverse.
void	create_dataset (const std::string &dataset_name, const std::string &bucket_name, const create_dataset_analytics_options &options, create_dataset_analytics_handler &&handler) const
	Creates a new dataset (analytics collection).
auto	create_dataset (const std::string &dataset_name, const std::string &bucket_name, const create_dataset_analytics_options &options) const -> std::future< error >
	Creates a new dataset (analytics collection).
void	drop_dataset (const std::string &dataset_name, const drop_dataset_analytics_options &options, drop_dataset_analytics_handler &&handler) const
	Drops (deletes) a dataset.
auto	drop_dataset (const std::string &dataset_name, const drop_dataset_analytics_options &options) const -> std::future< error >
	Drops (deletes) a dataset.
void	get_all_datasets (const get_all_datasets_analytics_options &options, get_all_datasets_analytics_handler &&handler) const
	Fetches all datasets (analytics collections) from the analytics service.
auto	get_all_datasets (const get_all_datasets_analytics_options &options) const -> std::future< std::pair< error, std::vector< management::analytics_dataset > > >
	Fetches all datasets (analytics collections) from the analytics service.
void	create_index (const std::string &index_name, const std::string &dataset_name, const std::map< std::string, std::string > &fields, const create_index_analytics_options &options, create_index_analytics_handler &&handler) const
	Creates a new analytics index.
auto	create_index (const std::string &index_name, const std::string &dataset_name, const std::map< std::string, std::string > &fields, const create_index_analytics_options &options) const -> std::future< error >
	Creates a new analytics index.
void	drop_index (const std::string &index_name, const std::string &dataset_name, const drop_index_analytics_options &options, drop_index_analytics_handler &&handler) const
	Drops (removes) an analytics index.
auto	drop_index (const std::string &index_name, const std::string &dataset_name, const drop_index_analytics_options &options) const -> std::future< error >
	Drops (removes) an analytics index.
void	get_all_indexes (const get_all_indexes_analytics_options &options, get_all_indexes_analytics_handler &&handler) const
	Fetches all analytics indexes.
auto	get_all_indexes (const get_all_indexes_analytics_options &options) const -> std::future< std::pair< error, std::vector< management::analytics_index > > >
	Fetches all analytics indexes.
void	connect_link (const connect_link_analytics_options &options, connect_link_analytics_handler &&handler) const
	Connects a not yet connected link.
auto	connect_link (const connect_link_analytics_options &options) const -> std::future< error >
	Connects a not yet connected link.
void	disconnect_link (const disconnect_link_analytics_options &options, disconnect_link_analytics_handler &&handler) const
	Disconnects a currently connected link.
auto	disconnect_link (const disconnect_link_analytics_options &options) const -> std::future< error >
	Disconnects a currently connected link.
void	get_pending_mutations (const get_pending_mutations_analytics_options &options, get_pending_mutations_analytics_handler &&handler) const
	Returns the pending mutations for different dataverses.
auto	get_pending_mutations (const get_pending_mutations_analytics_options &options) const -> std::future< std::pair< error, std::map< std::string, std::map< std::string, std::int64_t > > > >
	Returns the pending mutations for different dataverses.
void	create_link (const management::analytics_link &link, const create_link_analytics_options &options, create_link_analytics_handler &&handler) const
	Creates a new analytics remote link.
auto	create_link (const management::analytics_link &link, const create_link_analytics_options &options) const -> std::future< error >
	Creates a new analytics remote link.
void	replace_link (const management::analytics_link &link, const replace_link_analytics_options &options, replace_link_analytics_handler &&handler) const
	Replaces an existing analytics remote link.
auto	replace_link (const management::analytics_link &link, const replace_link_analytics_options &options) const -> std::future< error >
	Replaces an existing analytics remote link.
void	drop_link (const std::string &link_name, const std::string &dataverse_name, const drop_link_analytics_options &options, drop_link_analytics_handler &&handler) const
	Drops an existing analytics remote link.
auto	drop_link (const std::string &link_name, const std::string &dataverse_name, const drop_link_analytics_options &options) const -> std::future< error >
	Drops an existing analytics remote link.
void	get_links (const get_links_analytics_options &options, get_links_analytics_handler &&handler) const
	Fetches the existing analytics remote links.
auto	get_links (const get_links_analytics_options &options) const -> std::future< std::pair< error, std::vector< std::unique_ptr< management::analytics_link > > > >
	Fetches the existing analytics remote links.

Friends
class	cluster

Member Function Documentation

connect_link() [1/2]

auto connect_link ( const connect_link_analytics_options & options ) const -> std::future< error >

nodiscard

Connects a not yet connected link.

Parameters

options

optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

connect_link() [2/2]

void connect_link	(	const connect_link_analytics_options &	options,
		connect_link_analytics_handler &&	handler ) const

Connects a not yet connected link.

Parameters

options	optional parameters
handler	the handler that implements connect_link_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

create_dataset() [1/2]

auto create_dataset ( const std::string & dataset_name, const std::string & bucket_name, const create_dataset_analytics_options & options ) const -> std::future< error >

nodiscard

Creates a new dataset (analytics collection).

Parameters

dataset_name	the name of the dataset to create
bucket_name	the name of the bucket where the dataset should be stored into
options	optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

create_dataset() [2/2]

void create_dataset	(	const std::string &	dataset_name,
		const std::string &	bucket_name,
		const create_dataset_analytics_options &	options,
		create_dataset_analytics_handler &&	handler ) const

Creates a new dataset (analytics collection).

Parameters

dataset_name	the name of the dataset to create
bucket_name	the name of the bucket where the dataset should be stored into
options	optional parameters
handler	the handler that implements create_dataset_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

create_dataverse() [1/2]

auto create_dataverse ( const std::string & dataverse_name, const create_dataverse_analytics_options & options ) const -> std::future< error >

nodiscard

Creates a new dataset (analytics scope).

Parameters

dataverse_name	the name of the dataverse to create
options	optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

create_dataverse() [2/2]

void create_dataverse	(	const std::string &	dataverse_name,
		const create_dataverse_analytics_options &	options,
		create_dataverse_analytics_handler &&	handler ) const

Creates a new dataset (analytics scope).

Parameters

dataverse_name	the name of the dataverse to create
options	optional parameters
handler	the handler that implements create_dataverse_analytics_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 & index_name, const std::string & dataset_name, const std::map< std::string, std::string > & fields, const create_index_analytics_options & options ) const -> std::future< error >

nodiscard

Creates a new analytics index.

Parameters

index_name	the name of the index to create
dataset_name	the name of the dataset where the index should be created
fields	the fields that should be indexed
options	optional parameters

Returns

future object that carries the 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 &	index_name,
		const std::string &	dataset_name,
		const std::map< std::string, std::string > &	fields,
		const create_index_analytics_options &	options,
		create_index_analytics_handler &&	handler ) const

Creates a new analytics index.

Parameters

index_name	the name of the index to create
dataset_name	the name of the dataset where the index should be created
fields	the fields that should be indexed
options	optional parameters
handler	the handler that implements create_index_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

create_link() [1/2]

auto create_link ( const management::analytics_link & link, const create_link_analytics_options & options ) const -> std::future< error >

nodiscard

Creates a new analytics remote link.

Parameters

link	the settings for the link to be created
options	optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

create_link() [2/2]

void create_link	(	const management::analytics_link &	link,
		const create_link_analytics_options &	options,
		create_link_analytics_handler &&	handler ) const

Creates a new analytics remote link.

Parameters

link	the settings for the link to be created
options	optional parameters
handler	the handler that implements create_link_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

disconnect_link() [1/2]

auto disconnect_link ( const disconnect_link_analytics_options & options ) const -> std::future< error >

nodiscard

Disconnects a currently connected link.

Parameters

options

optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

disconnect_link() [2/2]

void disconnect_link	(	const disconnect_link_analytics_options &	options,
		disconnect_link_analytics_handler &&	handler ) const

Disconnects a currently connected link.

Parameters

options	optional parameters
handler	the handler that implements disconnect_link_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

drop_dataset() [1/2]

auto drop_dataset ( const std::string & dataset_name, const drop_dataset_analytics_options & options ) const -> std::future< error >

nodiscard

Drops (deletes) a dataset.

Parameters

dataset_name	the name of the dataset to drop
options	optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

drop_dataset() [2/2]

void drop_dataset	(	const std::string &	dataset_name,
		const drop_dataset_analytics_options &	options,
		drop_dataset_analytics_handler &&	handler ) const

Drops (deletes) a dataset.

Parameters

dataset_name	the name of the dataset to drop
options	optional parameters
handler	the handler that implements drop_dataset_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

drop_dataverse() [1/2]

auto drop_dataverse ( const std::string & dataverse_name, const drop_dataverse_analytics_options & options ) const -> std::future< error >

nodiscard

Drops (deletes) a dataverse.

Parameters

dataverse_name	the name of the dataverse to drop
options	optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

drop_dataverse() [2/2]

void drop_dataverse	(	const std::string &	dataverse_name,
		const drop_dataverse_analytics_options &	options,
		drop_dataverse_analytics_handler &&	handler ) const

Drops (deletes) a dataverse.

Parameters

dataverse_name	the name of the dataverse to drop
options	optional parameters
handler	the handler that implements drop_dataverse_analytics_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 & index_name, const std::string & dataset_name, const drop_index_analytics_options & options ) const -> std::future< error >

nodiscard

Drops (removes) an analytics index.

Parameters

index_name	the name of the index to drop
dataset_name	the dataset where the index exists
options	optional parameters

Returns

future object that carries the 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 &	index_name,
		const std::string &	dataset_name,
		const drop_index_analytics_options &	options,
		drop_index_analytics_handler &&	handler ) const

Drops (removes) an analytics index.

Parameters

index_name	the name of the index to drop
dataset_name	the dataset where the index exists
options	optional parameters
handler	the handler that implements drop_index_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

drop_link() [1/2]

auto drop_link ( const std::string & link_name, const std::string & dataverse_name, const drop_link_analytics_options & options ) const -> std::future< error >

nodiscard

Drops an existing analytics remote link.

Parameters

link_name	the name of the link to drop
dataverse_name	the name of the dataverse containing the link to be dropped
options	optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

drop_link() [2/2]

void drop_link	(	const std::string &	link_name,
		const std::string &	dataverse_name,
		const drop_link_analytics_options &	options,
		drop_link_analytics_handler &&	handler ) const

Drops an existing analytics remote link.

Parameters

link_name	the name of the link to drop
dataverse_name	the name of the dataverse containing the link to be dropped
options	optional parameters
handler	the handler that implements drop_link_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

get_all_datasets() [1/2]

auto get_all_datasets ( const get_all_datasets_analytics_options & options ) const -> std::future< std::pair< error, std::vector< management::analytics_dataset > > >

nodiscard

Fetches all datasets (analytics collections) from the analytics service.

Parameters

options

optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

get_all_datasets() [2/2]

void get_all_datasets	(	const get_all_datasets_analytics_options &	options,
		get_all_datasets_analytics_handler &&	handler ) const

Fetches all datasets (analytics collections) from the analytics service.

Parameters

options	optional parameters
handler	the handler that implements get_all_datasets_analytics_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_indexes_analytics_options & options ) const -> std::future< std::pair< error, std::vector< management::analytics_index > > >

nodiscard

Fetches all analytics indexes.

Parameters

options

optional parameters

Returns

future object that carries the 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_indexes_analytics_options &	options,
		get_all_indexes_analytics_handler &&	handler ) const

Fetches all analytics indexes.

Parameters

options	optional parameters
handler	the handler that implements get_all_indexes_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

get_links() [1/2]

auto get_links ( const get_links_analytics_options & options ) const -> std::future< std::pair< error, std::vector< std::unique_ptr< management::analytics_link > > > >

nodiscard

Fetches the existing analytics remote links.

Parameters

options

optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

get_links() [2/2]

void get_links	(	const get_links_analytics_options &	options,
		get_links_analytics_handler &&	handler ) const

Fetches the existing analytics remote links.

Parameters

options	optional parameters
handler	the handler that implemenets get_links_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

get_pending_mutations() [1/2]

auto get_pending_mutations ( const get_pending_mutations_analytics_options & options ) const -> std::future< std::pair< error, std::map< std::string, std::map< std::string, std::int64_t > > > >

nodiscard

Returns the pending mutations for different dataverses.

Parameters

options

optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

get_pending_mutations() [2/2]

void get_pending_mutations	(	const get_pending_mutations_analytics_options &	options,
		get_pending_mutations_analytics_handler &&	handler ) const

Returns the pending mutations for different dataverses.

Parameters

options	optional parameters
handler	the handler that implements get_pending_mutations_analytics_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

replace_link() [1/2]

auto replace_link ( const management::analytics_link & link, const replace_link_analytics_options & options ) const -> std::future< error >

nodiscard

Replaces an existing analytics remote link.

Parameters

link	the settings for the updated link
options	optional parameters

Returns

future object that carries the result of the operation

Since

1.0.0

Committed

Generally available API and should be preferred in production

replace_link() [2/2]

void replace_link	(	const management::analytics_link &	link,
		const replace_link_analytics_options &	options,
		replace_link_analytics_handler &&	handler ) const

Replaces an existing analytics remote link.

Parameters

link	the settings for the updated link
options	optional parameters
handler	the handler that implements replace_link_analytics_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/analytics_index_manager.hxx