couchbase 3.4.2 → 3.4.3

data/ext/couchbase/couchbase/boolean_query.hxx

@@ -0,0 +1,223 @@
+/* -*- 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/conjunction_query.hxx>
+#include <couchbase/disjunction_query.hxx>
+#include <couchbase/match_all_query.hxx>
+#include <couchbase/match_none_query.hxx>
+#include <couchbase/search_query.hxx>
+
+#include <cstdint>
+#include <memory>
+#include <vector>
+
+namespace couchbase
+{
+/**
+ * The boolean query is a useful combination of conjunction and disjunction queries. A boolean query takes three lists of queries:
+ *
+ * * **must** - result documents must satisfy all of these queries.
+ * * **should** - result documents should satisfy these queries.
+ * * **must not** - result documents must not satisfy any of these queries.
+ *
+ * At execution, a boolean query that has no child queries in any 3 categories is not allowed and will fail fast.
+ *
+ * The inner representation of child queries in the `must`/`must_not`/`should` sections are respectively a @ref conjunction_query and two
+ * @ref disjunction_query.
+ *
+ * In the example below the following rules enforced by the boolean query:
+ * * retrieved documents MUST match `"hostel room"` in their `reviews.content` field AND have `true` in `free_breakfast` field.
+ * * also the documents SHOULD have EITHER `reviews.ratings.Overall > 4` OR `reviews.ratings.Service > 5`.
+ * * and finally, exclude documents with `city` `"Padfield"` or `"Gilingham"`.
+ *
+ * @snippet test_unit_search.cxx search-boolean
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-supported-queries-boolean-field-query.html server documentation
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class boolean_query : public search_query
+{
+  public:
+    /**
+     * Set @ref conjunction_query that groups all queries the documents **must** satisfy.
+     *
+     * @param query must-query
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto must(conjunction_query query) -> boolean_query&
+    {
+        must_ = std::move(query);
+        return *this;
+    }
+
+    /**
+     * Create @ref conjunction_query with given queries and set it as **must** query.
+     *
+     * @tparam SearchQuery any subclass of @ref search_query
+     * @param queries
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename... SearchQuery>
+    auto must(SearchQuery... queries) -> boolean_query&
+    {
+        must_ = conjunction_query(queries...);
+        return *this;
+    }
+
+    /**
+     * Returns @ref conjunction_query that groups all queries the documents **must** satisfy. Use it to add more queries.
+     *
+     * @return must-query
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto must() -> conjunction_query&
+    {
+        if (!must_) {
+            must_ = conjunction_query();
+        }
+        return must_.value();
+    }
+
+    /**
+     * Set @ref disjunction_query that groups  queries the documents **should** satisfy.
+     *
+     * @param query should-query
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto should(disjunction_query query) -> boolean_query&
+    {
+        should_ = std::move(query);
+        return *this;
+    }
+
+    /**
+     * Create @ref disjunction_query with given queries and set it as **should** query.
+     *
+     * @tparam SearchQuery any subclass of @ref search_query
+     * @param queries
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename... SearchQuery>
+    auto should(SearchQuery... queries) -> boolean_query&
+    {
+        should_ = disjunction_query(queries...);
+        return *this;
+    }
+
+    /**
+     * Returns @ref disjunction_query that groups  queries the documents **should** satisfy. Use it to add more queries or change
+     * @ref disjunction_query#min.
+     *
+     * @return should-query
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto should() -> disjunction_query&
+    {
+        if (!should_) {
+            should_ = disjunction_query();
+        }
+        return should_.value();
+    }
+
+    /**
+     * Set @ref disjunction_query that groups queries the documents **must not** satisfy.
+     *
+     * @param query must_not-query
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto must_not(disjunction_query query) -> boolean_query&
+    {
+        must_not_ = std::move(query);
+        return *this;
+    }
+
+    /**
+     * Create @ref disjunction_query with given queries and set it as **must not** query.
+     *
+     * @tparam SearchQuery any subclass of @ref search_query
+     * @param queries
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename... SearchQuery>
+    auto must_not(SearchQuery... queries) -> boolean_query&
+    {
+        must_not_ = disjunction_query(queries...);
+        return *this;
+    }
+
+    /**
+     * Returns @ref disjunction_query that groups  queries the documents **should** satisfy. Use it to add more queries.
+     *
+     * @return must_not-query
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto must_not() -> disjunction_query&
+    {
+        if (!must_not_) {
+            must_not_ = disjunction_query();
+        }
+        return must_not_.value();
+    }
+
+    /**
+     * @return encoded representation of the query.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_query override;
+
+  private:
+    std::optional<conjunction_query> must_{};
+    std::optional<disjunction_query> should_{};
+    std::optional<disjunction_query> must_not_{};
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/cluster.hxx

@@ -22,6 +22,8 @@
 #include <couchbase/cluster_options.hxx>
 #include <couchbase/query_index_manager.hxx>
 #include <couchbase/query_options.hxx>
+#include <couchbase/search_options.hxx>
+#include <couchbase/search_query.hxx>
 #include <couchbase/transactions.hxx>
 
 #include <memory>
@@ -166,6 +168,43 @@ class cluster
         return future;
     }
 
+    /**
+     * Performs a query against the full text search services.
+     *
+     * @param index_name name of the search index
+     * @param query query object, see hierarchy of @ref search_query for more details.
+     * @param options options to customize the query request.
+     * @param handler the handler that implements @ref search_handler
+     *
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @see https://docs.couchbase.com/server/current/fts/fts-introduction.html
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    void search_query(std::string index_name, const search_query& query, const search_options& options, search_handler&& handler) const;
+
+    /**
+     * Performs a query against the full text search services.
+     *
+     * @param index_name name of the search index
+     * @param query query object, see hierarchy of @ref search_query for more details.
+     * @param options options to customize the query request.
+     * @return future object that carries result of the operation
+     *
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @see https://docs.couchbase.com/server/current/fts/fts-introduction.html
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto search_query(std::string index_name, const class search_query& query, const search_options& options = {}) const
+      -> std::future<std::pair<search_error_context, search_result>>;
+
     /**
      * Performs a query against the analytics services.
      *
@@ -214,7 +253,9 @@ class cluster
     /**
      * Provides access to transaction services.
      *
-     * @return
+     * See {@link transactions} for details on using the transactions object.
+     *
+     * @return an {@link transactions} object
      *
      * @since 1.0.0
      * @committed

data/ext/couchbase/couchbase/conjunction_query.hxx

@@ -0,0 +1,88 @@
+/* -*- 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 <memory>
+#include <vector>
+
+namespace couchbase
+{
+/**
+ * The conjunction query is a compound query. The result documents must satisfy all of the child queries. It is possible to recursively nest
+ * compound queries.
+ *
+ * At execution, a conjunction query that has no child queries is not allowed and will fail fast.
+ *
+ * Match documents with `"location"` in the field `reviews.content` and `true` in the field `free_breakfast`.
+ * @snippet test_unit_search.cxx search-conjunction
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-supported-queries-conjuncts-disjuncts.html server documentation
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class conjunction_query : public search_query
+{
+  public:
+    /**
+     * Create a conjunction query.
+     *
+     * @tparam SearchQuery any subclass of @ref search_query
+     * @param queries sequence of query arguments
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename... SearchQuery>
+    explicit conjunction_query(SearchQuery&&... queries)
+    {
+        and_also(std::forward<SearchQuery>(queries)...);
+    }
+
+    /**
+     * Add one or more queries to add to the conjunction.
+     *
+     * @tparam SearchQuery any subclass of @ref search_query
+     * @param queries sequence of query arguments
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename... SearchQuery>
+    auto and_also(SearchQuery... queries) -> conjunction_query&
+    {
+        (conjuncts_.emplace_back(std::make_shared<SearchQuery>(std::move(queries))), ...);
+        return *this;
+    }
+
+    /**
+     * @return encoded representation of the query.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_query override;
+
+  private:
+    std::vector<std::shared_ptr<search_query>> conjuncts_{};
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/date_range.hxx

@@ -0,0 +1,69 @@
+/* -*- 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 <chrono>
+#include <cstdint>
+#include <ctime>
+#include <optional>
+#include <string>
+#include <variant>
+
+namespace couchbase
+{
+/**
+ * Date range for @ref date_range_facet.
+ */
+class date_range
+{
+  public:
+    date_range(std::string name, std::string start, std::string end);
+    date_range(std::string name, std::chrono::system_clock::time_point start, std::chrono::system_clock::time_point end);
+    date_range(std::string name, std::tm start, std::tm end);
+
+    static date_range with_start(std::string name, std::string start);
+    static date_range with_start(std::string name, std::chrono::system_clock::time_point start);
+    static date_range with_start(std::string name, std::tm start);
+
+    static date_range with_end(std::string name, std::string end);
+    static date_range with_end(std::string name, std::chrono::system_clock::time_point end);
+    static date_range with_end(std::string name, std::tm end);
+
+    [[nodiscard]] auto name() const -> const std::string&
+    {
+        return name_;
+    }
+
+    [[nodiscard]] auto start() const -> const std::optional<std::string>&
+    {
+        return start_;
+    }
+
+    [[nodiscard]] auto end() const -> const std::optional<std::string>&
+    {
+        return end_;
+    }
+
+  private:
+    date_range(std::string name, std::optional<std::string> start, std::optional<std::string> end);
+
+    std::string name_;
+    std::optional<std::string> start_{};
+    std::optional<std::string> end_{};
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/date_range_facet.hxx

@@ -0,0 +1,56 @@
+/* -*- 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/date_range.hxx>
+#include <couchbase/search_facet.hxx>
+
+#include <vector>
+
+namespace couchbase
+{
+/**
+ * A facet that categorizes rows into dateal ranges (or buckets) provided by the user.
+ */
+class date_range_facet : public search_facet
+{
+  public:
+    date_range_facet(std::string field, std::vector<date_range> ranges)
+      : search_facet{ std::move(field) }
+      , ranges_{ std::move(ranges) }
+    {
+    }
+
+    date_range_facet(std::string field, std::uint32_t size, std::vector<date_range> ranges)
+      : search_facet{ std::move(field), size }
+      , ranges_{ std::move(ranges) }
+    {
+    }
+
+    /**
+     * @return encoded representation of the search facet.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_facet override;
+
+  private:
+    std::vector<date_range> ranges_;
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/date_range_facet_result.hxx

@@ -0,0 +1,55 @@
+/* -*- 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/search_date_range.hxx>
+#include <couchbase/search_facet_result.hxx>
+
+#include <string>
+#include <vector>
+
+namespace couchbase
+{
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+class internal_date_range_facet_result;
+#endif
+
+/**
+ * @since 1.0.0
+ * @committed
+ */
+class date_range_facet_result : public search_facet_result
+{
+  public:
+    /**
+     * @since 1.0.0
+     * @internal
+     */
+    explicit date_range_facet_result(internal_date_range_facet_result internal);
+
+    [[nodiscard]] auto name() const -> const std::string& override;
+    [[nodiscard]] auto field() const -> const std::string& override;
+    [[nodiscard]] auto total() const -> std::uint64_t override;
+    [[nodiscard]] auto missing() const -> std::uint64_t override;
+    [[nodiscard]] auto other() const -> std::uint64_t override;
+    [[nodiscard]] auto date_ranges() const -> const std::vector<search_date_range>&;
+
+  private:
+    std::unique_ptr<internal_date_range_facet_result> internal_;
+};
+} // namespace couchbase