collection_manager Class Reference

#include <couchbase/collection_manager.hxx>

Public Member Functions
void	get_all_scopes (const get_all_scopes_options &options, get_all_scopes_handler &&handler) const
	Get all scopes on the bucket.
auto	get_all_scopes (const get_all_scopes_options &options={}) const -> std::future< std::pair< error, std::vector< management::bucket::scope_spec > > >
void	create_collection (std::string scope_name, std::string collection_name, const create_collection_settings &settings, const create_collection_options &options, create_collection_handler &&handler) const
	Creates a new collection.
auto	create_collection (std::string scope_name, std::string collection_name, const create_collection_settings &settings={}, const create_collection_options &options={}) const -> std::future< error >
void	update_collection (std::string scope_name, std::string collection_name, const update_collection_settings &settings, const update_collection_options &options, update_collection_handler &&handler) const
	Updates an existing collection.
auto	update_collection (std::string scope_name, std::string collection_name, const update_collection_settings &settings, const update_collection_options &options={}) const -> std::future< error >
void	drop_collection (std::string scope_name, std::string collection_name, const drop_collection_options &options, drop_collection_handler &&handler) const
	Drops a collection.
auto	drop_collection (std::string scope_name, std::string collection_name, const drop_collection_options &options={}) const -> std::future< error >
void	create_scope (std::string scope_name, const create_scope_options &options, create_scope_handler &&handler) const
	Creates a scope on the bucket.
auto	create_scope (std::string scope_name, const create_scope_options &options={}) const -> std::future< error >
void	drop_scope (std::string scope_name, const drop_scope_options &options, drop_scope_handler &&handler) const
	Drops a scope on the bucket.
auto	drop_scope (std::string scope_name, const drop_scope_options &options={}) const -> std::future< error >

Friends
class	bucket

Member Function Documentation

create_collection() [1/2]

void create_collection	(	std::string	scope_name,
		std::string	collection_name,
		const create_collection_settings &	settings,
		const create_collection_options &	options,
		create_collection_handler &&	handler ) const

Creates a new collection.

Parameters

scope_name	the name of the scope to create the collection on
collection_name	the collection name
settings	create collection settings
options	optional parameters
handler	handler that implements create_collection_handler

Since

1.0.0

create_collection() [2/2]

auto create_collection	(	std::string	scope_name,
		std::string	collection_name,
		const create_collection_settings &	settings = {},
		const create_collection_options &	options = {} ) const -> std::future< error >

create_scope() [1/2]

void create_scope	(	std::string	scope_name,
		const create_scope_options &	options,
		create_scope_handler &&	handler ) const

Creates a scope on the bucket.

Parameters

scope_name	the scope name
options	optional parameters
handler	handler that implements create_scope_handler

Since

1.0.0

create_scope() [2/2]

auto create_scope	(	std::string	scope_name,
		const create_scope_options &	options = {} ) const -> std::future< error >

drop_collection() [1/2]

void drop_collection	(	std::string	scope_name,
		std::string	collection_name,
		const drop_collection_options &	options,
		drop_collection_handler &&	handler ) const

Drops a collection.

Parameters

scope_name	the name of the scope on which the collection exists
collection_name	the collection name
options	optional parameters
handler	handler that implements drop_collection_handler

Since

1.0.0

drop_collection() [2/2]

auto drop_collection	(	std::string	scope_name,
		std::string	collection_name,
		const drop_collection_options &	options = {} ) const -> std::future< error >

drop_scope() [1/2]

void drop_scope	(	std::string	scope_name,
		const drop_scope_options &	options,
		drop_scope_handler &&	handler ) const

Drops a scope on the bucket.

Parameters

scope_name	the scope name
options	optional parameters
handler	handler that implements drop_scope_handler

Since

1.0.0

drop_scope() [2/2]

auto drop_scope	(	std::string	scope_name,
		const drop_scope_options &	options = {} ) const -> std::future< error >

get_all_scopes() [1/2]

void get_all_scopes	(	const get_all_scopes_options &	options,
		get_all_scopes_handler &&	handler ) const

Get all scopes on the bucket.

Parameters

options	optional parameters
handler	handler that implements get_all_scopes_handler

Since

1.0.0

get_all_scopes() [2/2]

auto get_all_scopes

(

const get_all_scopes_options &

options = {}

)

const -> std::future< std::pair< error, std::vector< management::bucket::scope_spec > > >

update_collection() [1/2]

void update_collection	(	std::string	scope_name,
		std::string	collection_name,
		const update_collection_settings &	settings,
		const update_collection_options &	options,
		update_collection_handler &&	handler ) const

Updates an existing collection.

Parameters

scope_name	the name of the scope on which the collection exists
collection_name	the collection name
settings	update collection settings
options	optional parameters
handler	handler that implements update_collection_handler

Since

1.0.0

update_collection() [2/2]

auto update_collection	(	std::string	scope_name,
		std::string	collection_name,
		const update_collection_settings &	settings,
		const update_collection_options &	options = {} ) const -> std::future< error >

Friends And Related Symbol Documentation

bucket

friend class bucket

friend

---

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

• couchbase/collection_manager.hxx