Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
bucket Class Reference

Provides access to Couchbase bucket. More...

#include <couchbase/bucket.hxx>

Public Member Functions

auto default_scope () const -> scope
 Opens default scope.
 
auto default_collection () const -> collection
 Opens the default collection for this bucket using the default scope.
 
auto scope (std::string_view scope_name) const -> scope
 Opens the scope with the given name.
 
void ping (const ping_options &options, ping_handler &&handler) const
 Performs application-level ping requests against services in the Couchbase cluster.
 
auto ping (const ping_options &options={}) const -> std::future< std::pair< error, ping_result > >
 Performs application-level ping requests against services in the Couchbase cluster.
 
auto collections () const -> collection_manager
 Provides access to the collection management services.
 

Detailed Description

Provides access to Couchbase bucket.

Since
1.0.0
Committed
Generally available API and should be preferred in production

Member Function Documentation

◆ collections()

auto collections ( ) const -> collection_manager
nodiscard

Provides access to the collection management services.

Returns
a manager instance
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ default_collection()

auto default_collection ( ) const -> collection
nodiscard

Opens the default collection for this bucket using the default scope.

Returns
the opened default collection.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ default_scope()

auto default_scope ( ) const -> scope
nodiscard

Opens default scope.

Returns
the scope once opened.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ ping() [1/2]

void ping ( const ping_options & options,
ping_handler && handler ) const

Performs application-level ping requests against services in the Couchbase cluster.

Note
This operation performs active I/O against services and endpoints to assess their health. If you do not wish to performs I/O, consider using cluster::diagnostics() instead.
Parameters
optionscustom options to change the default behavior.
handlerthe handler that implements ping_handler.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ ping() [2/2]

auto ping ( const ping_options & options = {}) const -> std::future< std::pair< error, ping_result > >
nodiscard

Performs application-level ping requests against services in the Couchbase cluster.

Note
This operation performs active I/O against services and endpoints to assess their health. If you do not wish to performs I/O, consider using cluster::diagnostics() instead.
Parameters
optionscustom options to change the default behavior.
Returns
future object that carries result of the operation.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ scope()

auto scope ( std::string_view scope_name) const -> scope
nodiscard

Opens the scope with the given name.

Parameters
scope_namethe name of the scope.
Returns
the scope once opened.
Since
1.0.0
Committed
Generally available API and should be preferred in production

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