couchbase 4.3.1 → 4.4.1-dev.1

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

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