couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/boolean_query.hxx

@@ -30,194 +30,203 @@
 namespace couchbase
 {
 /**
- * The boolean query is a useful combination of conjunction and disjunction queries. A boolean query takes three lists of queries:
+ * 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.
+ * 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
+ * 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`.
+ * * 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
+ * @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;
-    }
+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;
-    }
+  /**
+   * 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();
+  /**
+   * 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;
-    }
+  /**
+   * 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;
-    }
+  /**
+   * 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();
+  /**
+   * 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;
-    }
+  /**
+   * 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;
-    }
+  /**
+   * 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();
+  /**
+   * 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;
+  /**
+   * @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_{};
+private:
+  std::optional<conjunction_query> must_{};
+  std::optional<disjunction_query> should_{};
+  std::optional<disjunction_query> must_not_{};
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/bucket.hxx

@@ -43,81 +43,82 @@ class bucket_impl;
  */
 class bucket
 {
-  public:
-    /**
-     * Opens default {@link scope}.
-     *
-     * @return the {@link scope} once opened.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto default_scope() const -> scope;
+public:
+  /**
+   * Opens default {@link scope}.
+   *
+   * @return the {@link scope} once opened.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto default_scope() const -> scope;
 
-    /**
-     * Opens the default collection for this bucket using the default scope.
-     *
-     * @return the opened default {@link collection}.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto default_collection() const -> collection;
+  /**
+   * Opens the default collection for this bucket using the default scope.
+   *
+   * @return the opened default {@link collection}.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto default_collection() const -> collection;
 
-    /**
-     * Opens the {@link scope} with the given name.
-     *
-     * @param scope_name the name of the scope.
-     * @return the {@link scope} once opened.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto scope(std::string_view scope_name) const -> scope;
+  /**
+   * Opens the {@link scope} with the given name.
+   *
+   * @param scope_name the name of the scope.
+   * @return the {@link scope} once opened.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto scope(std::string_view scope_name) const -> scope;
 
-    /**
-     * Performs application-level ping requests against services in the Couchbase cluster.
-     *
-     * @note This operation performs active I/O against services and endpoints to assess their health. If you do not
-     * wish to performs I/O, consider using @ref cluster::diagnostics() instead.
-     *
-     * @param options custom options to change the default behavior.
-     * @param handler the handler that implements @ref ping_handler.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void ping(const ping_options& options, ping_handler&& handler) const;
+  /**
+   * Performs application-level ping requests against services in the Couchbase cluster.
+   *
+   * @note This operation performs active I/O against services and endpoints to assess their health.
+   * If you do not wish to performs I/O, consider using @ref cluster::diagnostics() instead.
+   *
+   * @param options custom options to change the default behavior.
+   * @param handler the handler that implements @ref ping_handler.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void ping(const ping_options& options, ping_handler&& handler) const;
 
-    /**
-     * Performs application-level ping requests against services in the Couchbase cluster.
-     *
-     * @note This operation performs active I/O against services and endpoints to assess their health. If you do not
-     * wish to performs I/O, consider using @ref cluster::diagnostics() instead.
-     *
-     * @param options custom options to change the default behavior.
-     * @return future object that carries result of the operation.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto ping(const ping_options& options = {}) const -> std::future<ping_result>;
+  /**
+   * Performs application-level ping requests against services in the Couchbase cluster.
+   *
+   * @note This operation performs active I/O against services and endpoints to assess their health.
+   * If you do not wish to performs I/O, consider using @ref cluster::diagnostics() instead.
+   *
+   * @param options custom options to change the default behavior.
+   * @return future object that carries result of the operation.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto ping(const ping_options& options = {}) const
+    -> std::future<std::pair<error, ping_result>>;
 
-    /**
-     * Provides access to the collection management services.
-     *
-     * @return a manager instance
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto collections() const -> collection_manager;
+  /**
+   * Provides access to the collection management services.
+   *
+   * @return a manager instance
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto collections() const -> collection_manager;
 
-  private:
-    friend cluster;
+private:
+  friend cluster;
 
-    bucket(core::cluster core, std::string_view name);
+  bucket(core::cluster core, std::string_view name);
 
-    std::shared_ptr<bucket_impl> impl_;
+  std::shared_ptr<bucket_impl> impl_;
 };
 } // namespace couchbase