bucket.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2020-Present Couchbase, Inc.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
 
#pragma once
 
#include <couchbase/collection.hxx>
#include <couchbase/collection_manager.hxx>
#include <couchbase/ping_options.hxx>
#include <couchbase/scope.hxx>
 
#include <memory>
 
namespace couchbase
{
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
namespace core
{
class cluster;
} // namespace core
class cluster;
class bucket_impl;
#endif
 
class bucket
{
public:
  [[nodiscard]] auto default_scope() const -> scope;
 
  [[nodiscard]] auto default_collection() const -> collection;
 
  [[nodiscard]] auto scope(std::string_view scope_name) const -> scope;
 
  void ping(const ping_options& options, ping_handler&& handler) const;
 
  [[nodiscard]] auto ping(const ping_options& options = {}) const
    -> std::future<std::pair<error, ping_result>>;
 
  [[nodiscard]] auto collections() const -> collection_manager;
 
private:
  friend cluster;
 
  bucket(core::cluster core, std::string_view name);
 
  std::shared_ptr<bucket_impl> impl_;
};
} // namespace couchbase