scope.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_options.hxx>
#include <couchbase/collection.hxx>
#include <couchbase/query_options.hxx>
#include <couchbase/scope_search_index_manager.hxx>
#include <couchbase/search_options.hxx>
#include <couchbase/search_query.hxx>
#include <couchbase/search_request.hxx>
 
#include <memory>
 
namespace couchbase
{
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
namespace core
{
class cluster;
} // namespace core
class bucket;
class scope_impl;
#endif

class scope
{
public:
  static constexpr auto default_name{ "_default" };

  [[nodiscard]] auto bucket_name() const -> const std::string&;

  [[nodiscard]] auto name() const -> const std::string&;

  [[nodiscard]] auto collection(std::string_view collection_name) const -> collection;

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

  [[nodiscard]] auto search_indexes() const -> scope_search_index_manager;
 
private:
  friend class bucket;
 
  scope(core::cluster core,
        std::string_view bucket_name,
        std::string_view name,
        std::shared_ptr<crypto::manager> crypto_manager);
 
  std::shared_ptr<scope_impl> impl_;
};
} // namespace couchbase