collection.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/binary_collection.hxx>
#include <couchbase/codec/default_json_transcoder.hxx>
#include <couchbase/collection_query_index_manager.hxx>
#include <couchbase/error.hxx>
#include <couchbase/exists_options.hxx>
#include <couchbase/expiry.hxx>
#include <couchbase/get_all_replicas_options.hxx>
#include <couchbase/get_and_lock_options.hxx>
#include <couchbase/get_and_touch_options.hxx>
#include <couchbase/get_any_replica_options.hxx>
#include <couchbase/get_options.hxx>
#include <couchbase/get_replica_options.hxx>
#include <couchbase/get_replica_strategy.hxx>
#include <couchbase/insert_options.hxx>
#include <couchbase/lookup_in_all_replicas_options.hxx>
#include <couchbase/lookup_in_any_replica_options.hxx>
#include <couchbase/lookup_in_options.hxx>
#include <couchbase/lookup_in_specs.hxx>
#include <couchbase/mutate_in_options.hxx>
#include <couchbase/mutate_in_specs.hxx>
#include <couchbase/node_id_for_options.hxx>
#include <couchbase/node_ids_options.hxx>
#include <couchbase/query_options.hxx>
#include <couchbase/remove_options.hxx>
#include <couchbase/replace_options.hxx>
#include <couchbase/scan_options.hxx>
#include <couchbase/scan_result.hxx>
#include <couchbase/scan_type.hxx>
#include <couchbase/touch_options.hxx>
#include <couchbase/unlock_options.hxx>
#include <couchbase/upsert_options.hxx>
 
#include <future>
#include <memory>
 
namespace couchbase
{
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
namespace core
{
class cluster;
} // namespace core
class bucket;
class scope;
class collection_impl;
namespace crypto
{
class manager;
} // namespace crypto
#endif

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

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

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

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

  [[nodiscard]] auto binary() const -> binary_collection;

  void get(std::string document_id, const get_options& options, get_handler&& handler) const;

  [[nodiscard]] auto get(std::string document_id, const get_options& options = {}) const
    -> std::future<std::pair<error, get_result>>;

  void get_and_touch(std::string document_id,
                     std::chrono::seconds duration,
                     const get_and_touch_options& options,
                     get_and_touch_handler&& handler) const;

  [[nodiscard]] auto get_and_touch(std::string document_id,
                                   std::chrono::seconds duration,
                                   const get_and_touch_options& options = {}) const
    -> std::future<std::pair<error, get_result>>;

  void get_and_touch(std::string document_id,
                     std::chrono::system_clock::time_point time_point,
                     const get_and_touch_options& options,
                     get_and_touch_handler&& handler) const;

  [[nodiscard]] auto get_and_touch(std::string document_id,
                                   std::chrono::system_clock::time_point time_point,
                                   const get_and_touch_options& options = {}) const
    -> std::future<std::pair<error, get_result>>;

  void touch(std::string document_id,
             std::chrono::seconds duration,
             const touch_options& options,
             touch_handler&& handler) const;

  [[nodiscard]] auto touch(std::string document_id,
                           std::chrono::seconds duration,
                           const touch_options& options = {}) const
    -> std::future<std::pair<error, result>>;

  void touch(std::string document_id,
             std::chrono::system_clock::time_point time_point,
             const touch_options& options,
             touch_handler&& handler) const;

  [[nodiscard]] auto touch(std::string document_id,
                           std::chrono::system_clock::time_point time_point,
                           const touch_options& options = {}) const
    -> std::future<std::pair<error, result>>;

  void get_any_replica(std::string document_id,
                       const get_any_replica_options& options,
                       get_any_replica_handler&& handler) const;

  [[nodiscard]] auto get_any_replica(std::string document_id,
                                     const get_any_replica_options& options = {}) const
    -> std::future<std::pair<error, get_replica_result>>;

  void get_replica(std::string document_id,
                   const get_replica_strategy& strategy,
                   const get_replica_options& options,
                   get_replica_handler&& handler) const;

  [[nodiscard]] auto get_replica(std::string document_id,
                                 const get_replica_strategy& strategy,
                                 const get_replica_options& options = {}) const
    -> std::future<std::pair<error, get_replica_result>>;

  void get_all_replicas(std::string document_id,
                        const get_all_replicas_options& options,
                        get_all_replicas_handler&& handler) const;

  [[nodiscard]] auto get_all_replicas(std::string document_id,
                                      const get_all_replicas_options& options = {}) const
    -> std::future<std::pair<error, get_all_replicas_result>>;

  void upsert(std::string document_id,
              codec::encoded_value document,
              const upsert_options& options,
              upsert_handler&& handler) const;

  template<typename Transcoder = codec::default_json_transcoder, typename Document>
  void upsert(std::string document_id,
              Document document,
              const upsert_options& options,
              upsert_handler&& handler) const
  {
    return upsert(std::move(document_id),
                  create_encode_fn<Transcoder, Document>(std::move(document)),
                  options,
                  std::move(handler));
  }

  [[nodiscard]] auto upsert(std::string document_id,
                            codec::encoded_value document,
                            const upsert_options& options) const
    -> std::future<std::pair<error, mutation_result>>;

  template<typename Transcoder = codec::default_json_transcoder, typename Document>
  [[nodiscard]] auto upsert(std::string document_id,
                            Document document,
                            const upsert_options& options = {}) const
    -> std::future<std::pair<error, mutation_result>>
  {
    return upsert(
      std::move(document_id), create_encode_fn<Transcoder, Document>(std::move(document)), options);
  }

  void insert(std::string document_id,
              codec::encoded_value document,
              const insert_options& options,
              insert_handler&& handler) const;

  template<typename Transcoder = codec::default_json_transcoder,
           typename Document,
           std::enable_if_t<!std::is_same_v<codec::encoded_value, Document>, bool> = true>
  void insert(std::string document_id,
              Document document,
              const insert_options& options,
              insert_handler&& handler) const
  {
    return insert(std::move(document_id),
                  create_encode_fn<Transcoder, Document>(std::move(document)),
                  options,
                  std::move(handler));
  }

  [[nodiscard]] auto insert(std::string document_id,
                            codec::encoded_value document,
                            const insert_options& options) const
    -> std::future<std::pair<error, mutation_result>>;

  template<typename Transcoder = codec::default_json_transcoder,
           typename Document,
           std::enable_if_t<!std::is_same_v<codec::encoded_value, Document>, bool> = true>
  [[nodiscard]] auto insert(std::string document_id,
                            Document document,
                            const insert_options& options = {}) const
    -> std::future<std::pair<error, mutation_result>>
  {
    return insert(
      std::move(document_id), create_encode_fn<Transcoder, Document>(std::move(document)), options);
  }

  void replace(std::string document_id,
               codec::encoded_value document,
               const replace_options& options,
               replace_handler&& handler) const;

  template<typename Transcoder = codec::default_json_transcoder,
           typename Document,
           std::enable_if_t<!std::is_same_v<codec::encoded_value, Document>, bool> = true>
  void replace(std::string document_id,
               Document document,
               const replace_options& options,
               replace_handler&& handler) const
  {
    return replace(std::move(document_id),
                   create_encode_fn<Transcoder, Document>(std::move(document)),
                   options,
                   std::move(handler));
  }

  [[nodiscard]] auto replace(std::string document_id,
                             codec::encoded_value document,
                             const replace_options& options) const
    -> std::future<std::pair<error, mutation_result>>;

  template<typename Transcoder = codec::default_json_transcoder,
           typename Document,
           std::enable_if_t<!std::is_same_v<codec::encoded_value, Document>, bool> = true>
  [[nodiscard]] auto replace(std::string document_id,
                             Document document,
                             const replace_options& options = {}) const
    -> std::future<std::pair<error, mutation_result>>
  {
    return replace(
      std::move(document_id), create_encode_fn<Transcoder, Document>(std::move(document)), options);
  }

  void remove(std::string document_id,
              const remove_options& options,
              remove_handler&& handler) const;

  [[nodiscard]] auto remove(std::string document_id, const remove_options& options = {}) const
    -> std::future<std::pair<error, mutation_result>>;

  void mutate_in(std::string document_id,
                 const mutate_in_specs& specs,
                 const mutate_in_options& options,
                 mutate_in_handler&& handler) const;

  [[nodiscard]] auto mutate_in(std::string document_id,
                               const mutate_in_specs& specs,
                               const mutate_in_options& options = {}) const
    -> std::future<std::pair<error, mutate_in_result>>;

  void lookup_in(std::string document_id,
                 const lookup_in_specs& specs,
                 const lookup_in_options& options,
                 lookup_in_handler&& handler) const;

  [[nodiscard]] auto lookup_in(std::string document_id,
                               const lookup_in_specs& specs,
                               const lookup_in_options& options = {}) const
    -> std::future<std::pair<error, lookup_in_result>>;

  void lookup_in_all_replicas(std::string document_id,
                              const lookup_in_specs& specs,
                              const lookup_in_all_replicas_options& options,
                              lookup_in_all_replicas_handler&& handler) const;

  [[nodiscard]] auto lookup_in_all_replicas(std::string document_id,
                                            const lookup_in_specs& specs,
                                            const lookup_in_all_replicas_options& options = {})
    const -> std::future<std::pair<error, lookup_in_all_replicas_result>>;

  void lookup_in_any_replica(std::string document_id,
                             const lookup_in_specs& specs,
                             const lookup_in_any_replica_options& options,
                             lookup_in_any_replica_handler&& handler) const;

  [[nodiscard]] auto lookup_in_any_replica(std::string document_id,
                                           const lookup_in_specs& specs,
                                           const lookup_in_any_replica_options& options = {}) const
    -> std::future<std::pair<error, lookup_in_replica_result>>;

  void get_and_lock(std::string document_id,
                    std::chrono::seconds lock_duration,
                    const get_and_lock_options& options,
                    get_and_lock_handler&& handler) const;

  [[nodiscard]] auto get_and_lock(std::string document_id,
                                  std::chrono::seconds lock_duration,
                                  const get_and_lock_options& options = {}) const
    -> std::future<std::pair<error, get_result>>;

  void unlock(std::string document_id,
              couchbase::cas cas,
              const unlock_options& options,
              unlock_handler&& handler) const;

  [[nodiscard]] auto unlock(std::string document_id,
                            couchbase::cas cas,
                            const unlock_options& options = {}) const -> std::future<error>;

  void exists(std::string document_id,
              const exists_options& options,
              exists_handler&& handler) const;

  [[nodiscard]] auto exists(std::string document_id, const exists_options& options = {}) const
    -> std::future<std::pair<error, exists_result>>;

  void scan(const scan_type& scan_type, const scan_options& options, scan_handler&& handler) const;

  [[nodiscard]] auto scan(const scan_type& scan_type, const scan_options& options = {}) const
    -> std::future<std::pair<error, scan_result>>;

  void node_id_for(std::string document_id,
                   const node_id_for_options& options,
                   node_id_for_handler&& handler) const;

  [[nodiscard]] auto node_id_for(std::string document_id,
                                 const node_id_for_options& options = {}) const
    -> std::future<std::pair<error, node_id>>;

  void node_ids(const node_ids_options& options, node_ids_handler&& handler) const;

  [[nodiscard]] auto node_ids(const node_ids_options& options = {}) const
    -> std::future<std::pair<error, std::vector<node_id>>>;
 
  [[nodiscard]] auto query_indexes() const -> collection_query_index_manager;
 
private:
  friend class bucket;
  friend class scope;
 
  [[nodiscard]] auto crypto_manager() const -> const std::shared_ptr<crypto::manager>&;
 
  template<typename Transcoder, typename Document>
  [[nodiscard]] auto create_encode_fn(Document document) const
    -> std::function<codec::encoded_value()>
  {
    if constexpr (codec::is_crypto_transcoder_v<Transcoder>) {
      return [crypto_manager = crypto_manager(),
              document = std::move(document)]() -> codec::encoded_value {
        return Transcoder::encode(document, crypto_manager);
      };
    } else {
      return [document = std::move(document)]() -> codec::encoded_value {
        return Transcoder::encode(document);
      };
    }
  }
 
  void replace(std::string document_id,
               std::function<codec::encoded_value()> document_fn,
               const replace_options& options,
               replace_handler&& handler) const;
 
  auto replace(std::string document_id,
               std::function<codec::encoded_value()> document_fn,
               const replace_options& options) const
    -> std::future<std::pair<error, mutation_result>>;
 
  void upsert(std::string document_id,
              std::function<codec::encoded_value()> document_fn,
              const upsert_options& options,
              upsert_handler&& handler) const;
 
  auto upsert(std::string document_id,
              std::function<codec::encoded_value()> document_fn,
              const upsert_options& options) const
    -> std::future<std::pair<error, mutation_result>>;
 
  void insert(std::string document_id,
              std::function<codec::encoded_value()> document_fn,
              const insert_options& options,
              insert_handler&& handler) const;
 
  auto insert(std::string document_id,
              std::function<codec::encoded_value()> document_fn,
              const insert_options& options) const
    -> std::future<std::pair<error, mutation_result>>;
 
  collection(core::cluster core,
             std::string_view bucket_name,
             std::string_view scope_name,
             std::string_view name,
             std::shared_ptr<crypto::manager> crypto_manager);
 
  std::shared_ptr<collection_impl> impl_;
};
} // namespace couchbase