com.scalar.db.api

Interface DistributedTransaction

All Superinterfaces:

CrudOperable<CrudException>, TransactionCrudOperable

All Known Implementing Classes:

AbstractDistributedTransaction, ConsensusCommit, DecoratedDistributedTransaction, JdbcTransaction, ReadOnlyDistributedTransaction

public interface DistributedTransaction
extends TransactionCrudOperable

A transaction abstraction for interacting with the underlying storage and database implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface com.scalar.db.api.TransactionCrudOperable

TransactionCrudOperable.Scanner

Method Summary

Modifier and Type	Method and Description
default void	abort() Aborts a transaction.
void	commit() Commits a transaction.
java.lang.String	getId() Returns the ID of a transaction.
java.util.Optional<java.lang.String>	getNamespace() Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
java.util.Optional<java.lang.String>	getTable() Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
void	rollback() Rolls back a transaction.
void	with(java.lang.String namespace, java.lang.String tableName) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
void	withNamespace(java.lang.String namespace) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
void	withTable(java.lang.String tableName) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0

Methods inherited from interface com.scalar.db.api.TransactionCrudOperable

delete, delete, get, getScanner, insert, mutate, put, put, scan, update, upsert

Method Detail

getId

java.lang.String getId()

Returns the ID of a transaction.

Returns:

the ID of a transaction

with

@Deprecated
void with(java.lang.String namespace,
                      java.lang.String tableName)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0

Sets the specified namespace and the table name as default values in the instance.

Parameters:

namespace - default namespace to operate for

tableName - default table name to operate for

withNamespace

@Deprecated
void withNamespace(java.lang.String namespace)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0

Sets the specified namespace as a default value in the instance.

Parameters:

namespace - default namespace to operate for

getNamespace

@Deprecated
java.util.Optional<java.lang.String> getNamespace()

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0

Returns the namespace.

Returns:

an Optional with the namespace

withTable

@Deprecated
void withTable(java.lang.String tableName)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0

Sets the specified table name as a default value in the instance.

Parameters:

tableName - default table name to operate for

getTable

@Deprecated
java.util.Optional<java.lang.String> getTable()

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0

Returns the table name.

Returns:

an Optional with the table name

commit

void commit()
     throws CommitConflictException,
            CommitException,
            UnknownTransactionStatusException

Commits a transaction.

Throws:

CommitConflictException - if the transaction fails to commit due to transient faults (e.g., a conflict error). You can retry the transaction from the beginning

CommitException - if the transaction fails to commit due to transient or nontransient faults. You can try retrying the transaction from the beginning, but the transaction may still fail if the cause is nontransient

UnknownTransactionStatusException - if the status of the commit is unknown

rollback

void rollback()
       throws RollbackException

Rolls back a transaction.

Throws:

RollbackException - if the transaction fails to roll back due to transient or nontransient faults

abort

default void abort()
            throws AbortException

Aborts a transaction. This method is an alias of rollback().

Throws:

AbortException - if the transaction fails to abort due to transient or nontransient faults