couchbase 4.2.3 → 4.2.5-dev.1

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

@@ -0,0 +1,104 @@
+/* -*- 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/codec/binary_noop_serializer.hxx>
+#include <couchbase/codec/encoded_value.hxx>
+#include <couchbase/search_row_locations.hxx>
+
+#include <memory>
+
+namespace couchbase
+{
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+class internal_search_row;
+#endif
+
+/**
+ * Search Metrics contains the search result metrics containing counts and timings
+ *
+ * @since 1.0.0
+ * @committed
+ */
+class search_row
+{
+  public:
+    /**
+     * @since 1.0.0
+     * @volatile
+     */
+    explicit search_row(internal_search_row internal);
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto index() const -> const std::string&;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto id() const -> const std::string&;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto score() const -> double;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto fields() const -> const codec::binary&;
+
+    template<typename Serializer,
+             typename Document = typename Serializer::document_type,
+             std::enable_if_t<codec::is_serializer_v<Serializer>, bool> = true>
+    [[nodiscard]] auto fields_as() const -> Document
+    {
+        if (fields().empty()) {
+            return Document{};
+        }
+        return Serializer::template deserialize<Document>(fields());
+    }
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto explanation() const -> const codec::binary&;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto locations() const -> const std::optional<search_row_locations>&;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto fragments() const -> const std::map<std::string, std::vector<std::string>>&;
+
+  private:
+    std::unique_ptr<internal_search_row> internal_;
+};
+
+} // namespace couchbase

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

@@ -0,0 +1,55 @@
+/* -*- 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 <cinttypes>
+#include <optional>
+#include <string>
+#include <vector>
+
+namespace couchbase
+{
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+class internal_search_row_location;
+#endif
+
+/**
+ * @since 1.0.0
+ * @committed
+ */
+class search_row_location
+{
+  public:
+    /**
+     * @since 1.0.0
+     * @internal
+     */
+    explicit search_row_location(internal_search_row_location location);
+
+    [[nodiscard]] auto field() const -> const std::string&;
+    [[nodiscard]] auto term() const -> const std::string&;
+    [[nodiscard]] auto position() const -> const std::uint64_t&;
+    [[nodiscard]] auto start_offset() const -> const std::uint64_t&;
+    [[nodiscard]] auto end_offset() const -> const std::uint64_t&;
+    [[nodiscard]] auto array_positions() const -> const std::optional<std::vector<std::uint64_t>>&;
+
+  private:
+    std::unique_ptr<internal_search_row_location> internal_;
+};
+
+} // namespace couchbase

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

@@ -0,0 +1,86 @@
+/* -*- 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/search_row_location.hxx>
+
+#include <map>
+#include <set>
+#include <string>
+#include <vector>
+
+namespace couchbase
+{
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+class internal_search_row_locations;
+#endif
+
+/**
+ * @since 1.0.0
+ * @committed
+ */
+class search_row_locations
+{
+  public:
+    /**
+     * @since 1.0.0
+     * @internal
+     */
+    explicit search_row_locations(internal_search_row_locations internal);
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto get(const std::string& field) const -> std::vector<search_row_location>;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto get(const std::string& field, const std::string& term) const -> std::vector<search_row_location>;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto get_all() const -> std::vector<search_row_location>;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto fields() const -> std::vector<std::string>;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto terms() const -> std::set<std::string>;
+
+    /**
+     * @since 1.0.0
+     * @committed
+     */
+    [[nodiscard]] auto terms_for(const std::string& field) const -> std::vector<std::string>;
+
+  private:
+    std::unique_ptr<internal_search_row_locations> internal_;
+};
+
+} // namespace couchbase

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

@@ -0,0 +1,34 @@
+/* -*- 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
+
+namespace couchbase
+{
+enum class search_scan_consistency {
+    /**
+     * This is the default, the indexer does not wait for certain index updates until it returns the current hits.
+     *
+     * This is also the fastest mode, because we avoid the cost of obtaining the vector,
+     * and we also avoid any wait for the index to catch up to the vector.
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    not_bounded = 0,
+};
+} // namespace couchbase

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

@@ -0,0 +1,58 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-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 <optional>
+
+namespace couchbase
+{
+#ifndef COUCHBASE_CXX_CLIENT_DOXYGEN
+struct encoded_search_sort;
+#endif
+
+/**
+ * Base class for full text sort objects of search queries.
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-search-request.html#sorting-with-objects
+ *
+ * @since 1.0.0
+ */
+class search_sort
+{
+  public:
+    virtual ~search_sort() = default;
+
+    /**
+     * @return encoded representation of the search facet.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] virtual auto encode() const -> encoded_search_sort = 0;
+
+  protected:
+    search_sort() = default;
+
+    explicit search_sort(bool descending)
+      : descending_{ descending }
+    {
+    }
+
+    std::optional<bool> descending_{};
+};
+} // namespace couchbase

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

@@ -0,0 +1,117 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-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/search_sort.hxx>
+#include <couchbase/search_sort_field_missing.hxx>
+#include <couchbase/search_sort_field_mode.hxx>
+#include <couchbase/search_sort_field_type.hxx>
+
+#include <string>
+
+namespace couchbase
+{
+/**
+ * Sorts by a field in the hits.
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-search-request.html#sorting-with-objects
+ *
+ * @since 1.0.0
+ */
+class search_sort_field : public search_sort
+{
+  public:
+    explicit search_sort_field(std::string field)
+      : field_{ std::move(field) }
+    {
+    }
+
+    search_sort_field(std::string field, bool descending)
+      : search_sort{ descending }
+      , field_{ std::move(field) }
+    {
+    }
+
+    /**
+     * Set the sorting direction.
+     *
+     * @param desc `true` for descending order, `false` for ascending
+     * @return pointer to this
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto descending(bool desc) -> search_sort_field&;
+
+    /**
+     * Specifies the type of the search-order field value.
+     *
+     * For example, @ref search_sort_field_type::string for text fields, @ref search_sort_field_type::date for DateTime fields,
+     * or @ref search_sort_field_type::number for numeric/geo fields.
+     *
+     * @param desc field type
+     * @return pointer to this
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto type(search_sort_field_type desc) -> search_sort_field&;
+
+    /**
+     * Specifies the search-order for index-fields that contain multiple values (in consequence of arrays or multi-token analyzer-output).
+     *
+     * The default order is undefined but deterministic, allowing the paging of results, with reliable ordering. To sort using the minimum
+     * or maximum value, the value of mode should be set to either @ref search_sort_field_mode::min or @ref search_sort_field_mode::max.
+     *
+     * @param value strategy for multi-value fields.
+     * @return pointer to this
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto mode(search_sort_field_mode value) -> search_sort_field&;
+
+    /**
+     * Specifies the sort-procedure for documents with a missing value in a field specified for sorting.
+     *
+     * The value of missing can be @ref search_sort_field_missing::first, in which case results with missing values appear before other
+     * results; or @ref search_sort_field_missing::last (the server default), in which case they appear after.
+     *
+     * @param value strategy for missing values
+     * @return pointer to this
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto missing(search_sort_field_missing value) -> search_sort_field&;
+
+    /**
+     * @return encoded representation of the search facet.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_sort override;
+
+  private:
+    std::string field_;
+    std::optional<search_sort_field_type> type_{};
+    std::optional<search_sort_field_mode> mode_{};
+    std::optional<search_sort_field_missing> missing_{};
+};
+} // namespace couchbase

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

@@ -0,0 +1,26 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-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
+
+namespace couchbase
+{
+enum class search_sort_field_missing {
+    last,
+    first,
+};
+} // namespace couchbase

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

@@ -0,0 +1,27 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-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
+
+namespace couchbase
+{
+enum class search_sort_field_mode {
+    server_default,
+    min,
+    max,
+};
+} // namespace couchbase

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

@@ -0,0 +1,28 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-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
+
+namespace couchbase
+{
+enum class search_sort_field_type {
+    automatic,
+    string,
+    number,
+    date,
+};
+} // namespace couchbase

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

@@ -0,0 +1,60 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-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/search_sort.hxx>
+
+namespace couchbase
+{
+/**
+ * Sorts by the document ID.
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-search-request.html#sorting-with-objects
+ *
+ * @since 1.0.0
+ */
+class search_sort_id : public search_sort
+{
+  public:
+    search_sort_id() = default;
+
+    explicit search_sort_id(bool descending)
+      : search_sort{ descending }
+    {
+    }
+
+    /**
+     * Set the sorting direction.
+     *
+     * @param desc `true` for descending order, `false` for ascending
+     * @return pointer to this
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto descending(bool desc) -> search_sort_id&;
+
+    /**
+     * @return encoded representation of the search facet.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_sort override;
+};
+} // namespace couchbase

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

@@ -0,0 +1,60 @@
+/* -*- Mode: C++; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+/*
+ *   Copyright 2023-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/search_sort.hxx>
+
+namespace couchbase
+{
+/**
+ * Sorts by the hit score.
+ *
+ * @see https://docs.couchbase.com/server/current/fts/fts-search-request.html#sorting-with-objects
+ *
+ * @since 1.0.0
+ */
+class search_sort_score : public search_sort
+{
+  public:
+    search_sort_score() = default;
+
+    explicit search_sort_score(bool descending)
+      : search_sort{ descending }
+    {
+    }
+
+    /**
+     * Set the sorting direction.
+     *
+     * @param desc `true` for descending order, `false` for ascending
+     * @return pointer to this
+     *
+     * @since 1.0.0
+     * @committed
+     */
+    auto descending(bool desc) -> search_sort_score&;
+
+    /**
+     * @return encoded representation of the search facet.
+     *
+     * @since 1.0.0
+     * @internal
+     */
+    [[nodiscard]] auto encode() const -> encoded_search_sort override;
+};
+} // namespace couchbase