couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/search_facet_result.hxx

@@ -28,17 +28,17 @@ namespace couchbase
  */
 class search_facet_result
 {
-  public:
-    virtual ~search_facet_result() = default;
+public:
+  virtual ~search_facet_result() = default;
 
-    /**
-     * @since 1.0.0
-     * @internal
-     */
-    [[nodiscard]] virtual auto name() const -> const std::string& = 0;
-    [[nodiscard]] virtual auto field() const -> const std::string& = 0;
-    [[nodiscard]] virtual auto total() const -> std::uint64_t = 0;
-    [[nodiscard]] virtual auto missing() const -> std::uint64_t = 0;
-    [[nodiscard]] virtual auto other() const -> std::uint64_t = 0;
+  /**
+   * @since 1.0.0
+   * @internal
+   */
+  [[nodiscard]] virtual auto name() const -> const std::string& = 0;
+  [[nodiscard]] virtual auto field() const -> const std::string& = 0;
+  [[nodiscard]] virtual auto total() const -> std::uint64_t = 0;
+  [[nodiscard]] virtual auto missing() const -> std::uint64_t = 0;
+  [[nodiscard]] virtual auto other() const -> std::uint64_t = 0;
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/search_geo_distance_units.hxx

@@ -22,5 +22,15 @@ namespace couchbase
 /**
  * Enumeration of units for geo_distance sorting
  */
-enum class search_geo_distance_units { meters, miles, centimeters, millimeters, nautical_miles, kilometers, feet, yards, inch };
+enum class search_geo_distance_units {
+  meters,
+  miles,
+  centimeters,
+  millimeters,
+  nautical_miles,
+  kilometers,
+  feet,
+  yards,
+  inch
+};
 } // namespace couchbase

data/ext/couchbase/couchbase/search_index_manager.hxx

@@ -50,243 +50,266 @@ class cluster;
 
 class search_index_manager
 {
-  public:
-    /**
-     * Fetches an 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
-     * @committed
-     */
-    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 indexes from the server
-     *
-     * @param options optional parameters
-     * @param handler  handler that implements @ref get_all_search_indexes_handler
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    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 an 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
-     * @committed
-     */
-    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 an 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
-     * @committed
-     */
-    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 an 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
-     * @committed
-     */
-    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 an 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
-     * @committed
-     */
-    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 an 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
-     * @committed
-     */
-    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 an 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
-     * @committed
-     */
-    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 an 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
-     * @committed
-     */
-    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 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
-     * @committed
-     */
-    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 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
-     * @committed
-     */
-    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 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
-     * @committed
-     */
-    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 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
-     * @committed
-     */
-    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 cluster;
-
-    explicit search_index_manager(core::cluster core);
-
-    std::shared_ptr<search_index_manager_impl> impl_;
+public:
+  /**
+   * Fetches an 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
+   * @committed
+   */
+  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<error, management::search::index>>;
+
+  /**
+   * Fetches all indexes from the server
+   *
+   * @param options optional parameters
+   * @param handler  handler that implements @ref get_all_search_indexes_handler
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  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<error, std::vector<management::search::index>>>;
+
+  /**
+   * Creates, or updates an 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
+   * @committed
+   */
+  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<error>;
+
+  /**
+   * Drops an 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
+   * @committed
+   */
+  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<error>;
+
+  /**
+   * Retrieves the number of documents that have been indexed for an 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
+   * @committed
+   */
+  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<error, std::uint64_t>>;
+
+  /**
+   * Pauses updates and maintenance for an 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
+   * @committed
+   */
+  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<error>;
+
+  /**
+   * Resumes updates and maintenance for an 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
+   * @committed
+   */
+  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<error>;
+
+  /**
+   * Allows querying against an 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
+   * @committed
+   */
+  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<error>;
+
+  /**
+   * Disallows querying against an 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
+   * @committed
+   */
+  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<error>;
+
+  /**
+   * Freeze the assignment of 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
+   * @committed
+   */
+  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<error>;
+
+  /**
+   * Unfreeze the assignment of 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
+   * @committed
+   */
+  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<error>;
+
+  /**
+   * Allows to see how a document is analyzed against a specific 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
+   * @committed
+   */
+  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<error, 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 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
+   * @committed
+   */
+  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<error, std::vector<std::string>>>;
+
+private:
+  friend class cluster;
+
+  explicit search_index_manager(core::cluster core);
+
+  std::shared_ptr<search_index_manager_impl> impl_;
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/search_meta_data.hxx

@@ -40,46 +40,46 @@ class internal_search_meta_data;
  */
 class search_meta_data
 {
-  public:
-    /**
-     * @since 1.0.0
-     * @volatile
-     */
-    explicit search_meta_data(internal_search_meta_data internal);
+public:
+  /**
+   * @since 1.0.0
+   * @volatile
+   */
+  explicit search_meta_data(internal_search_meta_data internal);
 
-    /**
-     * Returns the client context identifier string set on the search request.
-     *
-     * @return client context identifier
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto client_context_id() const -> const std::string&;
-    /**
-     * Returns any warnings returned by the search engine.
-     *
-     * It returns an empty vector if no warnings were returned.
-     *
-     * @return vector of the reported warnings.
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto errors() const -> const std::map<std::string, std::string>&;
+  /**
+   * Returns the client context identifier string set on the search request.
+   *
+   * @return client context identifier
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto client_context_id() const -> const std::string&;
+  /**
+   * Returns any warnings returned by the search engine.
+   *
+   * It returns an empty vector if no warnings were returned.
+   *
+   * @return vector of the reported warnings.
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto errors() const -> const std::map<std::string, std::string>&;
 
-    /**
-     * Returns the {@link search_metrics} as returned by the search engine if enabled.
-     *
-     * @return metrics
-     *
-     * @since 1.0.0
-     * @committed
-     */
-    [[nodiscard]] auto metrics() const -> const search_metrics&;
+  /**
+   * Returns the {@link search_metrics} as returned by the search engine if enabled.
+   *
+   * @return metrics
+   *
+   * @since 1.0.0
+   * @committed
+   */
+  [[nodiscard]] auto metrics() const -> const search_metrics&;
 
-  private:
-    std::unique_ptr<internal_search_meta_data> internal_;
+private:
+  std::unique_ptr<internal_search_meta_data> internal_;
 };
 
 } // namespace couchbase