search_request.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/search_query.hxx>
#include <couchbase/vector_search.hxx>
 
#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
namespace couchbase
{
namespace core
{
class cluster;
} // namespace core
class search_request_impl;
} // namespace couchbase
#endif
 
namespace couchbase
{
class search_request
{
public:
  explicit search_request(const couchbase::search_query& search_query);
 
  explicit search_request(const couchbase::vector_search& vector_search);
 
  auto search_query(const couchbase::search_query& search_query) -> search_request&;
 
  auto vector_search(const couchbase::vector_search& vector_search) -> search_request&;
 
  [[nodiscard]] std::optional<encoded_search_query> search_query() const;
 
  [[nodiscard]] std::optional<encoded_search_query> vector_search() const;
 
  [[nodiscard]] std::optional<vector_search_options::built> vector_options();
 
private:
  std::shared_ptr<search_request_impl> impl_;
};
} // namespace couchbase