couchbase 3.5.1 → 3.5.2

data/ext/couchbase/couchbase/scope_search_index_manager.hxx

@@ -49,243 +49,268 @@ 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_;
+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<error, 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<error, 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<error>;
+
+  /**
+   * 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<error>;
+
+  /**
+   * 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<error, 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<error>;
+
+  /**
+   * 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<error>;
+
+  /**
+   * 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<error>;
+
+  /**
+   * 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<error>;
+
+  /**
+   * 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<error>;
+
+  /**
+   * 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<error>;
+
+  /**
+   * 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<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 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<error, 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

data/ext/couchbase/couchbase/search_date_range.hxx

@@ -30,39 +30,42 @@ namespace couchbase
  */
 class search_date_range
 {
-  public:
-    search_date_range(std::string name, std::optional<std::string> start, std::optional<std::string> end, std::uint64_t count)
-      : name_{ std::move(name) }
-      , start_{ std::move(start) }
-      , end_{ std::move(end) }
-      , count_{ count }
-    {
-    }
+public:
+  search_date_range(std::string name,
+                    std::optional<std::string> start,
+                    std::optional<std::string> end,
+                    std::uint64_t count)
+    : name_{ std::move(name) }
+    , start_{ std::move(start) }
+    , end_{ std::move(end) }
+    , count_{ count }
+  {
+  }
 
-    [[nodiscard]] auto name() const -> const std::string&
-    {
-        return name_;
-    }
+  [[nodiscard]] auto name() const -> const std::string&
+  {
+    return name_;
+  }
 
-    [[nodiscard]] auto start() const -> const std::optional<std::string>&
-    {
-        return start_;
-    }
+  [[nodiscard]] auto start() const -> const std::optional<std::string>&
+  {
+    return start_;
+  }
 
-    [[nodiscard]] auto end() const -> const std::optional<std::string>&
-    {
-        return end_;
-    }
+  [[nodiscard]] auto end() const -> const std::optional<std::string>&
+  {
+    return end_;
+  }
 
-    [[nodiscard]] auto count() const -> std::uint64_t
-    {
-        return count_;
-    }
+  [[nodiscard]] auto count() const -> std::uint64_t
+  {
+    return count_;
+  }
 
-  private:
-    std::string name_;
-    std::optional<std::string> start_;
-    std::optional<std::string> end_;
-    std::uint64_t count_;
+private:
+  std::string name_;
+  std::optional<std::string> start_;
+  std::optional<std::string> end_;
+  std::uint64_t count_;
 };
 } // namespace couchbase

data/ext/couchbase/couchbase/search_facet.hxx

@@ -31,30 +31,30 @@ struct encoded_search_facet;
  */
 class search_facet
 {
-  public:
-    virtual ~search_facet() = default;
-
-    /**
-     * @return encoded representation of the search facet.
-     *
-     * @since 1.0.0
-     * @internal
-     */
-    [[nodiscard]] virtual auto encode() const -> encoded_search_facet = 0;
-
-  protected:
-    search_facet(std::string field, std::uint32_t size)
-      : field_{ std::move(field) }
-      , size_{ size }
-    {
-    }
-
-    search_facet(std::string field)
-      : field_{ std::move(field) }
-    {
-    }
-
-    std::string field_;
-    std::optional<std::uint32_t> size_{};
+public:
+  virtual ~search_facet() = default;
+
+  /**
+   * @return encoded representation of the search facet.
+   *
+   * @since 1.0.0
+   * @internal
+   */
+  [[nodiscard]] virtual auto encode() const -> encoded_search_facet = 0;
+
+protected:
+  search_facet(std::string field, std::uint32_t size)
+    : field_{ std::move(field) }
+    , size_{ size }
+  {
+  }
+
+  search_facet(std::string field)
+    : field_{ std::move(field) }
+  {
+  }
+
+  std::string field_;
+  std::optional<std::uint32_t> size_{};
 };
 } // namespace couchbase