com.scalar.db.api

Interface DistributedTransaction

All Known Implementing Classes:

ConsensusCommit, GrpcTransaction, JdbcTransaction

public interface DistributedTransaction

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

Method Summary

Modifier and Type	Method and Description
void	abort() Aborts a transaction.
void	commit() Commits a transaction.
void	delete(Delete delete) Deletes an entry from the storage through a transaction with the specified Delete command.
void	delete(java.util.List<Delete> deletes) Deletes entries from the storage through a transaction with the specified list of Delete commands.
java.util.Optional<Result>	get(Get get) Retrieves a result from the storage through a transaction with the specified Get command with a primary key and returns the result.
java.lang.String	getId() Returns the ID of a transaction.
java.util.Optional<java.lang.String>	getNamespace() Returns the namespace
java.util.Optional<java.lang.String>	getTable() Returns the table name
void	mutate(java.util.List<? extends Mutation> mutations) Mutates entries of the storage through a transaction with the specified list of Mutation commands.
void	put(java.util.List<Put> puts) Inserts/Updates multiple entries to the storage through a transaction with the specified list of Put commands.
void	put(Put put) Inserts/Updates an entry to the storage through a transaction with the specified Put command.
java.util.List<Result>	scan(Scan scan) Retrieves results from the storage through a transaction with the specified Scan command with a partition key and returns a list of Result.
void	with(java.lang.String namespace, java.lang.String tableName) Sets the specified namespace and the table name as default values in the instance
void	withNamespace(java.lang.String namespace) Sets the specified namespace as a default value in the instance
void	withTable(java.lang.String tableName) Sets the specified table name as a default value in the instance

Method Detail

getId

java.lang.String getId()

Returns the ID of a transaction. Whether or not it can return the transaction ID is dependent on underlining implementations.

Returns:

the ID of a transaction

with

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

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

void withNamespace(java.lang.String namespace)

Sets the specified namespace as a default value in the instance

Parameters:

namespace - default namespace to operate for

getNamespace

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

Returns the namespace

Returns:

an Optional with the namespace

withTable

void withTable(java.lang.String tableName)

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

Parameters:

tableName - default table name to operate for

getTable

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

Returns the table name

Returns:

an Optional with the table name

get

java.util.Optional<Result> get(Get get)
                        throws CrudException

Retrieves a result from the storage through a transaction with the specified Get command with a primary key and returns the result.

Parameters:

get - a Get command

Returns:

an Optional with the returned result

Throws:

CrudException - if the operation failed

scan

java.util.List<Result> scan(Scan scan)
                     throws CrudException

Retrieves results from the storage through a transaction with the specified Scan command with a partition key and returns a list of Result. Results can be filtered by specifying a range of clustering keys.

Parameters:

scan - a Scan command

Returns:

a list of Result

Throws:

CrudException - if the operation failed

put

void put(Put put)
  throws CrudException

Inserts/Updates an entry to the storage through a transaction with the specified Put command. Note that the conditions set in Put will be ignored. Please program such conditions in a transaction if you want to implement conditional mutation.

Parameters:

put - a Put command

Throws:

CrudException - if the operation failed

put

void put(java.util.List<Put> puts)
  throws CrudException

Inserts/Updates multiple entries to the storage through a transaction with the specified list of Put commands. Note that the conditions set in Put will be ignored. Please program such conditions in a transaction if you want to implement conditional mutation.

Parameters:

puts - a list of Put commands

Throws:

CrudException - if the operation failed

delete

void delete(Delete delete)
     throws CrudException

Deletes an entry from the storage through a transaction with the specified Delete command. Note that the conditions set in Delete will be ignored. Please program such conditions in a transaction if you want to implement conditional mutation.

Parameters:

delete - a Delete command

Throws:

CrudException - if the operation failed

delete

void delete(java.util.List<Delete> deletes)
     throws CrudException

Deletes entries from the storage through a transaction with the specified list of Delete commands. Note that the conditions set in Delete will be ignored. Please program such conditions in a transaction if you want to implement conditional mutation.

Parameters:

deletes - a list of Delete commands

Throws:

CrudException - if the operation failed

mutate

void mutate(java.util.List<? extends Mutation> mutations)
     throws CrudException

Mutates entries of the storage through a transaction with the specified list of Mutation commands.

Parameters:

mutations - a list of Mutation commands

Throws:

CrudException - if the operation failed

commit

void commit()
     throws CommitException,
            UnknownTransactionStatusException

Commits a transaction.

Throws:

CommitException - if the operation fails

UnknownTransactionStatusException - if the status of the commit is unknown

abort

void abort()
    throws AbortException

Aborts a transaction.

Throws:

AbortException - if the operation fails