couchbase 3.4.2 → 3.4.3

data/ext/couchbase/couchbase/date_range_query.hxx

@@ -0,0 +1,265 @@
+/* -*- 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 <chrono>
+#include <cstdint>
+#include <ctime>
+#include <optional>
+#include <string>
+
+namespace couchbase
+{
+/**
+ * The date range query finds documents containing a date value in the specified field within the specified range. Either start or end can
+ * be omitted, but not both.
+ *
+ * Match documents where field `review_date` falls within the range ("2001-10-09T10:20:30-08:00", "2016-10-31")
+ * @snippet test_unit_search.cxx search-date-range
+ *
+ * It also works with `std::tm` and `std::chrono::system_clock::time_point`.
+ * @snippet test_unit_search.cxx search-date-range-tm
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-supported-queries-date-range.html server documentation.
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class date_range_query : public search_query
+{
+  public:
+    /**
+     * Set lower limit and automatically format so that default date_time parser will be able to parse it on the server.
+     *
+     * @param value  start limit time point
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto start(std::chrono::system_clock::time_point value) -> date_range_query&;
+
+    /**
+     * Set lower limit and automatically format so that default date_time parser will be able to parse it on the server.
+     *
+     * @param value start limit as a `tm` (broken down timestamp)
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto start(std::tm value) -> date_range_query&;
+
+    /**
+     * Set lower limit and automatically format so that default date_time parser will be able to parse it on the server.
+     *
+     * @param value  start limit time point
+     * @param inclusive whether to include limit value into the interval.
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto start(std::chrono::system_clock::time_point value, bool inclusive) -> date_range_query&;
+
+    /**
+     * Set lower limit and automatically format so that default date_time parser will be able to parse it on the server.
+     *
+     * @param value start limit as a `tm` (broken down timestamp)
+     * @param inclusive whether to include limit value into the interval.
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto start(std::tm value, bool inclusive) -> date_range_query&;
+
+    /**
+     * Set preformatted date as lower limit.
+     *
+     * @param value  start limit formatted as a string, use @ref date_time_parser() for non-standard formats
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto start(std::string value) -> date_range_query&
+    {
+        start_ = std::move(value);
+        return *this;
+    }
+
+    /**
+     * Set preformatted date as lower limit.
+     *
+     * @param value  start limit formatted as a string, use @ref date_time_parser() for non-standard formats
+     * @param inclusive whether to include limit value into the interval.
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto start(std::string value, bool inclusive) -> date_range_query&
+    {
+        start_ = std::move(value);
+        inclusive_start_ = inclusive;
+        return *this;
+    }
+
+    /**
+     * Set upper limit and automatically format so that default date_time parser will be able to parse it on the server.
+     *
+     * @param value  end limit time point
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto end(std::chrono::system_clock::time_point value) -> date_range_query&;
+
+    /**
+     * Set upper limit and automatically format so that default date_time parser will be able to parse it on the server.
+     *
+     * @param value end limit as a `tm` (broken down timestamp)
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto end(std::tm value) -> date_range_query&;
+
+    /**
+     * Set upper limit and automatically format so that default date_time parser will be able to parse it on the server.
+     *
+     * @param value  end limit time point
+     * @param inclusive whether to include limit value into the interval.
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto end(std::chrono::system_clock::time_point value, bool inclusive) -> date_range_query&;
+
+    /**
+     * Set upper limit and automatically format so that default date_time parser will be able to parse it on the server.
+     *
+     * @param value end limit as a `tm` (broken down timestamp)
+     * @param inclusive whether to include limit value into the interval.
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto end(std::tm value, bool inclusive) -> date_range_query&;
+
+    /**
+     * Set preformatted date as upper limit.
+     *
+     * @param value  end limit formatted as a string, use @ref date_time_parser() for non-standard formats
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto end(std::string value)
+    {
+        end_ = std::move(value);
+        return *this;
+    }
+
+    /**
+     * Set preformatted date as upper limit.
+     *
+     * @param value  end limit formatted as a string, use @ref date_time_parser() for non-standard formats
+     * @param inclusive whether to include limit value into the interval.
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto end(std::string value, bool inclusive) -> date_range_query&
+    {
+        end_ = std::move(value);
+        inclusive_end_ = inclusive;
+        return *this;
+    }
+
+    /**
+     * Enable custom date parser.
+     *
+     * @param parser_name name of the custom date parser
+     *
+     * @return this query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto date_time_parser(std::string parser_name) -> date_range_query&
+    {
+        date_time_parser_ = std::move(parser_name);
+        return *this;
+    }
+
+    /**
+     * 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) -> date_range_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:
+    std::optional<std::string> start_{};
+    std::optional<std::string> end_{};
+    std::optional<bool> inclusive_start_{};
+    std::optional<bool> inclusive_end_{};
+    std::optional<std::string> date_time_parser_{};
+    std::optional<std::string> field_{};
+};
+} // namespace couchbase

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/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);
+    }
+};