Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
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_namethe name of the scope to create the collection on
collection_namethe collection name
settingscreate collection settings
optionsoptional parameters
handlerhandler 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 >
nodiscard

◆ 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_namethe scope name
optionsoptional parameters
handlerhandler 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 >
nodiscard

◆ 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_namethe name of the scope on which the collection exists
collection_namethe collection name
optionsoptional parameters
handlerhandler 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 >
nodiscard

◆ 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_namethe scope name
optionsoptional parameters
handlerhandler 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 >
nodiscard

◆ 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
optionsoptional parameters
handlerhandler 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 > > >
nodiscard

◆ 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_namethe name of the scope on which the collection exists
collection_namethe collection name
settingsupdate collection settings
optionsoptional parameters
handlerhandler 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 >
nodiscard

Friends And Related Symbol Documentation

◆ bucket

friend class bucket
friend

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