com.couchbase.client.java.transactions

Class Transactions

java.lang.Object

com.couchbase.client.java.transactions.Transactions

public class Transactions
extends Object

The starting point for accessing Couchbase transactions.

The main methods to run transactions are run(java.util.function.Consumer<com.couchbase.client.java.transactions.TransactionAttemptContext>, com.couchbase.client.java.transactions.config.TransactionOptions) and reactive.

Constructor Summary

Constructors

Constructor and Description
Transactions(com.couchbase.client.core.Core core, JsonSerializer serializer)

Method Summary

Modifier and Type	Method and Description
TransactionResult	run(Consumer<TransactionAttemptContext> transactionLogic) Runs supplied transactional logic until success or failure.
TransactionResult	run(Consumer<TransactionAttemptContext> transactionLogic, TransactionOptions options) Runs supplied transactional logic until success or failure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Transactions

@Stability.Internal
public Transactions(com.couchbase.client.core.Core core,
                                        JsonSerializer serializer)

Method Detail

run

public TransactionResult run(Consumer<TransactionAttemptContext> transactionLogic,
                             @Nullable
                             TransactionOptions options)

Runs supplied transactional logic until success or failure.

The supplied transactional logic will be run if necessary multiple times, until either:

• The transaction successfully commits
• The transactional logic requests an explicit rollback
• The transaction timesout.
• An exception is thrown, either inside the transaction library or by the supplied transaction logic, that cannot be handled.

The transaction logic Consumer is provided a TransactionAttemptContext, which contains methods allowing it to perform all operations that are possible inside a transaction.

Commit will be performed automatically if the lambda successfully reaches its end.

Parameters:

transactionLogic - the application's transaction logic

options - the configuration to use for this transaction

Returns:

there is no need to check the returned TransactionResult, as success is implied by the lack of a thrown exception. It contains information useful only for debugging and logging.

Throws:

TransactionFailedException - or a derived exception if the transaction fails to commit for any reason, possibly after multiple retries. The exception contains further details of the error

run

public TransactionResult run(Consumer<TransactionAttemptContext> transactionLogic)

Runs supplied transactional logic until success or failure. A convenience overload for run(java.util.function.Consumer<com.couchbase.client.java.transactions.TransactionAttemptContext>, com.couchbase.client.java.transactions.config.TransactionOptions) that provides a default TransactionOptions