Class TransactionsConfig


public class TransactionsConfig extends Object
Provides all configurable parameters for Couchbase transactions.
  • Constructor Details

    • TransactionsConfig

      public TransactionsConfig()
  • Method Details

    • builder

      public static TransactionsConfig.Builder builder()
    • cleanupConfig

      public static TransactionsConfig.Builder cleanupConfig(TransactionsCleanupConfig.Builder config)
      Configures transaction cleanup.
    • timeout

      public static TransactionsConfig.Builder timeout(Duration timeout)
      Sets the maximum time that transactions can run for. The default is 15 seconds. After this time, the transaction will abort. Note that this could be mid-commit, in which case the cleanup process will complete the transaction asynchronously at a later point.

      Applications can increase or decrease this as desired. The trade-off to understand is that documents that are being mutated in a transaction A, are effectively locked from being updated by other transactions until transaction A has completed - committed or rolled back. If transaction A is unable to complete for whatever reason, the document can be locked for this timeout time.

    • durabilityLevel

      public static TransactionsConfig.Builder durabilityLevel(DurabilityLevel level)
      All transaction writes will be performed with this durability setting.

      The default setting is DurabilityLevel.MAJORITY, meaning a transaction will pause on each write until it is available in-memory on a majority of configured replicas.

      DurabilityLevel.NONE is not supported and provides no ACID transactional guarantees.

    • metadataCollection

      public static TransactionsConfig.Builder metadataCollection(TransactionKeyspace collection)
      Allows setting a custom collection to use for any transactional metadata documents.

      If not set, it will default to creating these documents in the default collection of the bucket that the first mutated document in the transaction is on.

      This collection will be added to the set of collections being cleaned up.

    • queryConfig

      public static TransactionsConfig.Builder queryConfig(TransactionsQueryConfig.Builder queryConfig)
      Sets the default query configuration for all transactions.
      queryConfig - the query configuration to use
      this, for chaining