transaction_query_options.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/query_options.hxx>
 
// NOTE: when query is in public api, we will hold a query_options struct instead, and
// import that from the public api.
 
namespace couchbase::transactions
{
class transaction_context;
 
class transaction_query_options
{
public:
  transaction_query_options()
  {
    // set defaults specific to query in transactions.
    opts_.metrics(true);
  }
 
  template<typename Value>
  auto raw(const std::string& key, const Value& value) -> transaction_query_options&
  {
    opts_.raw(key, value);
    return *this;
  }
 
  auto ad_hoc(bool value) -> transaction_query_options&
  {
    opts_.adhoc(value);
    return *this;
  }
 
  auto scan_consistency(query_scan_consistency scan_consistency) -> transaction_query_options&
  {
    opts_.scan_consistency(scan_consistency);
    return *this;
  }
 
  auto profile(query_profile mode) -> transaction_query_options&
  {
    opts_.profile(mode);
    return *this;
  }
 
  auto client_context_id(const std::string& id) -> transaction_query_options&
  {
    opts_.client_context_id(id);
    return *this;
  }
 
  auto scan_wait(std::chrono::milliseconds scan_wait) -> transaction_query_options&
  {
    opts_.scan_wait(scan_wait);
    return *this;
  }
 
  auto readonly(bool readonly) -> transaction_query_options&
  {
    opts_.readonly(readonly);
    return *this;
  }
 
  auto scan_cap(std::uint64_t cap) -> transaction_query_options&
  {
    opts_.scan_cap(cap);
    return *this;
  }
 
  auto pipeline_batch(std::uint64_t batch) -> transaction_query_options&
  {
    opts_.pipeline_batch(batch);
    return *this;
  }
 
  auto pipeline_cap(std::uint64_t cap) -> transaction_query_options&
  {
    opts_.pipeline_cap(cap);
    return *this;
  }
 
  template<typename... Parameters>
  auto positional_parameters(const Parameters&... parameters)
  {
    opts_.positional_parameters(parameters...);
    return *this;
  }
 
  template<typename... Parameters>
  auto named_parameters(const Parameters&... parameters) -> transaction_query_options&
  {
    opts_.named_parameters(parameters...);
    return *this;
  }
 
  auto metrics(bool metrics) -> transaction_query_options&
  {
    opts_.metrics(metrics);
    return *this;
  }
 
  auto max_parallelism(std::uint64_t max) -> transaction_query_options&
  {
    opts_.max_parallelism(max);
    return *this;
  }
 
  auto encoded_raw_options(std::map<std::string, codec::binary, std::less<>> options)
    -> transaction_query_options&
  {
    opts_.encoded_raw_options(options);
    return *this;
  }
 
  auto encoded_positional_parameters(std::vector<codec::binary> parameters)
    -> transaction_query_options&
  {
    opts_.encoded_positional_parameters(parameters);
    return *this;
  }
 
  auto encoded_named_parameters(std::map<std::string, codec::binary, std::less<>> parameters)
    -> transaction_query_options&
  {
    opts_.encoded_named_parameters(parameters);
    return *this;
  }
 
  auto get_query_options() const -> const query_options&
  {
    return opts_;
  }
 
private:
  query_options opts_{};
};
} // namespace couchbase::transactions