couchbase 3.4.1 → 3.4.3

data/ext/couchbase/couchbase/disjunction_query.hxx

@@ -0,0 +1,109 @@
+/* -*- 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 <cstdint>
+#include <memory>
+#include <vector>
+
+namespace couchbase
+{
+/**
+ * The disjunction query is a compound query. The result documents must satisfy a configurable minimal (@ref min) number of child queries.
+ * By default this min is set to 1.
+ *
+ * At execution, a conjunction query that has no child queries is not allowed and will fail fast.
+ *
+ * Match documents with at least one (see @ref min) of the following conditions is satisfied:
+ * * `"location"` in the field `reviews.content`
+ * * `true` in the field `free_breakfast`.
+ *
+ * @snippet test_unit_search.cxx search-disjunction
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-supported-queries-conjuncts-disjuncts.html server documentation
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class disjunction_query : public search_query
+{
+  public:
+    /**
+     * Create a disjunction query.
+     *
+     * @tparam SearchQuery any subclass of @ref search_query
+     * @param queries sequence of query arguments
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename... SearchQuery>
+    explicit disjunction_query(SearchQuery&&... queries)
+    {
+        or_else(std::forward<SearchQuery>(queries)...);
+    }
+
+    /**
+     * Add one or more queries to add to the disjunction.
+     *
+     * @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 or_else(SearchQuery... queries) -> disjunction_query&
+    {
+        (disjuncts_.emplace_back(std::make_shared<SearchQuery>(std::move(queries))), ...);
+        return *this;
+    }
+
+    /**
+     * Set the minimum number of child queries that must be satisfied for the disjunction query.
+     *
+     * @param number_of_queries minimum number of child queries.
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto min(std::uint32_t number_of_queries) -> disjunction_query&
+    {
+        min_ = number_of_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>> disjuncts_{};
+    std::uint32_t min_{ 1 };
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/doc_id_query.hxx

@@ -0,0 +1,111 @@
+/* -*- 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 <string>
+#include <vector>
+
+namespace couchbase
+{
+/**
+ * A doc_id query is a query that directly matches the documents whose ID have been provided. It can be combined within a conjunction_query
+ * to restrict matches on the set of documents.
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class doc_id_query : public search_query
+{
+  public:
+    doc_id_query() = default;
+
+    /**
+     * Create a new doc_id query.
+     *
+     * @param ids the list of document IDs to be restricted against.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    explicit doc_id_query(std::vector<std::string> ids)
+      : ids_{ std::move(ids) }
+    {
+    }
+
+    /**
+     * Create a new doc_id query.
+     *
+     * @param ids the list of document IDs to be restricted against.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    doc_id_query(std::initializer_list<std::string> ids)
+    {
+        ids_.reserve(ids.size());
+        doc_ids(ids);
+    }
+
+    /**
+     * Add IDs to the query.
+     *
+     * @param ids  the list of document identifiers to add
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto doc_ids(const std::vector<std::string>& ids) -> doc_id_query&
+    {
+        for (const auto& id : ids) {
+            ids_.push_back(id);
+        }
+        return *this;
+    }
+
+    /**
+     * Add ID to the query.
+     *
+     * @param id  the document identifier to add
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto doc_id(const std::string& id) -> doc_id_query&
+    {
+        ids_.push_back(id);
+        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::string> ids_{};
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/error_context.hxx

@@ -43,6 +43,7 @@ class error_context
      * @committed
      */
     error_context() = default;
+    virtual ~error_context() = default;
 
     /**
      * Creates and initializes error context with given parameters.
@@ -79,7 +80,7 @@ class error_context
      * @since 1.0.0
      * @committed
      */
-    [[nodiscard]] auto ec() const -> std::error_code
+    [[nodiscard]] virtual auto ec() const -> std::error_code
     {
         return ec_;
     }
@@ -105,7 +106,7 @@ class error_context
      * @since 1.0.0
      * @committed
      */
-    [[nodiscard]] auto last_dispatched_to() const -> const std::optional<std::string>&
+    [[nodiscard]] virtual auto last_dispatched_to() const -> const std::optional<std::string>&
     {
         return last_dispatched_to_;
     }
@@ -118,7 +119,7 @@ class error_context
      * @since 1.0.0
      * @committed
      */
-    [[nodiscard]] auto last_dispatched_from() const -> const std::optional<std::string>&
+    [[nodiscard]] virtual auto last_dispatched_from() const -> const std::optional<std::string>&
     {
         return last_dispatched_from_;
     }
@@ -131,7 +132,7 @@ class error_context
      * @since 1.0.0
      * @committed
      */
-    [[nodiscard]] auto retry_attempts() const -> std::size_t
+    [[nodiscard]] virtual auto retry_attempts() const -> std::size_t
     {
         return retry_attempts_;
     }
@@ -144,7 +145,7 @@ class error_context
      * @since 1.0.0
      * @committed
      */
-    [[nodiscard]] auto retry_reasons() const -> const std::set<retry_reason>&
+    [[nodiscard]] virtual auto retry_reasons() const -> const std::set<retry_reason>&
     {
         return retry_reasons_;
     }
@@ -158,7 +159,7 @@ class error_context
      * @since 1.0.0
      * @uncommitted
      */
-    [[nodiscard]] auto retried_because_of(retry_reason reason) const -> bool
+    [[nodiscard]] virtual auto retried_because_of(retry_reason reason) const -> bool
     {
         return retry_reasons_.count(reason) > 0;
     }

data/ext/couchbase/couchbase/fmt/analytics_scan_consistency.hxx

@@ -0,0 +1,52 @@
+/* -*- 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/analytics_scan_consistency.hxx>
+
+#include <fmt/core.h>
+
+/**
+ * Helper for fmtlib to format @ref couchbase::analytics_scan_consistency objects.
+ *
+ * @since 1.0.0
+ * @committed
+ */
+template<>
+struct fmt::formatter<couchbase::analytics_scan_consistency> {
+    template<typename ParseContext>
+    constexpr auto parse(ParseContext& ctx)
+    {
+        return ctx.begin();
+    }
+
+    template<typename FormatContext>
+    auto format(couchbase::analytics_scan_consistency mode, FormatContext& ctx) const
+    {
+        string_view name = "unknown";
+        switch (mode) {
+            case couchbase::analytics_scan_consistency::not_bounded:
+                name = "not_bounded";
+                break;
+            case couchbase::analytics_scan_consistency::request_plus:
+                name = "request_plus";
+                break;
+        }
+        return format_to(ctx.out(), "{}", name);
+    }
+};

data/ext/couchbase/couchbase/fmt/analytics_status.hxx

@@ -0,0 +1,76 @@
+/* -*- 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/analytics_status.hxx>
+
+#include <fmt/core.h>
+
+/**
+ * Helper for fmtlib to format @ref couchbase::analytics_status objects.
+ *
+ * @since 1.0.0
+ * @committed
+ */
+template<>
+struct fmt::formatter<couchbase::analytics_status> {
+    template<typename ParseContext>
+    constexpr auto parse(ParseContext& ctx)
+    {
+        return ctx.begin();
+    }
+
+    template<typename FormatContext>
+    auto format(couchbase::analytics_status status, FormatContext& ctx) const
+    {
+        string_view name = "unknown";
+        switch (status) {
+            case couchbase::analytics_status::running:
+                name = "running";
+                break;
+            case couchbase::analytics_status::success:
+                name = "success";
+                break;
+            case couchbase::analytics_status::errors:
+                name = "errors";
+                break;
+            case couchbase::analytics_status::completed:
+                name = "completed";
+                break;
+            case couchbase::analytics_status::stopped:
+                name = "stopped";
+                break;
+            case couchbase::analytics_status::timeout:
+                name = "timeout";
+                break;
+            case couchbase::analytics_status::closed:
+                name = "closed";
+                break;
+            case couchbase::analytics_status::fatal:
+                name = "fatal";
+                break;
+            case couchbase::analytics_status::aborted:
+                name = "aborted";
+                break;
+            case couchbase::analytics_status::unknown:
+                name = "unknown";
+                break;
+        }
+        return format_to(ctx.out(), "{}", name);
+    }
+};

data/ext/couchbase/couchbase/fmt/search_scan_consistency.hxx

@@ -0,0 +1,49 @@
+/* -*- 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_scan_consistency.hxx>
+
+#include <fmt/core.h>
+
+/**
+ * Helper for fmtlib to format @ref couchbase::search_scan_consistency objects.
+ *
+ * @since 1.0.0
+ * @committed
+ */
+template<>
+struct fmt::formatter<couchbase::search_scan_consistency> {
+    template<typename ParseContext>
+    constexpr auto parse(ParseContext& ctx)
+    {
+        return ctx.begin();
+    }
+
+    template<typename FormatContext>
+    auto format(couchbase::search_scan_consistency mode, FormatContext& ctx) const
+    {
+        string_view name = "unknown";
+        switch (mode) {
+            case couchbase::search_scan_consistency::not_bounded:
+                name = "not_bounded";
+                break;
+        }
+        return format_to(ctx.out(), "{}", name);
+    }
+};

data/ext/couchbase/couchbase/geo_bounding_box_query.hxx

@@ -0,0 +1,107 @@
+/* -*- 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/geo_point.hxx>
+#include <couchbase/search_query.hxx>
+
+#include <optional>
+#include <string>
+
+namespace couchbase
+{
+/**
+ * This query finds all @ref geo_point indexed matches within a given area (identified by the list of @ref geo_point coordinates). Each of
+ * the pairs is taken to indicate one corner of a polygon. Documents are returned if they reference a location within the area of the
+ * polygon.
+ *
+ * The following query-body uses an array of @ref geo_point to specify the latitude and longitude of each of the corners of a polygon, known
+ * as polygon points. Here, the last-specified entry is identical to the initial, thus explicitly closing the box. However, specifying an
+ * explicit closure in this way is optional: the closure will be inferred by the Couchbase Server if not explicitly specified.
+ * @snippet test_unit_search.cxx search-geo-bounding-box
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-supported-queries-geo-bounded-rectangle.html server documentation
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class geo_bounding_box_query : public search_query
+{
+  public:
+    /**
+     * Create a new geo bounding box query.
+     *
+     * @param top_left the top left coordinates signify the bounding box area
+     * @param bottom_right the bottom right coordinates signify the bounding box area
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    geo_bounding_box_query(geo_point top_left, geo_point bottom_right)
+      : top_left_{ top_left }
+      , bottom_right_{ bottom_right }
+    {
+    }
+
+    /**
+     * Create a new geo distance query.
+     *
+     * @param top_left_latitude  latitude of the top left coordinate
+     * @param top_left_longitude  longitude of the top left coordinate
+     * @param bottom_right_latitude  latitude of the bottom right coordinate
+     * @param bottom_right_longitude  latitude of the bottom right coordinate
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    geo_bounding_box_query(double top_left_latitude, double top_left_longitude, double bottom_right_latitude, double bottom_right_longitude)
+      : top_left_{ geo_point{ top_left_latitude, top_left_longitude } }
+      , bottom_right_{ geo_point{ bottom_right_latitude, bottom_right_longitude } }
+    {
+    }
+
+    /**
+     * If a field is specified, only terms in that field will be matched.
+     *
+     * @param field_name name of the field to be matched
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto field(std::string field_name) -> geo_bounding_box_query&
+    {
+        field_ = std::move(field_name);
+        return *this;
+    }
+
+    /**
+     * @return encoded representation of the query.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_query override;
+
+  private:
+    geo_point top_left_;
+    geo_point bottom_right_;
+    std::optional<std::string> field_{};
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/geo_distance_query.hxx

@@ -0,0 +1,109 @@
+/* -*- 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/geo_point.hxx>
+#include <couchbase/search_query.hxx>
+
+#include <optional>
+#include <string>
+
+namespace couchbase
+{
+/**
+ * This query finds all matches from a given location as @ref geo_point within the given distance. Both the point and the distance are
+ * required.
+ *
+ * The following query specifies a longitude of `-2.235143` and a latitude of `53.482358`. The target-field `geo` is specified, as is a
+ * distance of `100 miles`: this is the radius within which target-locations must reside for their documents to be returned.
+ * @snippet test_unit_search.cxx search-geo-distance
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-supported-queries-geo-point-distance.html server documentation
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class geo_distance_query : public search_query
+{
+  public:
+    /**
+     * Create a new geo distance query.
+     *
+     * @param location the location represents a point from which the distance is measured.
+     * @param distance the distance describes how far from the location the radius should be matched. For example, `"11km"`,
+     * `"11kilometers"`, `"3nm"`, `"3nauticalmiles"`, `"17mi"`, `"17miles"`, `"19m"`, `"19meters"`.
+     *
+     * @see https://github.com/blevesearch/bleve/blob/ae28975038cb25655da968e3f043210749ba382b/geo/geo_dist.go#L29-L37 list of distance
+     * units.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    geo_distance_query(geo_point location, std::string distance)
+      : location_{ location }
+      , distance_{ std::move(distance) }
+    {
+    }
+
+    /**
+     * Create a new geo distance query.
+     *
+     * @param latitude the location latitude
+     * @param longitude the location longitude
+     * @param distance the distance describes how far from the location the radius should be matched. For example, `"11km"`,
+     * `"11kilometers"`, `"3nm"`, `"3nauticalmiles"`, `"17mi"`, `"17miles"`, `"19m"`, `"19meters"`.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    geo_distance_query(double latitude, double longitude, std::string distance)
+      : location_{ geo_point{ latitude, longitude } }
+      , distance_{ std::move(distance) }
+    {
+    }
+
+    /**
+     * If a field is specified, only terms in that field will be matched.
+     *
+     * @param field_name name of the field to be matched
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto field(std::string field_name) -> geo_distance_query&
+    {
+        field_ = std::move(field_name);
+        return *this;
+    }
+
+    /**
+     * @return encoded representation of the query.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_query override;
+
+  private:
+    geo_point location_;
+    std::string distance_;
+    std::optional<std::string> field_{};
+};
+} // namespace couchbase