Provides access to Couchbase bucket.
More...
#include <couchbase/bucket.hxx>
Provides access to Couchbase bucket.
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ collections()
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()
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]
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
-
options | custom options to change the default behavior. |
handler | the handler that implements ping_handler. |
- Since
- 1.0.0
- Committed
- Generally available API and should be preferred in production
◆ ping() [2/2]
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
-
options | custom 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_name | the 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: