couchbase 4.2.9 → 4.2.11-rc.1

package/deps/couchbase-cxx-client/couchbase/scope_search_index_manager.hxx

@@ -0,0 +1,291 @@
+/* -*- 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/allow_querying_search_index_options.hxx>
+#include <couchbase/analyze_document_options.hxx>
+#include <couchbase/disallow_querying_search_index_options.hxx>
+#include <couchbase/drop_search_index_options.hxx>
+#include <couchbase/freeze_plan_search_index_options.hxx>
+#include <couchbase/get_all_search_indexes_options.hxx>
+#include <couchbase/get_indexed_search_index_options.hxx>
+#include <couchbase/get_search_index_options.hxx>
+#include <couchbase/pause_ingest_search_index_options.hxx>
+#include <couchbase/resume_ingest_search_index_options.hxx>
+#include <couchbase/unfreeze_plan_search_index_options.hxx>
+#include <couchbase/upsert_search_index_options.hxx>
+
+#include <future>
+
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+namespace couchbase
+{
+namespace core
+{
+class cluster;
+} // namespace core
+class search_index_manager_impl;
+} // namespace couchbase
+#endif
+
+namespace couchbase
+{
+class scope;
+
+class scope_search_index_manager
+{
+  public:
+    /**
+     * Fetches a scope-level index from the server if it exists
+     *
+     * @param index_name the name of the index
+     * @param options optional parameters
+     * @param handler  handler that implements @ref get_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void get_index(std::string index_name, const get_search_index_options& options, get_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto get_index(std::string index_name, const get_search_index_options& options = {}) const
+      -> std::future<std::pair<manager_error_context, management::search::index>>;
+
+    /**
+     * Fetches all scope-level indexes from the server
+     *
+     * @param options optional parameters
+     * @param handler  handler that implements @ref get_all_search_indexes_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void get_all_indexes(const get_all_search_indexes_options& options, get_all_search_indexes_handler&& handler) const;
+
+    [[nodiscard]] auto get_all_indexes(const get_all_search_indexes_options& options = {}) const
+      -> std::future<std::pair<manager_error_context, std::vector<management::search::index>>>;
+
+    /**
+     * Creates, or updates a scope-level index
+     *
+     * @param search_index the index definition including name and settings
+     * @param options optional parameters
+     * @param handler  handler that implements @ref upsert_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void upsert_index(const management::search::index& search_index,
+                      const upsert_search_index_options& options,
+                      upsert_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto upsert_index(const management::search::index& search_index, const upsert_search_index_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Drops a scope-level index
+     *
+     * @param index_name the name of the search index
+     * @param options optional parameters
+     * @param handler  handler that implements @ref drop_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void drop_index(std::string index_name, const drop_search_index_options& options, drop_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto drop_index(std::string index_name, const drop_search_index_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Retrieves the number of documents that have been indexed for a scope-level index
+     *
+     * @param index_name the name of the search index
+     * @param options optional parameters
+     * @param handler  handler that implements @ref get_indexed_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void get_indexed_documents_count(std::string index_name,
+                                     const get_indexed_search_index_options& options,
+                                     get_indexed_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto get_indexed_documents_count(std::string index_name, const get_indexed_search_index_options& options = {}) const
+      -> std::future<std::pair<manager_error_context, std::uint64_t>>;
+
+    /**
+     * Pauses updates and maintenance for a scope-level index.
+     *
+     * @param index_name the name of the search index
+     * @param options optional parameters
+     * @param handler  handler that implements @ref pause_ingest_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void pause_ingest(std::string index_name,
+                      const pause_ingest_search_index_options& options,
+                      pause_ingest_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto pause_ingest(std::string index_name, const pause_ingest_search_index_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Resumes updates and maintenance for a scope-level index.
+     *
+     * @param index_name the name of the search index
+     * @param options optional parameters
+     * @param handler  handler that implements @ref resume_ingest_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void resume_ingest(std::string index_name,
+                       const resume_ingest_search_index_options& options,
+                       resume_ingest_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto resume_ingest(std::string index_name, const resume_ingest_search_index_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Allows querying against a scope-level index
+     *
+     * @param index_name the name of the search index
+     * @param options optional parameters
+     * @param handler  handler that implements @ref allow_querying_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void allow_querying(std::string index_name,
+                        const allow_querying_search_index_options& options,
+                        allow_querying_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto allow_querying(std::string index_name, const allow_querying_search_index_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Disallows querying against a scope-level index
+     *
+     * @param index_name the name of the search index
+     * @param options optional parameters
+     * @param handler  handler that implements @ref disallow_querying_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void disallow_querying(std::string index_name,
+                           const disallow_querying_search_index_options& options,
+                           disallow_querying_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto disallow_querying(std::string index_name, const disallow_querying_search_index_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Freeze the assignment of scope-level index partitions to nodes.
+     *
+     * @param index_name the name of the search index
+     * @param options optional parameters
+     * @param handler  handler that implements @ref  freeze_plan_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void freeze_plan(std::string index_name,
+                     const freeze_plan_search_index_options& options,
+                     freeze_plan_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto freeze_plan(std::string index_name, const freeze_plan_search_index_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Unfreeze the assignment of scope-level index partitions to nodes.
+     *
+     * @param index_name the name of the search index
+     * @param options optional parameters
+     * @param handler  handler that implements @ref  unfreeze_plan_search_index_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void unfreeze_plan(std::string index_name,
+                       const unfreeze_plan_search_index_options& options,
+                       unfreeze_plan_search_index_handler&& handler) const;
+
+    [[nodiscard]] auto unfreeze_plan(std::string index_name, const unfreeze_plan_search_index_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Allows to see how a document is analyzed against a specific scope-level index.
+     *
+     * @param index_name the name of the search index
+     * @param document the document to be analyzed
+     * @param options optional parameters
+     * @param handler  handler that implements @ref analyze_document_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    template<typename Document>
+    void analyze_document(std::string index_name,
+                          Document document,
+                          const analyze_document_options& options,
+                          analyze_document_handler&& handler) const
+    {
+        auto encoded = couchbase::codec::default_json_transcoder::encode(document); // Encode as JSON and convert to string
+        auto decoded = std::string{ reinterpret_cast<const char*>(encoded.data.data()), encoded.data.size() };
+        return analyze_document(std::move(index_name), decoded, options, std::move(handler));
+    }
+
+    template<typename Document>
+    [[nodiscard]] auto analyze_document(std::string index_name, Document document, const analyze_document_options& options = {}) const
+      -> std::future<std::pair<manager_error_context, std::vector<std::string>>>
+    {
+        auto encoded = couchbase::codec::default_json_transcoder::encode(document); // Encode as JSON and convert to string
+        auto decoded = std::string{ reinterpret_cast<const char*>(encoded.data.data()), encoded.data.size() };
+
+        return analyze_document(std::move(index_name), decoded, options);
+    }
+
+    /**
+     * Allows to see how a document is analyzed against a specific scope-level index.
+     *
+     * @param index_name the name of the search index
+     * @param document the document to be analyzed encoded in JSON
+     * @param options optional parameters
+     * @param handler  handler that implements @ref analyze_document_handler
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    void analyze_document(std::string index_name,
+                          std::string document,
+                          const analyze_document_options& options,
+                          analyze_document_handler&& handler) const;
+
+    [[nodiscard]] auto analyze_document(std::string index_name, std::string document, const analyze_document_options& options) const
+      -> std::future<std::pair<manager_error_context, std::vector<std::string>>>;
+
+  private:
+    friend class scope;
+
+    explicit scope_search_index_manager(core::cluster core, std::string bucket_name, std::string scope_name);
+
+    std::shared_ptr<search_index_manager_impl> impl_;
+};
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/search_request.hxx

@@ -0,0 +1,120 @@
+/* -*- 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 <couchbase/vector_search.hxx>
+
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+namespace couchbase
+{
+namespace core
+{
+class cluster;
+} // namespace core
+class search_request_impl;
+} // namespace couchbase
+#endif
+
+namespace couchbase
+{
+/**
+ * A search_request is used to perform operations against the Full Text Search (FTS) Couchbase service.
+ *
+ * It can be used to send an FTS @ref search_query, and/or a @ref vector_search
+ *
+ * @since 1.0.0
+ * @volatile
+ */
+class search_request
+{
+  public:
+    /**
+     * Create a new search_request with a @ref search_query
+     *
+     * @param search_query the query to run
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    explicit search_request(const couchbase::search_query& search_query);
+
+    /**
+     * Create a new search_request with a @ref vector_search
+     *
+     * @param vector_search the vector_search to run
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    explicit search_request(const couchbase::vector_search& vector_search);
+
+    /**
+     * Used to run a @ref search_query together with an existing @ref vector_search.
+     * Note that a maximum of one SearchQuery and one VectorSearch can be provided.
+     *
+     * @param search_query the search_query to run with an existing vector_search.
+     *
+     * @return this search_request for chaining purposes.
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    auto search_query(const couchbase::search_query& search_query) -> search_request&;
+
+    /**
+     * Used to run a @ref vector_query together with an existing @ref search_query.
+     * Note that a maximum of one SearchQuery and one VectorSearch can be provided.
+     *
+     * @param vector_search the vector_search to be run with an existing search_query.
+     *
+     * @return this search_request for chaining purposes.
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    auto vector_search(const couchbase::vector_search& vector_search) -> search_request&;
+
+    /**
+     * @return encoded representation of the query.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] std::optional<encoded_search_query> search_query() const;
+
+    /**
+     * @return encoded representation of the vector search query.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] std::optional<encoded_search_query> vector_search() const;
+
+    /**
+     * @return vector_search_options, if set
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] std::optional<vector_search_options::built> vector_options();
+
+  private:
+    std::shared_ptr<search_request_impl> impl_;
+};
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/service_type.hxx

@@ -0,0 +1,58 @@
+/* -*- 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
+
+namespace couchbase
+{
+enum class service_type {
+    /**
+     * The Key-Value service (KV)
+     */
+    key_value,
+
+    /**
+     * The Query service (SQL++)
+     */
+    query,
+
+    /**
+     * The Analytics service
+     */
+    analytics,
+
+    /**
+     * The Search service (FTS)
+     */
+    search,
+
+    /**
+     * The View service
+     */
+    view,
+
+    /**
+     * The Cluster Manager service (ns_server)
+     */
+    management,
+
+    /**
+     * The Eventing service
+     */
+    eventing,
+};
+} // namespace couchbase

package/deps/couchbase-cxx-client/couchbase/update_collection_options.hxx

@@ -17,26 +17,55 @@
 
 #pragma once
 
-#include <functional>
+#include <couchbase/common_options.hxx>
+#include <couchbase/manager_error_context.hxx>
+
+#include <cstdint>
 #include <memory>
 #include <optional>
-#include <string>
 
 namespace couchbase
 {
 struct update_collection_options : public common_options<update_collection_options> {
   public:
+    /**
+     * Immutable value object representing consistent options.
+     *
+     * @since 1.0.0
+     * @internal
+     */
     struct built : public common_options<update_collection_options>::built {
     };
 
+    /**
+     * Validates the options and returns them as an immutable value.
+     *
+     * @return consistent options as an immutable value
+     *
+     * @exception std::system_error with code errc::common::invalid_argument if the options are not valid
+     *
+     * @since 1.0.0
+     * @internal
+     */
     [[nodiscard]] auto build() const -> built
     {
         return { build_common_options() };
     }
 };
 
+/**
+ * The settings that should be updated for the collection
+ */
 struct update_collection_settings {
-    std::optional<std::uint32_t> max_expiry{};
+    /**
+     * The maximum expiry, in seconds, for documents in this collection. Values greater than or equal to -1 are valid.
+     * Value of 0 sets max_expiry to the bucket-level setting and value of -1 to set it as no-expiry.
+     */
+    std::optional<std::int32_t> max_expiry{};
+
+    /**
+     * Whether history retention should be enabled.
+     */
     std::optional<bool> history{};
 };
 

package/deps/couchbase-cxx-client/couchbase/vector_query.hxx

@@ -0,0 +1,99 @@
+#include <utility>
+
+/* -*- 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
+
+namespace couchbase
+{
+/**
+ * @since 1.0.0
+ * @volatile
+ */
+class vector_query
+{
+  public:
+    /**
+     * Creates a vector query
+     *
+     * @param vector_field_name the document field that contains the vector
+     * @param vector_query the vector query to run. Cannot be empty.
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    vector_query(std::string vector_field_name, std::vector<double> vector_query)
+      : vector_field_name_{ std::move(vector_field_name) }
+      , vector_query_{ std::move(vector_query) }
+    {
+        if (vector_query_.empty()) {
+            throw std::invalid_argument("the vector_query cannot be empty");
+        }
+    }
+
+    /**
+     * The number of results that will be returned from this vector query. Defaults to 3.
+     *
+     * @param num_candidates the number of results returned
+     *
+     * @return this vector_query for chaining purposes
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    auto num_candidates(std::uint32_t num_candidates) -> vector_query&
+    {
+        if (num_candidates < 1) {
+            throw std::invalid_argument("The num_candidates cannot be less than 1");
+        }
+        num_candidates_ = num_candidates;
+        return *this;
+    }
+
+    /**
+     * The boost parameter is used to increase the relative weight of a clause (with a boost greater than 1) or decrease the relative weight
+     * (with a boost between 0 and 1).
+     *
+     * @param boost boost value
+     *
+     * @return this vector_query for chaining purposes.
+     *
+     * @since 1.0.0
+     * @volatile
+     */
+    auto boost(double boost) -> vector_query&
+    {
+        boost_ = boost;
+        return *this;
+    }
+
+    /**
+     * @return encoded representation of the query.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_query;
+
+  private:
+    std::string vector_field_name_;
+    std::vector<double> vector_query_;
+    std::uint32_t num_candidates_{ 3 };
+    std::optional<double> boost_{};
+};
+} // namespace couchbase