couchbase 3.4.3 → 3.4.5

data/ext/couchbase/couchbase/behavior_options.hxx

@@ -60,6 +60,21 @@ class behavior_options
         return *this;
     }
 
+    /**
+     * Selects network to use.
+     *
+     * @param name network name as it is exposed in the configuration.
+     * @return this object for chaining purposes.
+     *
+     * @see https://docs.couchbase.com/server/current/learn/clusters-and-availability/connectivity.html#alternate-addresses
+     * @see https://docs.couchbase.com/server/current/rest-api/rest-set-up-alternate-address.html
+     */
+    auto network(std::string name) -> behavior_options&
+    {
+        network_ = std::move(name);
+        return *this;
+    }
+
     struct built {
         std::string user_agent_extra;
         bool show_queries;
@@ -67,13 +82,14 @@ class behavior_options
         bool enable_mutation_tokens;
         bool enable_unordered_execution;
         bool dump_configuration;
+        std::string network;
     };
 
     [[nodiscard]] auto build() const -> built
     {
         return {
-            user_agent_extra_,           show_queries_,       enable_clustermap_notification_, enable_mutation_tokens_,
-            enable_unordered_execution_, dump_configuration_,
+            user_agent_extra_,   show_queries_, enable_clustermap_notification_, enable_mutation_tokens_, enable_unordered_execution_,
+            dump_configuration_, network_,
         };
     }
 
@@ -84,5 +100,6 @@ class behavior_options
     bool enable_mutation_tokens_{ true };
     bool enable_unordered_execution_{ true };
     bool dump_configuration_{ false };
+    std::string network_{ "auto" };
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/bucket.hxx

@@ -18,6 +18,7 @@
 #pragma once
 
 #include <couchbase/collection.hxx>
+#include <couchbase/collection_manager.hxx>
 #include <couchbase/scope.hxx>
 
 #include <memory>
@@ -82,6 +83,19 @@ class bucket
         return { core_, name_, scope_name };
     }
 
+    /**
+     * Provides access to the collection management services.
+     *
+     * @return a manager instance
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto collections() const -> collection_manager
+    {
+        return collection_manager{ core_, name_ };
+    }
+
   private:
     friend class cluster;
 

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,6 +19,7 @@
 
 #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>
@@ -250,6 +251,19 @@ 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.
      *

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
      *

data/ext/couchbase/couchbase/collection_manager.hxx

@@ -0,0 +1,160 @@
+/* -*- 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_collection_options.hxx>
+#include <couchbase/create_scope_options.hxx>
+#include <couchbase/drop_collection_options.hxx>
+#include <couchbase/drop_scope_options.hxx>
+#include <couchbase/get_all_scopes_options.hxx>
+#include <couchbase/management/collection_spec.hxx>
+#include <couchbase/update_collection_options.hxx>
+
+#include <future>
+#include <memory>
+
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+namespace couchbase::core
+{
+class cluster;
+} // namespace couchbase::core
+#endif
+
+namespace couchbase
+{
+class bucket;
+
+class collection_manager
+{
+  public:
+    /**
+     * Get all scopes on the bucket
+     *
+     * @param options optional parameters
+     * @param handler handler that implements @ref get_all_scopes_handler
+     *
+     * @since 1.0.0
+     */
+    void get_all_scopes(const get_all_scopes_options& options, get_all_scopes_handler&& handler) const;
+
+    [[nodiscard]] auto get_all_scopes(const get_all_scopes_options& options = {}) const
+      -> std::future<std::pair<manager_error_context, std::vector<management::bucket::scope_spec>>>;
+
+    /**
+     * Creates a new collection
+     *
+     * @param scope_name the name of the scope to create the collection on
+     * @param collection_name the collection name
+     * @param settings create collection settings
+     * @param options optional parameters
+     * @param handler handler that implements @ref create_collection_handler
+     *
+     * @since 1.0.0
+     */
+    void create_collection(std::string scope_name,
+                           std::string collection_name,
+                           const create_collection_settings& settings,
+                           const create_collection_options& options,
+                           create_collection_handler&& handler) const;
+
+    [[nodiscard]] auto create_collection(std::string scope_name,
+                                         std::string collection_name,
+                                         const create_collection_settings& settings = {},
+                                         const create_collection_options& options = {}) const -> std::future<manager_error_context>;
+    /**
+     * Updates an existing collection
+     *
+     * @param scope_name the name of the scope on which the collection exists
+     * @param collection_name the collection name
+     * @param settings update collection settings
+     * @param options optional parameters
+     * @param handler handler that implements @ref update_collection_handler
+     *
+     * @since 1.0.0
+     */
+    void update_collection(std::string scope_name,
+                           std::string collection_name,
+                           const update_collection_settings& settings,
+                           const update_collection_options& options,
+                           update_collection_handler&& handler) const;
+
+    [[nodiscard]] auto update_collection(std::string scope_name,
+                                         std::string collection_name,
+                                         const update_collection_settings& settings,
+                                         const update_collection_options& options = {}) const -> std::future<manager_error_context>;
+
+    /**
+     * Drops a collection
+     *
+     * @param scope_name the name of the scope on which the collection exists
+     * @param collection_name the collection name
+     * @param options optional parameters
+     * @param handler handler that implements @ref drop_collection_handler
+     *
+     * @since 1.0.0
+     */
+    void drop_collection(std::string scope_name,
+                         std::string collection_name,
+                         const drop_collection_options& options,
+                         drop_collection_handler&& handler) const;
+
+    [[nodiscard]] auto drop_collection(std::string scope_name,
+                                       std::string collection_name,
+                                       const drop_collection_options& options = {}) const -> std::future<manager_error_context>;
+
+    /**
+     * Creates a scope on the bucket
+     *
+     * @param scope_name the scope name
+     * @param options optional parameters
+     * @param handler handler that implements @ref create_scope_handler
+     *
+     * @since 1.0.0
+     */
+    void create_scope(std::string scope_name, const create_scope_options& options, create_scope_handler&& handler) const;
+
+    [[nodiscard]] auto create_scope(std::string scope_name, const create_scope_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+    /**
+     * Drops a scope on the bucket
+     *
+     * @param scope_name the scope name
+     * @param options optional parameters
+     * @param handler handler that implements @ref drop_scope_handler
+     *
+     * @since 1.0.0
+     */
+    void drop_scope(std::string scope_name, const drop_scope_options& options, drop_scope_handler&& handler) const;
+
+    [[nodiscard]] auto drop_scope(std::string scope_name, const drop_scope_options& options = {}) const
+      -> std::future<manager_error_context>;
+
+  private:
+    friend class bucket;
+
+    explicit collection_manager(std::shared_ptr<couchbase::core::cluster> core, std::string bucket_name)
+      : core_(std::move(core))
+      , bucket_name_(std::move(bucket_name))
+    {
+    }
+
+    std::shared_ptr<couchbase::core::cluster> core_;
+    std::string bucket_name_;
+};
+} // namespace couchbase

data/ext/couchbase/couchbase/collection_query_index_manager.hxx

@@ -64,13 +64,7 @@ class collection_query_index_manager
     void get_all_indexes(const get_all_query_indexes_options& options, get_all_query_indexes_handler&& handler) const;
 
     [[nodiscard]] auto get_all_indexes(const get_all_query_indexes_options& options) const
-      -> std::future<std::pair<manager_error_context, std::vector<couchbase::management::query::index>>>
-    {
-        auto barrier = std::make_shared<std::promise<std::pair<manager_error_context, std::vector<couchbase::management::query::index>>>>();
-        auto future = barrier->get_future();
-        get_all_indexes(options, [barrier](auto ctx, auto resp) { barrier->set_value({ ctx, resp }); });
-        return future;
-    }
+      -> std::future<std::pair<manager_error_context, std::vector<couchbase::management::query::index>>>;
     /**
      * Create an index on the collection.
      *
@@ -89,13 +83,7 @@ class collection_query_index_manager
 
     [[nodiscard]] auto create_index(std::string index_name,
                                     std::vector<std::string> fields,
-                                    const create_query_index_options& options) const -> std::future<manager_error_context>
-    {
-        auto barrier = std::make_shared<std::promise<manager_error_context>>();
-        auto future = barrier->get_future();
-        create_index(std::move(index_name), std::move(fields), options, [barrier](auto ctx) { barrier->set_value(ctx); });
-        return future;
-    }
+                                    const create_query_index_options& options) const -> std::future<manager_error_context>;
 
     /**
      * Create a primary index on a collection.
@@ -108,13 +96,7 @@ class collection_query_index_manager
      */
     void create_primary_index(const create_primary_query_index_options& options, create_query_index_handler&& handler) const;
 
-    [[nodiscard]] auto create_primary_index(const create_primary_query_index_options& options) -> std::future<manager_error_context>
-    {
-        auto barrier = std::make_shared<std::promise<manager_error_context>>();
-        auto future = barrier->get_future();
-        create_primary_index(options, [barrier](auto ctx) { barrier->set_value(ctx); });
-        return future;
-    }
+    [[nodiscard]] auto create_primary_index(const create_primary_query_index_options& options) -> std::future<manager_error_context>;
     /**
      * Drop primary index on a collection.
      *
@@ -126,13 +108,7 @@ class collection_query_index_manager
      */
     void drop_primary_index(const drop_primary_query_index_options& options, drop_query_index_handler&& handler) const;
 
-    [[nodiscard]] auto drop_primary_index(const drop_primary_query_index_options& options) const -> std::future<manager_error_context>
-    {
-        auto barrier = std::make_shared<std::promise<manager_error_context>>();
-        auto future = barrier->get_future();
-        drop_primary_index(options, [barrier](auto ctx) { barrier->set_value(ctx); });
-        return future;
-    }
+    [[nodiscard]] auto drop_primary_index(const drop_primary_query_index_options& options) const -> std::future<manager_error_context>;
 
     /**
      * Drop index in collection.
@@ -146,13 +122,7 @@ class collection_query_index_manager
      */
     void drop_index(std::string index_name, const drop_query_index_options& options, drop_query_index_handler&& handler) const;
 
-    [[nodiscard]] auto drop_index(std::string index_name, const drop_query_index_options& options) -> std::future<manager_error_context>
-    {
-        auto barrier = std::make_shared<std::promise<manager_error_context>>();
-        auto future = barrier->get_future();
-        drop_index(std::move(index_name), options, [barrier](auto ctx) { barrier->set_value(ctx); });
-        return future;
-    }
+    [[nodiscard]] auto drop_index(std::string index_name, const drop_query_index_options& options) -> std::future<manager_error_context>;
     /**
      * Builds all currently deferred indexes in this collection.
      *
@@ -166,13 +136,7 @@ class collection_query_index_manager
      */
     void build_deferred_indexes(const build_query_index_options& options, build_deferred_query_indexes_handler&& handler) const;
 
-    [[nodiscard]] auto build_deferred_indexes(const build_query_index_options& options) const -> std::future<manager_error_context>
-    {
-        auto barrier = std::make_shared<std::promise<manager_error_context>>();
-        auto future = barrier->get_future();
-        build_deferred_indexes(options, [barrier](auto ctx) { barrier->set_value(std::move(ctx)); });
-        return future;
-    }
+    [[nodiscard]] auto build_deferred_indexes(const build_query_index_options& options) const -> std::future<manager_error_context>;
 
     /**
      * Polls the state of a set of indexes, until they all are online.
@@ -189,12 +153,7 @@ class collection_query_index_manager
                        watch_query_indexes_handler&& handler) const;
 
     [[nodiscard]] auto watch_indexes(std::vector<std::string> index_names, const watch_query_indexes_options& options)
-    {
-        auto barrier = std::make_shared<std::promise<manager_error_context>>();
-        auto future = barrier->get_future();
-        watch_indexes(std::move(index_names), options, [barrier](auto ctx) { barrier->set_value(ctx); });
-        return future;
-    }
+      -> std::future<manager_error_context>;
 
   private:
     friend class collection;