bucket_manager Class Reference

#include <couchbase/bucket_manager.hxx>

Public Member Functions
void	get_bucket (std::string bucket_name, const get_bucket_options &options, get_bucket_handler &&handler) const
	Get specific bucket within the cluster.
auto	get_bucket (std::string bucket_name, const get_bucket_options &options={}) const -> std::future< std::pair< error, management::cluster::bucket_settings > >
void	get_all_buckets (const get_all_buckets_options &options, get_all_buckets_handler &&handler) const
	Get all buckets on the cluster.
auto	get_all_buckets (const get_all_buckets_options &options={}) const -> std::future< std::pair< error, std::vector< management::cluster::bucket_settings > > >
void	create_bucket (const management::cluster::bucket_settings &bucket_settings, const create_bucket_options &options, create_bucket_handler &&handler) const
	Create a bucket on the cluster.
auto	create_bucket (const management::cluster::bucket_settings &bucket_settings, const create_bucket_options &options={}) const -> std::future< error >
void	update_bucket (const management::cluster::bucket_settings &bucket_settings, const update_bucket_options &options, update_bucket_handler &&handler) const
	Update an existing bucket.
auto	update_bucket (const management::cluster::bucket_settings &bucket_settings, const update_bucket_options &options={}) const -> std::future< error >
void	drop_bucket (std::string bucket_name, const drop_bucket_options &options, drop_bucket_handler &&handler) const
	Drop an existing bucket.
auto	drop_bucket (std::string bucket_name, const drop_bucket_options &options={}) const -> std::future< error >
void	flush_bucket (std::string bucket_name, const flush_bucket_options &options, flush_bucket_handler &&handler) const
	Flush an existing bucket.
auto	flush_bucket (std::string bucket_name, const flush_bucket_options &options={}) const -> std::future< error >

Friends
class	cluster

Member Function Documentation

create_bucket() [1/2]

void create_bucket	(	const management::cluster::bucket_settings &	bucket_settings,
		const create_bucket_options &	options,
		create_bucket_handler &&	handler ) const

Create a bucket on the cluster.

Parameters

bucket_settings	the settings for the bucket
options	optional parameters
handler	handler that implements create_bucket_handler

create_bucket() [2/2]

auto create_bucket	(	const management::cluster::bucket_settings &	bucket_settings,
		const create_bucket_options &	options = {} ) const -> std::future< error >

drop_bucket() [1/2]

void drop_bucket	(	std::string	bucket_name,
		const drop_bucket_options &	options,
		drop_bucket_handler &&	handler ) const

Drop an existing bucket.

Parameters

bucket_name	the name of the bucket to drop
options	optional parameters
handler	handler that implements drop_bucket_handler

drop_bucket() [2/2]

auto drop_bucket	(	std::string	bucket_name,
		const drop_bucket_options &	options = {} ) const -> std::future< error >

flush_bucket() [1/2]

void flush_bucket	(	std::string	bucket_name,
		const flush_bucket_options &	options,
		flush_bucket_handler &&	handler ) const

Flush an existing bucket.

Parameters

bucket_name	the name of the bucket to flush
options	optional parameters
handler	handler that implements flush_bucket_handler

flush_bucket() [2/2]

auto flush_bucket	(	std::string	bucket_name,
		const flush_bucket_options &	options = {} ) const -> std::future< error >

get_all_buckets() [1/2]

void get_all_buckets	(	const get_all_buckets_options &	options,
		get_all_buckets_handler &&	handler ) const

Get all buckets on the cluster.

Parameters

options	optional parameters
handler	handler that implements get_all_buckets_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

get_all_buckets() [2/2]

auto get_all_buckets

(

const get_all_buckets_options &

options = {}

)

const -> std::future< std::pair< error, std::vector< management::cluster::bucket_settings > > >

get_bucket() [1/2]

void get_bucket	(	std::string	bucket_name,
		const get_bucket_options &	options,
		get_bucket_handler &&	handler ) const

Get specific bucket within the cluster.

Parameters

bucket_name	the name of the bucket to get
options	optional parameters
handler	handler that implements get_bucket_handler

Since

1.0.0

Committed

Generally available API and should be preferred in production

get_bucket() [2/2]

auto get_bucket	(	std::string	bucket_name,
		const get_bucket_options &	options = {} ) const -> std::future< std::pair< error, management::cluster::bucket_settings > >

update_bucket() [1/2]

void update_bucket	(	const management::cluster::bucket_settings &	bucket_settings,
		const update_bucket_options &	options,
		update_bucket_handler &&	handler ) const

Update an existing bucket.

Parameters

bucket_settings	the settings for the bucket
options	optional parameters
handler	handler that implements update_bucket_handler

update_bucket() [2/2]

auto update_bucket	(	const management::cluster::bucket_settings &	bucket_settings,
		const update_bucket_options &	options = {} ) const -> std::future< error >

Friends And Related Symbol Documentation

cluster

friend class cluster

friend

---

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

• couchbase/bucket_manager.hxx