attempt_context.hxx

Go to the documentation of this file.

/*
 *     Copyright 2021-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/transactions/transaction_get_multi_options.hxx>
#include <couchbase/transactions/transaction_get_multi_replicas_from_preferred_server_group_options.hxx>
#include <couchbase/transactions/transaction_get_multi_replicas_from_preferred_server_group_result.hxx>
#include <couchbase/transactions/transaction_get_multi_replicas_from_preferred_server_group_spec.hxx>
#include <couchbase/transactions/transaction_get_multi_result.hxx>
#include <couchbase/transactions/transaction_get_multi_spec.hxx>
#include <couchbase/transactions/transaction_get_result.hxx>
#include <couchbase/transactions/transaction_query_options.hxx>
#include <couchbase/transactions/transaction_query_result.hxx>
 
#include <stdexcept>
#include <vector>
 
namespace couchbase
{
class collection;
class scope;
 
namespace transactions
{
 
class attempt_context
{
public:
  virtual auto get(const couchbase::collection& coll, const std::string& id)
    -> std::pair<error, transaction_get_result> = 0;

  virtual auto get_replica_from_preferred_server_group(const couchbase::collection& coll,
                                                       const std::string& id)
    -> std::pair<error, transaction_get_result> = 0;
 
  virtual auto get_multi(const std::vector<transaction_get_multi_spec>& specs,
                         const transaction_get_multi_options& options)
    -> std::pair<error, std::optional<transaction_get_multi_result>> = 0;
 
  virtual auto get_multi_replicas_from_preferred_server_group(
    const std::vector<transaction_get_multi_replicas_from_preferred_server_group_spec>& specs,
    const transaction_get_multi_replicas_from_preferred_server_group_options& options)
    -> std::pair<
      error,
      std::optional<transaction_get_multi_replicas_from_preferred_server_group_result>> = 0;

  template<typename Transcoder = codec::default_json_transcoder,
           typename Document,
           std::enable_if_t<!std::is_same_v<codec::encoded_value, Document>, bool> = true>
  auto insert(const couchbase::collection& coll, const std::string& id, const Document& content)
    -> std::pair<error, transaction_get_result>
  {
    codec::encoded_value data;
    try {
      data = Transcoder::encode(content);
    } catch (std::system_error& e) {
      return { error(e.code(), e.what()), {} };
    } catch (std::runtime_error& e) {
      return { error(errc::common::encoding_failure, e.what()), {} };
    }
    return insert_raw(coll, id, data);
  }

  template<typename Transcoder = codec::default_json_transcoder,
           typename Document,
           std::enable_if_t<!std::is_same_v<codec::encoded_value, Document>, bool> = true>
  auto replace(const transaction_get_result& doc, const Document& content)
    -> std::pair<error, transaction_get_result>
  {
    codec::encoded_value data;
    try {
      data = Transcoder::encode(content);
    } catch (std::system_error& e) {
      return { error(e.code(), e.what()), {} };
    } catch (std::runtime_error& e) {
      return { error(errc::common::encoding_failure, e.what()), {} };
    }
    return replace_raw(doc, data);
  }

  virtual auto remove(const transaction_get_result& doc) -> error = 0;

  auto query(const std::string& statement, const transaction_query_options& options = {})
    -> std::pair<error, transaction_query_result>;

  auto query(const scope& scope,
             const std::string& statement,
             const transaction_query_options& opts = {})
    -> std::pair<error, transaction_query_result>;
 
  virtual ~attempt_context() = default;
 
protected:
  virtual auto replace_raw(const transaction_get_result& doc, codec::encoded_value content)
    -> std::pair<error, transaction_get_result> = 0;
  virtual auto insert_raw(const couchbase::collection& coll,
                          const std::string& id,
                          codec::encoded_value document)
    -> std::pair<error, transaction_get_result> = 0;
  virtual auto do_public_query(const std::string& statement,
                               const transaction_query_options& options,
                               std::optional<std::string> query_context)
    -> std::pair<error, transaction_query_result> = 0;
};
} // namespace transactions
} // namespace couchbase