com.scalar.db.api

Interface DistributedTransactionManager

All Known Implementing Classes:

AbstractDistributedTransactionManager, ConsensusCommitManager, GrpcTransactionManager, JdbcTransactionManager, TransactionService

public interface DistributedTransactionManager

Method Summary

Modifier and Type	Method and Description
TransactionState	abort(java.lang.String txId) Aborts a given transaction.
void	close() Closes connections to the cluster.
java.util.Optional<java.lang.String>	getNamespace() Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
TransactionState	getState(java.lang.String txId) Returns the state of a given transaction.
java.util.Optional<java.lang.String>	getTable() Deprecated. As of release 3.6.0. Will be removed in release 5.0.0
DistributedTransaction	start() Starts a new transaction.
DistributedTransaction	start(Isolation isolation) Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.
DistributedTransaction	start(Isolation isolation, SerializableStrategy strategy) Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.
DistributedTransaction	start(SerializableStrategy strategy) Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.
DistributedTransaction	start(java.lang.String txId) Starts a new transaction with the specified transaction ID.
DistributedTransaction	start(java.lang.String txId, Isolation isolation) Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.
DistributedTransaction	start(java.lang.String txId, Isolation isolation, SerializableStrategy strategy) Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.
DistributedTransaction	start(java.lang.String txId, SerializableStrategy strategy) Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.
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

Method Detail

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

start

DistributedTransaction start()
                      throws TransactionException

Starts a new transaction.

Returns:

DistributedTransaction

Throws:

TransactionException - if starting the transaction failed

start

DistributedTransaction start(java.lang.String txId)
                      throws TransactionException

Starts a new transaction with the specified transaction ID. It is users' responsibility to guarantee uniqueness of the ID so it is not recommended to use this method unless you know exactly what you are doing.

Parameters:

txId - an user-provided unique transaction ID

Returns:

DistributedTransaction

Throws:

TransactionException - if starting the transaction failed

start

@Deprecated
DistributedTransaction start(Isolation isolation)
                                  throws TransactionException

Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.

Starts a new transaction with the specified Isolation level.

Parameters:

isolation - an isolation level

Returns:

DistributedTransaction

Throws:

TransactionException - if starting the transaction failed

start

@Deprecated
DistributedTransaction start(java.lang.String txId,
                                         Isolation isolation)
                                  throws TransactionException

Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.

Starts a new transaction with the specified transaction ID and Isolation level. It is users' responsibility to guarantee uniqueness of the ID so it is not recommended to use this method unless you know exactly what you are doing.

Parameters:

txId - an user-provided unique transaction ID

isolation - an isolation level

Returns:

DistributedTransaction

Throws:

TransactionException - if starting the transaction failed

start

@Deprecated
DistributedTransaction start(Isolation isolation,
                                         SerializableStrategy strategy)
                                  throws TransactionException

Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.

Starts a new transaction with the specified Isolation level and SerializableStrategy. If the isolation is not SERIALIZABLE, the serializable strategy is ignored.

Parameters:

isolation - an isolation level

strategy - a serializable strategy

Returns:

DistributedTransaction

Throws:

TransactionException - if starting the transaction failed

start

@Deprecated
DistributedTransaction start(SerializableStrategy strategy)
                                  throws TransactionException

Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.

Starts a new transaction with Serializable isolation level and the specified SerializableStrategy.

Parameters:

strategy - a serializable strategy

Returns:

DistributedTransaction

Throws:

TransactionException - if starting the transaction failed

start

@Deprecated
DistributedTransaction start(java.lang.String txId,
                                         SerializableStrategy strategy)
                                  throws TransactionException

Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.

Starts a new transaction with the specified transaction ID, Serializable isolation level and the specified SerializableStrategy. It is users' responsibility to guarantee uniqueness of the ID so it is not recommended to use this method unless you know exactly what you are doing.

Parameters:

txId - an user-provided unique transaction ID

strategy - a serializable strategy

Returns:

DistributedTransaction

Throws:

TransactionException - if starting the transaction failed

start

@Deprecated
DistributedTransaction start(java.lang.String txId,
                                         Isolation isolation,
                                         SerializableStrategy strategy)
                                  throws TransactionException

Deprecated. As of release 2.4.0. Will be removed in release 4.0.0.

Starts a new transaction with the specified transaction ID, Isolation level and SerializableStrategy. It is users' responsibility to guarantee uniqueness of the ID so it is not recommended to use this method unless you know exactly what you are doing. If the isolation is not SERIALIZABLE, the serializable strategy is ignored.

Parameters:

txId - an user-provided unique transaction ID

isolation - an isolation level

strategy - a serializable strategy

Returns:

DistributedTransaction

Throws:

TransactionException - if starting the transaction failed

getState

TransactionState getState(java.lang.String txId)
                   throws TransactionException

Returns the state of a given transaction.

Parameters:

txId - a transaction ID

Returns:

TransactionState

Throws:

TransactionException - if getting the state of a given transaction failed

abort

TransactionState abort(java.lang.String txId)
                throws TransactionException

Aborts a given transaction.

Parameters:

txId - a transaction ID

Returns:

TransactionState

Throws:

TransactionException - if aborting the given transaction failed

close

void close()

Closes connections to the cluster. The connections are shared among multiple services such as StorageService and TransactionService, thus this should only be used when closing applications.