couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/collection_manager.hxx

@@ -45,115 +45,123 @@ 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,
+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<error, 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 drop_collection_options& options,
-                         drop_collection_handler&& handler) const;
+                         const create_collection_settings& settings,
+                         const create_collection_options& options,
+                         create_collection_handler&& handler) const;
 
-    [[nodiscard]] auto drop_collection(std::string scope_name,
+  [[nodiscard]] auto create_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;
-
-    collection_manager(core::cluster core, std::string_view bucket_name);
-
-    std::shared_ptr<collection_manager_impl> impl_;
+                                       const create_collection_settings& settings = {},
+                                       const create_collection_options& options = {}) const
+    -> std::future<error>;
+  /**
+   * 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<error>;
+
+  /**
+   * 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<error>;
+
+  /**
+   * 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<error>;
+
+  /**
+   * 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<error>;
+
+private:
+  friend class bucket;
+
+  collection_manager(core::cluster core, std::string_view bucket_name);
+
+  std::shared_ptr<collection_manager_impl> impl_;
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/collection_query_index_manager.hxx

@@ -51,193 +51,205 @@ class collection;
  */
 class collection_query_index_manager
 {
-  public:
-    /**
-     * Get all indexes within the collection.
-     *
-     * @param options optional parameters
-     * @param handler the handler that implements @ref get_all_query_indexes_handler
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void get_all_indexes(const get_all_query_indexes_options& options, get_all_query_indexes_handler&& handler) const;
-
-    /**
-     * Get all indexes within the collection.
-     *
-     * @param options optional parameters
-     * @return future object that carries result of the operation
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[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>>>;
-
-    /**
-     * Create an index on the collection.
-     *
-     * @param index_name name of the index
-     * @param keys the keys to create the index over
-     * @param options optional parameters
-     * @param handler the handler that implements @ref create_query_index_handler
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void create_index(std::string index_name,
-                      std::vector<std::string> keys,
-                      const create_query_index_options& options,
-                      create_query_index_handler&& handler) const;
-
-    /**
-     * Create an index on the collection.
-     *
-     * @param index_name name of the index
-     * @param keys the keys to create the index over
-     * @param options optional parameters
-     * @return future object that carries result of the operation
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto create_index(std::string index_name, std::vector<std::string> keys, const create_query_index_options& options) const
-      -> std::future<manager_error_context>;
-
-    /**
-     * Create a primary index on the collection.
-     *
-     * @param options optional parameters
-     * @param handler the handler that implements @ref create_query_index_handler
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void create_primary_index(const create_primary_query_index_options& options, create_query_index_handler&& handler) const;
-
-    /**
-     * Create a primary index on the collection.
-     *
-     * @param options optional parameters
-     * @return future object that carries result of the operation
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto create_primary_index(const create_primary_query_index_options& options) const -> std::future<manager_error_context>;
-
-    /**
-     * Drop primary index on the collection.
-     *
-     * @param options optional parameters
-     * @param handler the handler that implements @ref drop_query_index_handler
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void drop_primary_index(const drop_primary_query_index_options& options, drop_query_index_handler&& handler) const;
-
-    /**
-     * Drop primary index on the collection.
-     *
-     * @param options optional parameters
-     * @return future object that carries result of the operation
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto drop_primary_index(const drop_primary_query_index_options& options) const -> std::future<manager_error_context>;
-
-    /**
-     * Drop specified query index in the collection.
-     *
-     * @param index_name name of the index to drop
-     * @param options optional parameters
-     * @param handler handler that implements @ref drop_query_index_handler
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void drop_index(std::string index_name, const drop_query_index_options& options, drop_query_index_handler&& handler) const;
-
-    /**
-     * Drop specified query index in the collection.
-     *
-     * @param index_name name of the index to drop
-     * @param options optional parameters
-     * @return future object that carries result of the operation
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto drop_index(std::string index_name, const drop_query_index_options& options) const
-      -> std::future<manager_error_context>;
-
-    /**
-     * Builds all currently deferred indexes in this collection.
-     *
-     * By default, this method will build the indexes on the collection.
-     *
-     * @param options optional parameters
-     * @param handler the handler that implements @ref build_deferred_query_indexes_handler
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void build_deferred_indexes(const build_query_index_options& options, build_deferred_query_indexes_handler&& handler) const;
-
-    /**
-     * Builds all currently deferred indexes in this collection.
-     *
-     * By default, this method will build the indexes on the collection.
-     *
-     * @param options optional parameters
-     * @return future object that carries result of the operation
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[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.
-     *
-     * @param index_names names of the indexes to watch
-     * @param options optional parameters
-     * @param handler handler that implements @ref watch_query_indexes_handler
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    void watch_indexes(std::vector<std::string> index_names,
-                       const watch_query_indexes_options& options,
-                       watch_query_indexes_handler&& handler) const;
-
-    /**
-     * Polls the state of a set of indexes, until they all are online.
-     *
-     * @param index_names names of the indexes to watch
-     * @param options optional parameters
-     * @return future object that carries result of the operation
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto watch_indexes(std::vector<std::string> index_names, const watch_query_indexes_options& options) const
-      -> std::future<manager_error_context>;
-
-  private:
-    friend class collection;
-
-    collection_query_index_manager(couchbase::core::cluster core,
-                                   std::string bucket_name,
-                                   std::string scope_name,
-                                   std::string collection_name);
-
-    std::shared_ptr<query_index_manager_impl> impl_;
-    std::string bucket_name_{};
-    std::string scope_name_{};
-    std::string collection_name_{};
+public:
+  /**
+   * Get all indexes within the collection.
+   *
+   * @param options optional parameters
+   * @param handler the handler that implements @ref get_all_query_indexes_handler
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void get_all_indexes(const get_all_query_indexes_options& options,
+                       get_all_query_indexes_handler&& handler) const;
+
+  /**
+   * Get all indexes within the collection.
+   *
+   * @param options optional parameters
+   * @return future object that carries result of the operation
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto get_all_indexes(const get_all_query_indexes_options& options) const
+    -> std::future<std::pair<error, std::vector<couchbase::management::query_index>>>;
+
+  /**
+   * Create an index on the collection.
+   *
+   * @param index_name name of the index
+   * @param keys the keys to create the index over
+   * @param options optional parameters
+   * @param handler the handler that implements @ref create_query_index_handler
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void create_index(std::string index_name,
+                    std::vector<std::string> keys,
+                    const create_query_index_options& options,
+                    create_query_index_handler&& handler) const;
+
+  /**
+   * Create an index on the collection.
+   *
+   * @param index_name name of the index
+   * @param keys the keys to create the index over
+   * @param options optional parameters
+   * @return future object that carries result of the operation
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto create_index(std::string index_name,
+                                  std::vector<std::string> keys,
+                                  const create_query_index_options& options) const
+    -> std::future<error>;
+
+  /**
+   * Create a primary index on the collection.
+   *
+   * @param options optional parameters
+   * @param handler the handler that implements @ref create_query_index_handler
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void create_primary_index(const create_primary_query_index_options& options,
+                            create_primary_query_index_handler&& handler) const;
+
+  /**
+   * Create a primary index on the collection.
+   *
+   * @param options optional parameters
+   * @return future object that carries result of the operation
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto create_primary_index(const create_primary_query_index_options& options) const
+    -> std::future<error>;
+
+  /**
+   * Drop primary index on the collection.
+   *
+   * @param options optional parameters
+   * @param handler the handler that implements @ref drop_query_index_handler
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void drop_primary_index(const drop_primary_query_index_options& options,
+                          drop_primary_query_index_handler&& handler) const;
+
+  /**
+   * Drop primary index on the collection.
+   *
+   * @param options optional parameters
+   * @return future object that carries result of the operation
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto drop_primary_index(const drop_primary_query_index_options& options) const
+    -> std::future<error>;
+
+  /**
+   * Drop specified query index in the collection.
+   *
+   * @param index_name name of the index to drop
+   * @param options optional parameters
+   * @param handler handler that implements @ref drop_query_index_handler
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void drop_index(std::string index_name,
+                  const drop_query_index_options& options,
+                  drop_query_index_handler&& handler) const;
+
+  /**
+   * Drop specified query index in the collection.
+   *
+   * @param index_name name of the index to drop
+   * @param options optional parameters
+   * @return future object that carries result of the operation
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto drop_index(std::string index_name, const drop_query_index_options& options)
+    const -> std::future<error>;
+
+  /**
+   * Builds all currently deferred indexes in this collection.
+   *
+   * By default, this method will build the indexes on the collection.
+   *
+   * @param options optional parameters
+   * @param handler the handler that implements @ref build_deferred_query_indexes_handler
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void build_deferred_indexes(const build_query_index_options& options,
+                              build_deferred_query_indexes_handler&& handler) const;
+
+  /**
+   * Builds all currently deferred indexes in this collection.
+   *
+   * By default, this method will build the indexes on the collection.
+   *
+   * @param options optional parameters
+   * @return future object that carries result of the operation
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto build_deferred_indexes(const build_query_index_options& options) const
+    -> std::future<error>;
+
+  /**
+   * Polls the state of a set of indexes, until they all are online.
+   *
+   * @param index_names names of the indexes to watch
+   * @param options optional parameters
+   * @param handler handler that implements @ref watch_query_indexes_handler
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  void watch_indexes(std::vector<std::string> index_names,
+                     const watch_query_indexes_options& options,
+                     watch_query_indexes_handler&& handler) const;
+
+  /**
+   * Polls the state of a set of indexes, until they all are online.
+   *
+   * @param index_names names of the indexes to watch
+   * @param options optional parameters
+   * @return future object that carries result of the operation
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto watch_indexes(std::vector<std::string> index_names,
+                                   const watch_query_indexes_options& options) const
+    -> std::future<error>;
+
+private:
+  friend class collection;
+
+  collection_query_index_manager(couchbase::core::cluster core,
+                                 std::string bucket_name,
+                                 std::string scope_name,
+                                 std::string collection_name);
+
+  std::shared_ptr<query_index_manager_impl> impl_;
+  std::string bucket_name_{};
+  std::string scope_name_{};
+  std::string collection_name_{};
 };
 } // namespace couchbase