couchbase 3.5.1 → 3.5.2

data/ext/couchbase/core/transactions/atr_ids.hxx

@@ -23,10 +23,10 @@ namespace couchbase::core::transactions
 {
 class atr_ids
 {
-  public:
-    static const std::string& atr_id_for_vbucket(std::size_t vbucket_id);
-    static std::size_t vbucket_for_key(const std::string& key);
-    static const std::vector<std::string>& all();
+public:
+  static auto atr_id_for_vbucket(std::size_t vbucket_id) -> const std::string&;
+  static auto vbucket_for_key(const std::string& key) -> std::size_t;
+  static auto all() -> const std::vector<std::string>&;
 };
 
 } // namespace couchbase::core::transactions

data/ext/couchbase/core/transactions/attempt_context.cxx

@@ -22,15 +22,19 @@
 
 namespace couchbase::transactions
 {
-std::pair<transaction_op_error_context, transaction_query_result>
-attempt_context::query(const scope& scope, const std::string& statement, const transaction_query_options& opts)
+auto
+attempt_context::query(const scope& scope,
+                       const std::string& statement,
+                       const transaction_query_options& opts)
+  -> std::pair<error, transaction_query_result>
 {
-    return do_public_query(statement, opts, fmt::format("{}.{}", scope.bucket_name(), scope.name()));
+  return do_public_query(statement, opts, fmt::format("{}.{}", scope.bucket_name(), scope.name()));
 }
 
-std::pair<transaction_op_error_context, transaction_query_result>
+auto
 attempt_context::query(const std::string& statement, const transaction_query_options& options)
+  -> std::pair<error, transaction_query_result>
 {
-    return do_public_query(statement, options, {});
+  return do_public_query(statement, options, {});
 }
 } // namespace couchbase::transactions

data/ext/couchbase/core/transactions/attempt_context.hxx

@@ -16,6 +16,9 @@
 #pragma once
 
 #include "transaction_get_result.hxx"
+
+#include "internal/exceptions_internal.hxx"
+
 #include <couchbase/transactions/transaction_query_options.hxx>
 
 #include <optional>
@@ -33,163 +36,200 @@ namespace couchbase::core::transactions
  */
 class attempt_context
 {
-  public:
-    virtual ~attempt_context() = default;
-    /**
-     * Gets a document from the specified Couchbase collection matching the specified id.
-     *
-     * @param bucket name of the bucket to use
-     * @param collection the collection the document exists in (specified as <scope_name>.<collection_name>
-     * @param id the document's ID
-     * @return an TransactionDocument containing the document
-     *
-     * @throws transaction_operation_failed which either should not be caught by the lambda, or
-     *         rethrown if it is caught.
-     */
-    virtual transaction_get_result get(const core::document_id& id) = 0;
-
-    /**
-     * Gets a document from the specified Couchbase collection matching the specified id.
-     *
-     * @param bucket name of the bucket to use
-     * @param collection the collection the document exists in (specified as <scope_name>.<collection_name>
-     * @param id the document's ID
-     * @return a TransactionDocument containing the document, if it exists.
-     *
-     * @throws transaction_operation_failed which either should not be caught by the lambda, or
-     *         rethrown if it is caught.
-     */
-    virtual std::optional<transaction_get_result> get_optional(const core::document_id& id) = 0;
-
-    /**
-     * Mutates the specified document with new content, using the document's last TransactionDocument#cas().
-     *
-     * The mutation is staged until the transaction is committed.  That is, any read of the document by any Couchbase component will see
-     * the document's current value, rather than this staged or 'dirty' data.  If the attempt is rolled back, the staged mutation will
-     * be removed.
-     *
-     * This staged data effectively locks the document from other transactional writes until the attempt completes (commits or rolls
-     * back).
-     *
-     * If the mutation fails, the transaction will automatically rollback this attempt, then retry.
-     * @param document the doc to be updated
-     * @param content the content to replace the doc with.
-     * @return the document, updated with its new CAS value.
-     *
-     * @throws transaction_operation_failed which either should not be caught by the lambda, or
-     *         rethrown if it is caught.
-     */
-    template<typename Content>
-    transaction_get_result replace(const transaction_get_result& document, const Content& content)
-    {
-        if constexpr (std::is_same_v<Content, std::vector<std::byte>>) {
-            return replace_raw(document, content);
-        } else {
-            return replace_raw(document, codec::tao_json_serializer::serialize(content));
-        }
-    }
-    /**
-     * Inserts a new document into the specified Couchbase collection.
-     *
-     * As with #replace, the insert is staged until the transaction is committed.  Due to technical limitations it is not as possible to
-     * completely hide the staged data from the rest of the Couchbase platform, as an empty document must be created.
-     *
-     * This staged data effectively locks the document from other transactional writes until the attempt completes
-     * (commits or rolls back).
-     *
-     * @param collection the Couchbase collection in which to insert the doc
-     * @param id the document's unique ID
-     * @param content the content to insert
-     * @return the doc, updated with its new CAS value and ID, and converted to a TransactionDocument
-     *
-     * @throws transaction_operation_failed which either should not be caught by the lambda, or
-     *         rethrown if it is caught.
-     */
-    template<typename Content>
-    transaction_get_result insert(const core::document_id& id, const Content& content)
-    {
-        if constexpr (std::is_same_v<Content, std::vector<std::byte>>) {
-            return insert_raw(id, content);
-        } else {
-            return insert_raw(id, codec::tao_json_serializer::serialize(content));
-        }
+public:
+  virtual ~attempt_context() = default;
+  /**
+   * Gets a document from the specified Couchbase collection matching the
+   * specified id.
+   *
+   * @param bucket name of the bucket to use
+   * @param collection the collection the document exists in (specified as
+   * <scope_name>.<collection_name>
+   * @param id the document's ID
+   * @return an TransactionDocument containing the document
+   *
+   * @throws transaction_operation_failed which either should not be caught by
+   * the lambda, or rethrown if it is caught.
+   */
+  virtual auto get(const core::document_id& id) -> transaction_get_result = 0;
+
+  /**
+   * Gets a document from the specified Couchbase collection matching the
+   * specified id.
+   *
+   * @param bucket name of the bucket to use
+   * @param collection the collection the document exists in (specified as
+   * <scope_name>.<collection_name>
+   * @param id the document's ID
+   * @return a TransactionDocument containing the document, if it exists.
+   *
+   * @throws transaction_operation_failed which either should not be caught by
+   * the lambda, or rethrown if it is caught.
+   */
+  virtual auto get_optional(const core::document_id& id)
+    -> std::optional<transaction_get_result> = 0;
+
+  /**
+   * Get a document copy from the selected server group.
+   *
+   * @param id the document's ID
+   *
+   * @see network_options::preferred_server_group
+   * @see https://docs.couchbase.com/server/current/manage/manage-groups/manage-groups.html
+   */
+  virtual auto get_replica_from_preferred_server_group(const core::document_id& id)
+    -> std::optional<transaction_get_result> = 0;
+
+  /**
+   * Mutates the specified document with new content, using the document's last
+   * TransactionDocument#cas().
+   *
+   * The mutation is staged until the transaction is committed.  That is, any
+   * read of the document by any Couchbase component will see the document's
+   * current value, rather than this staged or 'dirty' data.  If the attempt is
+   * rolled back, the staged mutation will be removed.
+   *
+   * This staged data effectively locks the document from other transactional
+   * writes until the attempt completes (commits or rolls back).
+   *
+   * If the mutation fails, the transaction will automatically rollback this
+   * attempt, then retry.
+   * @param document the doc to be updated
+   * @param content the content to replace the doc with.
+   * @return the document, updated with its new CAS value.
+   *
+   * @throws transaction_operation_failed which either should not be caught by
+   * the lambda, or rethrown if it is caught.
+   */
+  template<typename Transcoder = codec::default_json_transcoder, typename Content>
+  auto replace(const transaction_get_result& document,
+               const Content& content) -> transaction_get_result
+  {
+    codec::encoded_value data;
+    try {
+      data = Transcoder::encode(content);
+    } catch (std::runtime_error& e) {
+      throw transaction_operation_failed(
+        FAIL_OTHER, std::string("failed to encode content as JSON: ") + e.what());
     }
-    /**
-     * Removes the specified document, using the document's last TransactionDocument#cas
-     *
-     * As with {@link #replace}, the remove is staged until the transaction is committed.  That is, the document will continue to exist,
-     * and the rest of the Couchbase platform will continue to see it.
-     *
-     * This staged data effectively locks the document from other transactional writes until the attempt completes (commits or rolls
-     * back).
-     *
-     * @param document the document to be removed
-     *
-     * @throws transaction_operation_failed which either should not be caught by the lambda, or
-     *         rethrown if it is caught.
-     */
-    virtual void remove(const transaction_get_result& document) = 0;
-
-    /**
-     * Performs a Query, within the current transaction.
-     *
-     * @param statement query statement to execute.
-     * @param options options to apply to the query.
-     * @param query_context query context, if any.
-     * @returns result of the query.
-     */
-    core::operations::query_response query(const std::string& statement,
-                                           const couchbase::transactions::transaction_query_options& opts,
-                                           std::optional<std::string> query_context = {})
-    {
-        return do_core_query(statement, opts, query_context);
-    };
-    /**
-     * Performs a Query, within the current transaction.
-     *
-     * @param statement query statement to execute.
-     * @return result of the query
-     */
-    core::operations::query_response query(const std::string& statement)
-    {
-        couchbase::transactions::transaction_query_options opts;
-        return query(statement, opts);
+    return replace_raw(document, data);
+  }
+
+  /**
+   * Inserts a new document into the specified Couchbase collection.
+   *
+   * As with #replace, the insert is staged until the transaction is committed.
+   * Due to technical limitations it is not as possible to completely hide the
+   * staged data from the rest of the Couchbase platform, as an empty document
+   * must be created.
+   *
+   * This staged data effectively locks the document from other transactional
+   * writes until the attempt completes (commits or rolls back).
+   *
+   * @param collection the Couchbase collection in which to insert the doc
+   * @param id the document's unique ID
+   * @param content the content to insert
+   * @return the doc, updated with its new CAS value and ID, and converted to a
+   * TransactionDocument
+   *
+   * @throws transaction_operation_failed which either should not be caught by
+   * the lambda, or rethrown if it is caught.
+   */
+  template<typename Transcoder = codec::default_json_transcoder, typename Content>
+  auto insert(const core::document_id& id, const Content& content) -> transaction_get_result
+  {
+    codec::encoded_value data;
+    try {
+      data = Transcoder::encode(content);
+    } catch (std::runtime_error& e) {
+      throw transaction_operation_failed(
+        FAIL_OTHER, std::string("failed to encode content as JSON: ") + e.what());
     }
+    return insert_raw(id, data);
+  }
+  /**
+   * Removes the specified document, using the document's last
+   * TransactionDocument#cas
+   *
+   * As with {@link #replace}, the remove is staged until the transaction is
+   * committed.  That is, the document will continue to exist, and the rest of
+   * the Couchbase platform will continue to see it.
+   *
+   * This staged data effectively locks the document from other transactional
+   * writes until the attempt completes (commits or rolls back).
+   *
+   * @param document the document to be removed
+   *
+   * @throws transaction_operation_failed which either should not be caught by
+   * the lambda, or rethrown if it is caught.
+   */
+  virtual void remove(const transaction_get_result& document) = 0;
+
+  /**
+   * Performs a Query, within the current transaction.
+   *
+   * @param statement query statement to execute.
+   * @param options options to apply to the query.
+   * @param query_context query context, if any.
+   * @returns result of the query.
+   */
+  auto query(const std::string& statement,
+             const couchbase::transactions::transaction_query_options& opts,
+             std::optional<std::string> query_context = {}) -> core::operations::query_response
+  {
+    return do_core_query(statement, opts, query_context);
+  };
+  /**
+   * Performs a Query, within the current transaction.
+   *
+   * @param statement query statement to execute.
+   * @return result of the query
+   */
+  auto query(const std::string& statement) -> core::operations::query_response
+  {
+    couchbase::transactions::transaction_query_options opts;
+    return query(statement, opts);
+  }
+
+  /**
+   * Commits the transaction.  All staged replaces, inserts and removals will be
+   * written.
+   *
+   * After this, no further operations are permitted on this instance, and they
+   * will result in an exception that will, if not caught in the transaction
+   * logic, cause the transaction to fail.
+   *
+   * @throws transaction_operation_failed which either should not be caught by
+   * the lambda, or rethrown if it is caught.
+   */
+  virtual void commit() = 0;
+
+  /**
+   * Rollback the transaction.  All staged mutations will be unstaged.
+   *
+   * Typically, this is called internally to rollback transaction when errors
+   * occur in the lambda. Though it can be called explicitly from the app logic
+   * within the transaction as well, perhaps that is better modeled as a custom
+   * exception that you raise instead.
+   *
+   * @throws transaction_operation_failed which either should not be caught by
+   * the lambda, or rethrown if it is caught.
+   */
+  virtual void rollback() = 0;
+
+protected:
+  /** @internal */
+  virtual auto insert_raw(const core::document_id& id,
+                          codec::encoded_value content) -> transaction_get_result = 0;
+
+  /** @internal */
+  virtual auto replace_raw(const transaction_get_result& document,
+                           codec::encoded_value content) -> transaction_get_result = 0;
 
-    /**
-     * Commits the transaction.  All staged replaces, inserts and removals will be written.
-     *
-     * After this, no further operations are permitted on this instance, and they will result in an
-     * exception that will, if not caught in the transaction logic, cause the transaction to
-     * fail.
-     *
-     * @throws transaction_operation_failed which either should not be caught by the lambda, or
-     *         rethrown if it is caught.
-     */
-    virtual void commit() = 0;
-
-    /**
-     * Rollback the transaction.  All staged mutations will be unstaged.
-     *
-     * Typically, this is called internally to rollback transaction when errors occur in the lambda.  Though
-     * it can be called explicitly from the app logic within the transaction as well, perhaps that is better
-     * modeled as a custom exception that you raise instead.
-     *
-     * @throws transaction_operation_failed which either should not be caught by the lambda, or
-     *         rethrown if it is caught.
-     */
-    virtual void rollback() = 0;
-
-  protected:
-    /** @internal */
-    virtual transaction_get_result insert_raw(const core::document_id& id, const std::vector<std::byte>& content) = 0;
-
-    /** @internal */
-    virtual transaction_get_result replace_raw(const transaction_get_result& document, const std::vector<std::byte>& content) = 0;
-
-    virtual core::operations::query_response do_core_query(const std::string&,
-                                                           const couchbase::transactions::transaction_query_options& opts,
-                                                           std::optional<std::string> query_context) = 0;
+  virtual auto do_core_query(const std::string&,
+                             const couchbase::transactions::transaction_query_options& opts,
+                             std::optional<std::string> query_context)
+    -> core::operations::query_response = 0;
 };
 
 } // namespace couchbase::core::transactions