couchbase 3.4.2 → 3.4.4

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/bucket_manager.hxx

@@ -0,0 +1,135 @@
+/* -*- 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/create_bucket_options.hxx>
+#include <couchbase/drop_bucket_options.hxx>
+#include <couchbase/flush_bucket_options.hxx>
+#include <couchbase/get_all_buckets_options.hxx>
+#include <couchbase/get_bucket_options.hxx>
+#include <couchbase/update_bucket_options.hxx>
+
+#include <future>
+#include <memory>
+
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+namespace couchbase::core
+{
+class cluster;
+} // namespace couchbase::core
+#endif
+
+namespace couchbase
+{
+class cluster;
+
+class bucket_manager
+{
+  public:
+    /**
+     * Get specific bucket within the cluster
+     *
+     * @param bucket_name the name of the bucket to get
+     * @param options optional parameters
+     * @param handler  handler that implements @ref get_bucket_handler
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    void get_bucket(std::string bucket_name, const get_bucket_options& options, get_bucket_handler&& handler) const;
+
+    [[nodiscard]] auto get_bucket(std::string bucket_name, const get_bucket_options& options = {}) const
+      -> std::future<std::pair<manager_error_context, management::cluster::bucket_settings>>;
+
+    /**
+     * Get all buckets on the cluster
+     *
+     * @param options optional parameters
+     * @param handler handler that implements @ref get_all_buckets_handler
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    void get_all_buckets(const get_all_buckets_options& options, get_all_buckets_handler&& handler) const;
+
+    [[nodiscard]] auto get_all_buckets(const get_all_buckets_options& options = {}) const
+      -> std::future<std::pair<manager_error_context, std::vector<management::cluster::bucket_settings>>>;
+
+    /**
+     * Create a bucket on the cluster
+     *
+     * @param bucket_settings the settings for the bucket
+     * @param options optional parameters
+     * @param handler handler that implements @ref create_bucket_handler
+     */
+    void create_bucket(const management::cluster::bucket_settings& bucket_settings,
+                       const create_bucket_options& options,
+                       create_bucket_handler&& handler) const;
+
+    [[nodiscard]] auto create_bucket(const management::cluster::bucket_settings& bucket_settings,
+                                     const create_bucket_options& options = {}) const -> std::future<manager_error_context>;
+
+    /**
+     * Update an existing bucket
+     *
+     * @param bucket_settings the settings for the bucket
+     * @param options optional parameters
+     * @param handler handler that implements @ref update_bucket_handler
+     */
+    void update_bucket(const management::cluster::bucket_settings& bucket_settings,
+                       const update_bucket_options& options,
+                       update_bucket_handler&& handler) const;
+
+    [[nodiscard]] auto update_bucket(const management::cluster::bucket_settings& bucket_settings,
+                                     const update_bucket_options& options = {}) const -> std::future<manager_error_context>;
+
+    /**
+     * Drop an existing bucket
+     *
+     * @param bucket_name the name of the bucket to drop
+     * @param options optional parameters
+     * @param handler handler that implements @ref drop_bucket_handler
+     */
+    void drop_bucket(std::string bucket_name, const drop_bucket_options& options, drop_bucket_handler&& handler) const;
+
+    [[nodiscard]] auto drop_bucket(std::string bucket_name, const drop_bucket_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Flush an existing bucket
+     *
+     * @param bucket_name the name of the bucket to flush
+     * @param options optional parameters
+     * @param handler handler that implements @ref flush_bucket_handler
+     */
+    void flush_bucket(std::string bucket_name, const flush_bucket_options& options, flush_bucket_handler&& handler) const;
+
+    [[nodiscard]] auto flush_bucket(std::string bucket_name, const flush_bucket_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+  private:
+    friend class cluster;
+
+    explicit bucket_manager(std::shared_ptr<couchbase::core::cluster> core)
+      : core_(std::move(core))
+    {
+    }
+
+    std::shared_ptr<couchbase::core::cluster> core_;
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/build_query_index_options.hxx

@@ -66,34 +66,4 @@ class build_query_index_options : public common_options<build_query_index_option
  * @uncommitted
  */
 using build_deferred_query_indexes_handler = std::function<void(couchbase::manager_error_context)>;
-
-#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
-namespace core
-{
-class cluster;
-class query_context;
-namespace impl
-{
-
-/**
- * @since 1.0.0
- * @internal
- */
-void
-initiate_build_deferred_indexes(std::shared_ptr<couchbase::core::cluster> resp1,
-                                std::string bucket_name,
-                                build_query_index_options::built options,
-                                query_context query_ctx,
-                                std::string collection_name,
-                                build_deferred_query_indexes_handler&& handler);
-
-void
-initiate_build_deferred_indexes(std::shared_ptr<couchbase::core::cluster> resp1,
-                                std::string bucket_name,
-                                build_query_index_options::built options,
-                                build_deferred_query_indexes_handler&& handler);
-
-#endif
-} // namespace impl
-} // namespace core
 } // namespace couchbase

data/ext/couchbase/couchbase/cluster.hxx

@@ -19,9 +19,12 @@
 
 #include <couchbase/analytics_options.hxx>
 #include <couchbase/bucket.hxx>
+#include <couchbase/bucket_manager.hxx>
 #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 +169,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.
      *
@@ -211,10 +251,25 @@ class cluster
         return query_index_manager{ core_ };
     }
 
+    /**
+     * Provides access to the bucket management services.
+     *
+     * @return a manager instance
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto buckets() const -> bucket_manager
+    {
+        return bucket_manager{ core_ };
+    }
+
     /**
      * 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/collection.hxx

@@ -28,6 +28,8 @@
 #include <couchbase/get_any_replica_options.hxx>
 #include <couchbase/get_options.hxx>
 #include <couchbase/insert_options.hxx>
+#include <couchbase/lookup_in_all_replicas_options.hxx>
+#include <couchbase/lookup_in_any_replica_options.hxx>
 #include <couchbase/lookup_in_options.hxx>
 #include <couchbase/lookup_in_specs.hxx>
 #include <couchbase/mutate_in_options.hxx>
@@ -856,6 +858,115 @@ class collection
         return future;
     }
 
+    /**
+     * Performs lookups to document fragments with default options from all replicas and the active node and returns the result as a vector.
+     *
+     * @tparam Handler type of the handler that implements @ref lookup_in_all_replicas_handler
+     *
+     * @param document_id the outer document ID
+     * @param specs an object that specifies the types of lookups to perform
+     * @param options custom options to modify the lookup options
+     * @param handler callable that implements @ref lookup_in_all_replicas_handler
+     *
+     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename Handler>
+    void lookup_in_all_replicas(std::string document_id,
+                                lookup_in_specs specs,
+                                const lookup_in_all_replicas_options& options,
+                                Handler&& handler) const
+    {
+        return core::impl::initiate_lookup_in_all_replicas_operation(
+          core_, bucket_name_, scope_name_, name_, std::move(document_id), specs.specs(), options.build(), std::forward<Handler>(handler));
+    }
+
+    /**
+     * Performs lookups to document fragments with default options from all replicas and the active node and returns the result as a vector.
+     *
+     * @param document_id the outer document ID
+     * @param specs an object that specifies the types of lookups to perform
+     * @param options custom options to modify the lookup options
+     * @return future object that carries result of the operation
+     *
+     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto lookup_in_all_replicas(std::string document_id,
+                                              lookup_in_specs specs,
+                                              const lookup_in_all_replicas_options& options = {}) const
+      -> std::future<std::pair<subdocument_error_context, lookup_in_all_replicas_result>>
+    {
+        auto barrier = std::make_shared<std::promise<std::pair<subdocument_error_context, lookup_in_all_replicas_result>>>();
+        auto future = barrier->get_future();
+        lookup_in_all_replicas(std::move(document_id), std::move(specs), options, [barrier](auto ctx, auto result) {
+            barrier->set_value({ std::move(ctx), std::move(result) });
+        });
+        return future;
+    }
+
+    /**
+     * Performs lookups to document fragments with default options from all replicas and returns the first found.
+     *
+     * @tparam Handler type of the handler that implements @ref lookup_in_any_replica_handler
+     *
+     * @param document_id the outer document ID
+     * @param specs an object that specifies the types of lookups to perform
+     * @param options custom options to modify the lookup options
+     *
+     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    template<typename Handler>
+    void lookup_in_any_replica(std::string document_id,
+                               lookup_in_specs specs,
+                               const lookup_in_any_replica_options& options,
+                               Handler&& handler) const
+    {
+        return core::impl::initiate_lookup_in_any_replica_operation(
+          core_, bucket_name_, scope_name_, name_, std::move(document_id), specs.specs(), options.build(), std::forward<Handler>(handler));
+    }
+
+    /**
+     * Performs lookups to document fragments with default options from all replicas and returns the first found.
+     *
+     * @param document_id the outer document ID
+     * @param specs an object that specifies the types of lookups to perform
+     * @param options custom options to modify the lookup options
+     * @return future object that carries result of the operation
+     *
+     * @exception errc::key_value::document_not_found the given document id is not found in the collection.
+     * @exception errc::common::ambiguous_timeout
+     * @exception errc::common::unambiguous_timeout
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto lookup_in_any_replica(std::string document_id,
+                                             lookup_in_specs specs,
+                                             const lookup_in_any_replica_options& options = {}) const
+      -> std::future<std::pair<subdocument_error_context, lookup_in_replica_result>>
+    {
+        auto barrier = std::make_shared<std::promise<std::pair<subdocument_error_context, lookup_in_replica_result>>>();
+        auto future = barrier->get_future();
+        lookup_in_any_replica(std::move(document_id), std::move(specs), options, [barrier](auto ctx, auto result) {
+            barrier->set_value({ std::move(ctx), std::move(result) });
+        });
+        return future;
+    }
+
     /**
      * Gets a document for a given id and places a pessimistic lock on it for mutations
      *