org.apache.omid.transaction

Class AbstractTransaction<T extends CellId>

java.lang.Object

org.apache.omid.transaction.AbstractTransaction<T>

All Implemented Interfaces:

Transaction

public abstract class AbstractTransaction<T extends CellId>
extends Object
implements Transaction

Omid's base abstract implementation of the Transaction interface. Provides extra methods to access other basic transaction state required by TransactionManager implementations based on snapshot isolation. So, this abstract class must be extended by particular implementations of transaction managers related to different storage systems (HBase...)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTransaction.VisibilityLevel

Nested classes/interfaces inherited from interface org.apache.omid.transaction.Transaction

Transaction.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected long	readTimestamp
protected long	writeTimestamp

Constructor Summary

Constructors

Constructor and Description
AbstractTransaction(long transactionId, long readTimestamp, AbstractTransaction.VisibilityLevel visibilityLevel, long epoch, Set<T> writeSet, Set<T> conflictFreeWriteSet, AbstractTransactionManager transactionManager, boolean isLowLatency)
AbstractTransaction(long transactionId, long epoch, Set<T> writeSet, Set<T> conflictFreeWriteSet, AbstractTransactionManager transactionManager, boolean isLowLatency) Base constructor
AbstractTransaction(long transactionId, long epoch, Set<T> writeSet, Set<T> conflictFreeWriteSet, AbstractTransactionManager transactionManager, long readTimestamp, long writeTimestamp, boolean isLowLatency) Base constructor

Method Summary

Modifier and Type	Method and Description
void	addConflictFreeWriteSetElement(T element) Adds an element to the transaction conflict free write-set.
void	addWriteSetElement(T element) Adds an element to the transaction write-set.
void	appendMetadata(String key, Object value) Expects they metadata stored under key "key" to be of the "Set" type, append "value" to the existing set or creates a new one
void	checkpoint() Creates a checkpoint and sets the visibility level to SNAPSHOT_EXCLUDE_CURRENT The number of checkpoints is bounded to NUM_CHECKPOINTS in order to make checkpoint a client side operation
abstract void	cleanup() Allows to define specific clean-up task for transaction implementations
long	getCommitTimestamp() Returns the commit timestamp for this transaction.
Set<T>	getConflictFreeWriteSet() Returns the current write-set for this transaction that its elements are not candidates for conflict analysis.
long	getEpoch() Returns the epoch given by the TSOServer
org.apache.phoenix.thirdparty.com.google.common.base.Optional<Object>	getMetadata(String key)
long	getReadTimestamp() Returns the read timestamp for this transaction.
long	getStartTimestamp() Returns the start timestamp for this transaction.
Transaction.Status	getStatus() Returns the current transaction Transaction.Status
long	getTransactionId() Returns the transaction identifier
AbstractTransactionManager	getTransactionManager() Returns transaction manager associated to this transaction.
AbstractTransaction.VisibilityLevel	getVisibilityLevel() Returns the visibility level for this transaction.
Set<T>	getWriteSet() Returns the current write-set for this transaction.
long	getWriteTimestamp() Returns the write timestamp for this transaction.
boolean	isLowLatency() Returns whether the transaction was created by a lowLatency TransactionalManager
boolean	isRollbackOnly() Returns whether the transaction was marked for rollback or not
void	setCommitTimestamp(long commitTimestamp) Sets the commit timestamp for this transaction.
void	setMetadata(String key, Object value)
void	setRollbackOnly() Forces the transaction to rollback, even when there's an intention to commit it.
void	setStatus(Transaction.Status status) Sets the status for this transaction.
void	setVisibilityLevel(AbstractTransaction.VisibilityLevel visibilityLevel) Sets the visibility level for this transaction.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

readTimestamp

protected long readTimestamp

writeTimestamp

protected long writeTimestamp

Constructor Detail

AbstractTransaction

public AbstractTransaction(long transactionId,
                           long epoch,
                           Set<T> writeSet,
                           Set<T> conflictFreeWriteSet,
                           AbstractTransactionManager transactionManager,
                           boolean isLowLatency)

Base constructor

Parameters:

transactionId - transaction identifier to assign

epoch - epoch of the TSOServer instance that created this transaction Used in High Availability to guarantee data consistency

writeSet - initial write set for the transaction. Should be empty in most cases.

conflictFreeWriteSet - initial conflict free write set for the transaction. Should be empty in most cases.

transactionManager - transaction manager associated to this transaction. Usually, should be the one that created the transaction instance.

AbstractTransaction

public AbstractTransaction(long transactionId,
                           long readTimestamp,
                           AbstractTransaction.VisibilityLevel visibilityLevel,
                           long epoch,
                           Set<T> writeSet,
                           Set<T> conflictFreeWriteSet,
                           AbstractTransactionManager transactionManager,
                           boolean isLowLatency)

AbstractTransaction

public AbstractTransaction(long transactionId,
                           long epoch,
                           Set<T> writeSet,
                           Set<T> conflictFreeWriteSet,
                           AbstractTransactionManager transactionManager,
                           long readTimestamp,
                           long writeTimestamp,
                           boolean isLowLatency)

Base constructor

Parameters:

transactionId - transaction identifier to assign

epoch - epoch of the TSOServer instance that created this transaction Used in High Availability to guarantee data consistency

writeSet - initial write set for the transaction. Should be empty in most cases.

transactionManager - transaction manager associated to this transaction. Usually, should be the one that created the transaction instance.

readTimestamp - the snapshot to read from

writeTimestamp - the timestamp to write to

Method Detail

checkpoint

public void checkpoint()
                throws TransactionException

Creates a checkpoint and sets the visibility level to SNAPSHOT_EXCLUDE_CURRENT The number of checkpoints is bounded to NUM_CHECKPOINTS in order to make checkpoint a client side operation

Throws:

TransactionException

cleanup

public abstract void cleanup()

Allows to define specific clean-up task for transaction implementations

getTransactionId

public long getTransactionId()

Description copied from interface: Transaction

Returns the transaction identifier

Specified by:

getTransactionId in interface Transaction

Returns:

the transaction identifier

See Also:

Transaction.getTransactionId()

getEpoch

public long getEpoch()

Description copied from interface: Transaction

Returns the epoch given by the TSOServer

Specified by:

getEpoch in interface Transaction

Returns:

the transaction's TSOServer epoch

See Also:

Transaction.getEpoch()

getStatus

public Transaction.Status getStatus()

Description copied from interface: Transaction

Returns the current transaction Transaction.Status

Specified by:

getStatus in interface Transaction

Returns:

transaction status

See Also:

Transaction.getStatus()

setRollbackOnly

public void setRollbackOnly()

Description copied from interface: Transaction

Forces the transaction to rollback, even when there's an intention to commit it.

Specified by:

setRollbackOnly in interface Transaction

See Also:

Transaction.isRollbackOnly()

isRollbackOnly

public boolean isRollbackOnly()

Description copied from interface: Transaction

Returns whether the transaction was marked for rollback or not

Specified by:

isRollbackOnly in interface Transaction

Returns:

whether the transaction is marked for rollback or not

See Also:

Transaction.isRollbackOnly()

getTransactionManager

public AbstractTransactionManager getTransactionManager()

Returns transaction manager associated to this transaction.

Returns:

transaction manager

getStartTimestamp

public long getStartTimestamp()

Returns the start timestamp for this transaction.

Returns:

start timestamp

getReadTimestamp

public long getReadTimestamp()

Returns the read timestamp for this transaction.

Specified by:

getReadTimestamp in interface Transaction

Returns:

read timestamp

getWriteTimestamp

public long getWriteTimestamp()

Returns the write timestamp for this transaction.

Specified by:

getWriteTimestamp in interface Transaction

Returns:

write timestamp

getCommitTimestamp

public long getCommitTimestamp()

Returns the commit timestamp for this transaction.

Returns:

commit timestamp

getVisibilityLevel

public AbstractTransaction.VisibilityLevel getVisibilityLevel()

Returns the visibility level for this transaction.

Returns:

visibility level

setCommitTimestamp

public void setCommitTimestamp(long commitTimestamp)

Sets the commit timestamp for this transaction.

Parameters:

commitTimestamp - the commit timestamp to set

setVisibilityLevel

public void setVisibilityLevel(AbstractTransaction.VisibilityLevel visibilityLevel)

Sets the visibility level for this transaction.

Parameters:

visibilityLevel - the AbstractTransaction.VisibilityLevel to set

setStatus

public void setStatus(Transaction.Status status)

Sets the status for this transaction.

Parameters:

status - the Status to set

getWriteSet

public Set<T> getWriteSet()

Returns the current write-set for this transaction.

Returns:

write set

getConflictFreeWriteSet

public Set<T> getConflictFreeWriteSet()

Returns the current write-set for this transaction that its elements are not candidates for conflict analysis.

Returns:

conflictFreeWriteSet

addWriteSetElement

public void addWriteSetElement(T element)

Adds an element to the transaction write-set.

Parameters:

element - the element to add

addConflictFreeWriteSetElement

public void addConflictFreeWriteSetElement(T element)

Adds an element to the transaction conflict free write-set.

Parameters:

element - the element to add

toString

public String toString()

Overrides:

toString in class Object

getMetadata

public org.apache.phoenix.thirdparty.com.google.common.base.Optional<Object> getMetadata(String key)

Specified by:

getMetadata in interface Transaction

appendMetadata

public void appendMetadata(String key,
                           Object value)

Expects they metadata stored under key "key" to be of the "Set" type, append "value" to the existing set or creates a new one

Specified by:

appendMetadata in interface Transaction

Parameters:

key - a key, like in hashtable

value - a value to associate with the given key

setMetadata

public void setMetadata(String key,
                        Object value)

Specified by:

setMetadata in interface Transaction

isLowLatency

public boolean isLowLatency()

Description copied from interface: Transaction

Returns whether the transaction was created by a lowLatency TransactionalManager

Specified by:

isLowLatency in interface Transaction

Returns:

whether the transaction was created by a lowLatency TransactionalManager