term_query.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
/*
 *   Copyright 2023-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/match_operator.hxx>
#include <couchbase/search_query.hxx>
 
#include <cstdint>
#include <optional>
#include <stdexcept>
#include <string>
 
namespace couchbase
{
class term_query : public search_query
{
public:
  explicit term_query(std::string term)
    : term_{ std::move(term) }
  {
  }

  auto prefix_length(std::uint32_t length) -> term_query&
  {
    if (length == 0) {
      throw std::invalid_argument("prefix_length must be positive");
    }
 
    prefix_length_ = length;
    return *this;
  }

  auto field(std::string field_name) -> term_query&
  {
    field_ = std::move(field_name);
    return *this;
  }

  auto fuzziness(std::uint32_t fuzziness) -> term_query&
  {
    fuzziness_ = fuzziness;
    return *this;
  }

  auto match_operator(couchbase::match_operator concatenation_operator) -> term_query&
  {
    operator_ = concatenation_operator;
    return *this;
  }

  [[nodiscard]] auto encode() const -> encoded_search_query override;
 
private:
  std::string term_;
  std::optional<std::uint32_t> prefix_length_{};
  std::optional<std::string> field_{};
  std::optional<std::uint32_t> fuzziness_{};
  std::optional<couchbase::match_operator> operator_{};
};
} // namespace couchbase