cluster.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/analytics_index_manager.hxx>
#include <couchbase/analytics_options.hxx>
#include <couchbase/bucket.hxx>
#include <couchbase/bucket_manager.hxx>
#include <couchbase/cluster_options.hxx>
#include <couchbase/diagnostics_options.hxx>
#include <couchbase/fork_event.hxx>
#include <couchbase/ping_options.hxx>
#include <couchbase/query_index_manager.hxx>
#include <couchbase/query_options.hxx>
#include <couchbase/search_index_manager.hxx>
#include <couchbase/search_options.hxx>
#include <couchbase/search_query.hxx>
#include <couchbase/search_request.hxx>
#include <couchbase/transactions.hxx>
#include <couchbase/wait_until_ready_options.hxx>
 
#include <chrono>
#include <memory>
 
namespace couchbase
{
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
namespace core
{
class cluster;
 
namespace transactions
{
class transactions;
}
} // namespace core
class cluster_impl;
#endif

class cluster
{
public:
  static void connect(const std::string& connection_string,
                      const cluster_options& options,
                      cluster_connect_handler&& handler);

  [[nodiscard]] static auto connect(const std::string& connection_string,
                                    const cluster_options& options)
    -> std::future<std::pair<error, cluster>>;
 
  cluster() = default;
  cluster(const cluster& other) = default;
  cluster(cluster&& other) = default;
  ~cluster() = default;
  auto operator=(const cluster& other) -> cluster& = default;
  auto operator=(cluster&& other) -> cluster& = default;

  void notify_fork(fork_event event);
 
  void close(std::function<void()>&& handler);
  [[nodiscard]] auto close() -> std::future<void>;

  auto set_authenticator(const password_authenticator& authenticator) -> error;

  auto set_authenticator(const certificate_authenticator& authenticator) -> error;

  auto set_authenticator(const jwt_authenticator& authenticator) -> error;

  [[nodiscard]] auto bucket(std::string_view bucket_name) const -> bucket;

  void query(std::string statement, const query_options& options, query_handler&& handler) const;

  [[nodiscard]] auto query(std::string statement, const query_options& options) const
    -> std::future<std::pair<error, query_result>>;

  void query_stream(std::string statement,
                    const query_options& options,
                    query_stream_handler&& handler) const;

  [[nodiscard]] auto query_stream(std::string statement, const query_options& options = {}) const
    -> std::future<std::pair<error, query_stream_result>>;

  void search(std::string index_name,
              search_request request,
              const search_options& options,
              search_handler&& handler) const;

  [[nodiscard]] auto search(std::string index_name,
                            search_request request,
                            const search_options& options = {}) const
    -> std::future<std::pair<error, search_result>>;

  void analytics_query(std::string statement,
                       const analytics_options& options,
                       analytics_handler&& handler) const;

  [[nodiscard]] auto analytics_query(std::string statement,
                                     const analytics_options& options = {}) const
    -> std::future<std::pair<error, analytics_result>>;

  void analytics_query_stream(std::string statement,
                              const analytics_options& options,
                              analytics_stream_handler&& handler) const;

  [[nodiscard]] auto analytics_query_stream(std::string statement,
                                            const analytics_options& options = {}) const
    -> std::future<std::pair<error, analytics_stream_result>>;

  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>>;

  void diagnostics(const diagnostics_options& options, diagnostics_handler&& handler) const;

  [[nodiscard]] auto diagnostics(const diagnostics_options& options = {}) const
    -> std::future<std::pair<error, diagnostics_result>>;

  void wait_until_ready(std::chrono::milliseconds timeout,
                        const wait_until_ready_options& options,
                        wait_until_ready_handler&& handler) const;

  [[nodiscard]] auto wait_until_ready(std::chrono::milliseconds timeout,
                                      const wait_until_ready_options& options = {}) const
    -> std::future<error>;

  [[nodiscard]] auto query_indexes() const -> query_index_manager;

  [[nodiscard]] auto analytics_indexes() const -> analytics_index_manager;

  [[nodiscard]] auto buckets() const -> bucket_manager;

  [[nodiscard]] auto search_indexes() const -> search_index_manager;

  [[nodiscard]] auto transactions() const -> std::shared_ptr<couchbase::transactions::transactions>;
 
private:
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
  friend class cluster_impl;
  explicit cluster(std::shared_ptr<cluster_impl> impl);
#endif
 
  std::shared_ptr<cluster_impl> impl_{};
};
} // namespace couchbase