couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/query_profile.hxx

@@ -20,33 +20,36 @@
 namespace couchbase
 {
 enum class query_profile {
-    /**
-     * No profiling information is added to the query response.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    off = 0,
+  /**
+   * No profiling information is added to the query response.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  off = 0,
 
-    /**
-     * The query response includes a profile section with stats and details about various phases of the query plan and execution.
-     *
-     * Three phase times will be included in the system:active_requests and system:completed_requests monitoring keyspaces.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    phases,
+  /**
+   * The query response includes a profile section with stats and details about various phases of
+   * the query plan and execution.
+   *
+   * Three phase times will be included in the system:active_requests and system:completed_requests
+   * monitoring keyspaces.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  phases,
 
-    /**
-     * Besides the phase times, the profile section of the query response document will include a full query plan with timing and
-     * information about the number of processed documents at each phase.
-     *
-     * This information will be included in the system:active_requests and system:completed_requests keyspaces.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    timings,
+  /**
+   * Besides the phase times, the profile section of the query response document will include a full
+   * query plan with timing and information about the number of processed documents at each phase.
+   *
+   * This information will be included in the system:active_requests and system:completed_requests
+   * keyspaces.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  timings,
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/query_result.hxx

@@ -36,67 +36,68 @@ namespace couchbase
  */
 class query_result
 {
-  public:
-    /**
-     * @since 1.0.0
-     * @internal
-     */
-    query_result() = default;
+public:
+  /**
+   * @since 1.0.0
+   * @internal
+   */
+  query_result() = default;
 
-    /**
-     * @since 1.0.0
-     * @volatile
-     */
-    query_result(query_meta_data meta_data, std::vector<codec::binary> rows)
-      : meta_data_{ std::move(meta_data) }
-      , rows_{ std::move(rows) }
-    {
-    }
+  /**
+   * @since 1.0.0
+   * @volatile
+   */
+  query_result(query_meta_data meta_data, std::vector<codec::binary> rows)
+    : meta_data_{ std::move(meta_data) }
+    , rows_{ std::move(rows) }
+  {
+  }
 
-    /**
-     * Returns the {@link query_meta_data} giving access to the additional metadata associated with this query.
-     *
-     * @return response metadata
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto meta_data() const -> const query_meta_data&
-    {
-        return meta_data_;
-    }
+  /**
+   * Returns the {@link query_meta_data} giving access to the additional metadata associated with
+   * this query.
+   *
+   * @return response metadata
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto meta_data() const -> const query_meta_data&
+  {
+    return meta_data_;
+  }
 
-    /**
-     * @return list of query results as binary strings
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    [[nodiscard]] auto rows_as_binary() const -> const std::vector<codec::binary>&
-    {
-        return rows_;
-    }
+  /**
+   * @return list of query results as binary strings
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  [[nodiscard]] auto rows_as_binary() const -> const std::vector<codec::binary>&
+  {
+    return rows_;
+  }
 
-    template<typename Serializer,
-             typename Document = typename Serializer::document_type,
-             std::enable_if_t<codec::is_serializer_v<Serializer>, bool> = true>
-    [[nodiscard]] auto rows_as() const -> std::vector<Document>
-    {
-        std::vector<Document> rows;
-        rows.reserve(rows_.size());
-        for (const auto& row : rows_) {
-            rows.emplace_back(Serializer::template deserialize<Document>(row));
-        }
-        return rows;
+  template<typename Serializer,
+           typename Document = typename Serializer::document_type,
+           std::enable_if_t<codec::is_serializer_v<Serializer>, bool> = true>
+  [[nodiscard]] auto rows_as() const -> std::vector<Document>
+  {
+    std::vector<Document> rows;
+    rows.reserve(rows_.size());
+    for (const auto& row : rows_) {
+      rows.emplace_back(Serializer::template deserialize<Document>(row));
     }
+    return rows;
+  }
 
-    [[nodiscard]] auto rows_as_json() const -> std::vector<codec::tao_json_serializer::document_type>
-    {
-        return rows_as<codec::tao_json_serializer>();
-    }
+  [[nodiscard]] auto rows_as_json() const -> std::vector<codec::tao_json_serializer::document_type>
+  {
+    return rows_as<codec::tao_json_serializer>();
+  }
 
-  private:
-    query_meta_data meta_data_{};
-    std::vector<codec::binary> rows_{};
+private:
+  query_meta_data meta_data_{};
+  std::vector<codec::binary> rows_{};
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/query_scan_consistency.hxx

@@ -20,27 +20,30 @@
 namespace couchbase
 {
 enum class query_scan_consistency {
-    /**
-     * The indexer will return whatever state it has to the query engine at the time of query.
-     *
-     * This is the default (for single-statement requests). No timestamp vector is used in the index scan. This is also the fastest mode,
-     * because we avoid the cost of obtaining the vector, and we also avoid any wait for the index to catch up to the vector.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    not_bounded = 0,
+  /**
+   * The indexer will return whatever state it has to the query engine at the time of query.
+   *
+   * This is the default (for single-statement requests). No timestamp vector is used in the index
+   * scan. This is also the fastest mode, because we avoid the cost of obtaining the vector, and we
+   * also avoid any wait for the index to catch up to the vector.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  not_bounded = 0,
 
-    /**
-     * The indexer will wait until all mutations have been processed at the time of request before returning to the query engine.
-     *
-     * This implements strong consistency per request. Before processing the request, a current vector is obtained. The vector is used as a
-     * lower bound for the statements in the request. If there are DML statements in the request, RYOW ("read your own write") is also
-     * applied within the request.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    request_plus,
+  /**
+   * The indexer will wait until all mutations have been processed at the time of request before
+   * returning to the query engine.
+   *
+   * This implements strong consistency per request. Before processing the request, a current vector
+   * is obtained. The vector is used as a lower bound for the statements in the request. If there
+   * are DML statements in the request, RYOW
+   * ("read your own write") is also applied within the request.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  request_plus,
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/query_status.hxx

@@ -27,16 +27,16 @@ namespace couchbase
  * @committed
  */
 enum class query_status {
-    running,
-    success,
-    errors,
-    completed,
-    stopped,
-    timeout,
-    closed,
-    fatal,
-    aborted,
-    unknown,
+  running,
+  success,
+  errors,
+  completed,
+  stopped,
+  timeout,
+  closed,
+  fatal,
+  aborted,
+  unknown,
 };
 
 } // namespace couchbase

data/ext/couchbase/couchbase/query_string_query.hxx

@@ -26,47 +26,52 @@ namespace couchbase
 /**
  * The query string query allows humans to describe complex queries using a simple syntax.
  *
- * 1. When you specify multiple query-clauses, you can specify the relative importance to a given clause by suffixing it with the `^`
- * operator, followed by a number or by specifying the boost parameter with the number to boost the search. For example perform
- * @ref match_query for pool in both the name and description fields, but documents having the term in the name field score higher.
+ * 1. When you specify multiple query-clauses, you can specify the relative importance to a given
+ * clause by suffixing it with the `^` operator, followed by a number or by specifying the boost
+ * parameter with the number to boost the search. For example perform
+ * @ref match_query for pool in both the name and description fields, but documents having the term
+ * in the name field score higher.
  * @snippet test_unit_search.cxx search-query-string-boosting
  *
- * 2. You can perform date or numeric range searches by using the `>`, `>=`, `<`, and `<=` operators, followed by a date value in quotes.
- * For example, perform a @ref date_range_query on the created field for values after September 21, 2016.
+ * 2. You can perform date or numeric range searches by using the `>`, `>=`, `<`, and `<=`
+ * operators, followed by a date value in quotes. For example, perform a @ref date_range_query on
+ * the created field for values after September 21, 2016.
  * @snippet test_unit_search.cxx search-query-string-date-range
- * Or, perform a @ref numeric_range_query  on the `reviews.ratings.Cleanliness` field, for values greater than 4.
+ * Or, perform a @ref numeric_range_query  on the `reviews.ratings.Cleanliness` field, for values
+ * greater than 4.
  * @snippet test_unit_search.cxx search-query-string-numeric-range
  *
- * @see https://docs.couchbase.com/server/current/fts/fts-query-string-syntax.html definition of query syntax
+ * @see https://docs.couchbase.com/server/current/fts/fts-query-string-syntax.html definition of
+ * query syntax
  *
  * @since 1.0.0
  * @committed
  */
 class query_string_query : public search_query
 {
-  public:
-    /**
-     * Create a new query string query.
-     *
-     * @param query the query string to be analyzed and used against
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    explicit query_string_query(std::string query)
-      : query_{ std::move(query) }
-    {
-    }
+public:
+  /**
+   * Create a new query string query.
+   *
+   * @param query the query string to be analyzed and used against
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  explicit query_string_query(std::string query)
+    : query_{ std::move(query) }
+  {
+  }
 
-    /**
-     * @return encoded representation of the query.
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    [[nodiscard]] auto encode() const -> encoded_search_query override;
+  /**
+   * @return encoded representation of the query.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  [[nodiscard]] auto encode() const -> encoded_search_query override;
 
-  private:
-    std::string query_;
+private:
+  std::string query_;
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/query_warning.hxx

@@ -27,89 +27,93 @@ namespace couchbase
 /**
  * Represents a single warning returned from the query engine.
  *
- * @note warnings are not terminal errors but hints from the engine that something was not as expected.
+ * @note warnings are not terminal errors but hints from the engine that something was not as
+ * expected.
  *
  * @since 1.0.0
  * @committed
  */
 class query_warning
 {
-  public:
-    /**
-     * @since 1.0.0
-     * @internal
-     */
-    query_warning() = default;
+public:
+  /**
+   * @since 1.0.0
+   * @internal
+   */
+  query_warning() = default;
 
-    /**
-     * @since 1.0.0
-     * @volatile
-     */
-    query_warning(std::uint64_t code, std::string message, std::optional<std::uint64_t> reason, std::optional<bool> retry)
-      : code_{ code }
-      , message_{ std::move(message) }
-      , reason_{ std::move(reason) }
-      , retry_{ std::move(retry) }
-    {
-    }
+  /**
+   * @since 1.0.0
+   * @volatile
+   */
+  query_warning(std::uint64_t code,
+                std::string message,
+                std::optional<std::uint64_t> reason,
+                std::optional<bool> retry)
+    : code_{ code }
+    , message_{ std::move(message) }
+    , reason_{ std::move(reason) }
+    , retry_{ std::move(retry) }
+  {
+  }
 
-    /**
-     * Error code.
-     *
-     * @return error code
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto code() const -> std::uint64_t
-    {
-        return code_;
-    }
+  /**
+   * Error code.
+   *
+   * @return error code
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto code() const -> std::uint64_t
+  {
+    return code_;
+  }
 
-    /**
-     * Error message.
-     *
-     * @return human readable explanation
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto message() const -> const std::string&
-    {
-        return message_;
-    }
+  /**
+   * Error message.
+   *
+   * @return human readable explanation
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto message() const -> const std::string&
+  {
+    return message_;
+  }
 
-    /**
-     * Optional reason code that clarifies the error code.
-     *
-     * @return clarification of the error code
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    [[nodiscard]] auto reason() const -> const std::optional<std::uint64_t>&
-    {
-        return reason_;
-    }
+  /**
+   * Optional reason code that clarifies the error code.
+   *
+   * @return clarification of the error code
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  [[nodiscard]] auto reason() const -> const std::optional<std::uint64_t>&
+  {
+    return reason_;
+  }
 
-    /**
-     * Optional flag that indicates whether the request should be retried.
-     *
-     * @return non empty optional with `true` if the server requested retry.
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    [[nodiscard]] auto retry() const -> const std::optional<bool>&
-    {
-        return retry_;
-    }
+  /**
+   * Optional flag that indicates whether the request should be retried.
+   *
+   * @return non empty optional with `true` if the server requested retry.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  [[nodiscard]] auto retry() const -> const std::optional<bool>&
+  {
+    return retry_;
+  }
 
-  private:
-    std::uint64_t code_{};
-    std::string message_{};
-    std::optional<std::uint64_t> reason_{};
-    std::optional<bool> retry_{};
+private:
+  std::uint64_t code_{};
+  std::string message_{};
+  std::optional<std::uint64_t> reason_{};
+  std::optional<bool> retry_{};
 };
 
 } // namespace couchbase

data/ext/couchbase/couchbase/read_preference.hxx

@@ -0,0 +1,58 @@
+
+/* -*- 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
+
+namespace couchbase
+{
+/**
+ * Select read preference (or affinity) for the replica APIs such as:
+ *
+ * * collection::get_all_replicas
+ * * collection::get_any_replica
+ * * collection::lookup_in_all_replicas
+ * * collection::lookup_in_any_replica
+ *
+ * @note all strategies except read_preference::no_preference, reduce number of the nodes
+ * that the SDK will use for replica read operations. In other words, it will
+ * increase likelihood of getting `errc::key_value::document_irretrievable`
+ * error code if the filtered set of the nodes is empty, or do not have any
+ * documents available.
+ *
+ * @see https://docs.couchbase.com/server/current/manage/manage-groups/manage-groups.html
+ */
+enum class read_preference {
+  /**
+   * Do not enforce any filtering for replica set.
+   */
+  no_preference,
+
+  /**
+   * Exclude any nodes that do not belong to local group selected during
+   * cluster instantiation with network_options::preferred_server_group().
+   */
+  selected_server_group,
+
+  /**
+   * The same as read_preference::selected_server_group, but if the filtered
+   * replica set is empty, expand it to all available nodes (fall back to
+   * read_preference::no_preference effectively).
+   */
+  selected_server_group_or_all_available,
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/regexp_query.hxx

@@ -30,53 +30,54 @@ namespace couchbase
  * Match documents where field `reviews.content` contains words starting with `"inter"`:
  * @snippet test_unit_search.cxx search-regexp
  *
- * @see https://docs.couchbase.com/server/current/fts/fts-supported-queries-regexp.html server documentation
+ * @see https://docs.couchbase.com/server/current/fts/fts-supported-queries-regexp.html server
+ * documentation
  *
  * @since 1.0.0
  * @committed
  */
 class regexp_query : public search_query
 {
-  public:
-    /**
-     * Create a new regexp query.
-     *
-     * @param regexp the input string to be matched against
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    explicit regexp_query(std::string regexp)
-      : regexp_{ std::move(regexp) }
-    {
-    }
+public:
+  /**
+   * Create a new regexp query.
+   *
+   * @param regexp the input string to be matched against
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  explicit regexp_query(std::string regexp)
+    : regexp_{ std::move(regexp) }
+  {
+  }
 
-    /**
-     * 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) -> regexp_query&
-    {
-        field_ = std::move(field_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) -> regexp_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;
+  /**
+   * @return encoded representation of the query.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  [[nodiscard]] auto encode() const -> encoded_search_query override;
 
-  private:
-    std::string regexp_;
-    std::optional<std::string> field_{};
+private:
+  std::string regexp_;
+  std::optional<std::string> field_{};
 };
 } // namespace couchbase