Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.iapi.store.raw.xact.TransactionFactory

Modifier and Type	Field and Description
public static final String	MODULE

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if there are no backup blocking operations in progress. `false` otherwise. blockBackupBlockingOperations(boolean if `true`, waits for the current backup blocking operations in progress to finish. wait) Checks if there any backup blocking operations are in progress and prevents new ones from starting until the backup is finished.
public void	createFinished() Database creation finished
public boolean	findTransaction(TransactionId id, RawTransaction tran) Find a transaction using a transactionId and make the passed in transaction assume the identity and properties of that transaction.
public RawTransaction	findUserTransaction(RawStoreFactory rsf, ContextManager contextMgr, String transName) Find a user transaction within the given raw store and the given contextMgr.
public LogInstant	firstUpdateInstant() The first log instant that belongs to a transaction that is still active in the raw store.
public LockFactory	getLockFactory() Get the LockFactory to use with this store.
public TransactionInfo[]	getTransactionInfo()
public Formatable	getTransactionTable() Return the transaction table so it can get logged with the checkpoint log record.
public Object	getXAResourceManager() Return the module providing XAresource interface to the transaction table.
public void	handlePreparedXacts(RawStoreFactory rsf) Run through all prepared transactions known to this factory and restore their state such that they remain after recovery, and can be found and handled by a XA transaction manager.
public boolean	Returns: `true` if prepared transactions exist, `false` otherwise. hasPreparedXact() Check if there are any prepared transanctions.
public boolean	noActiveUpdateTransaction() Returns true if the transaction factory has no active updating transaction
public void	resetTranId() Reset any resettable transaction Id
public void	rollbackAllTransactions(RawTransaction the transaction used to rollback recoveryTransaction, RawStoreFactory rsf) Rollback and close all transactions known to this factory using a passed in transaction.
public void	setRawStoreFactory(RawStoreFactory rsf) make Transaction factory aware of which raw store factory it belongs to
public RawTransaction	startGlobalTransaction(RawStoreFactory rsf, ContextManager is the context manager to use. It must be the current context manager. contextMgr, int the format id part of the Xid - ie. Xid.getFormatId(). format_id, byte[] the global transaction identifier part of XID - ie. Xid.getGlobalTransactionId(). global_id, byte[] The branch qualifier of the Xid - ie. Xid.getBranchQaulifier() branch_id) Start a new transaction within the given raw store.
public RawTransaction	startInternalTransaction(RawStoreFactory rsf, ContextManager contextMgr) Start a new internal transaction within the given raw store.
public RawTransaction	startNestedReadOnlyUserTransaction(RawStoreFactory the RawStoreFactory rsf, RawTransaction the parent transaction parentTransaction, CompatibilitySpace compatibility space to use for locks. compatibilitySpace, ContextManager is the context manager to use. It must be the current context manager. contextMgr, String is the transaction name. It will be displayed in the transactiontable VTI. transName) Start a new read only transaction within the given raw store.
public RawTransaction	startNestedTopTransaction(RawStoreFactory rsf, ContextManager contextMgr) Start a new nested top transaction within the given raw store.
public RawTransaction	startNestedUpdateUserTransaction(RawStoreFactory the RawStoreFactory rsf, RawTransaction the parent transaction parentTransaction, ContextManager is the context manager to use. It must be the current context manager. contextMgr, String is the transaction name. It will be displayed in the transactiontable VTI. transName, boolean By default should the transaction commit and abort be synced to the log. Normal usage should pick true, unless there is specific performance need and usage works correctly if a commit can be lost on system crash. flush_log_on_xact_end) Start a new update transaction within the given raw store.
public RawTransaction	startTransaction(RawStoreFactory rsf, ContextManager is the context manager to use. It must be the current context manager. contextMgr, String is the transaction name. It will be displayed in the transactiontable VTI. transName) Start a new transaction within the given raw store.
public boolean	Returns: true if the daemon indicates it is being overloaded, false it's happy. must be MT-safe submitPostCommitWork(Serviceable work) Submit a post commit work to the post commit daemon.
public void	unblockBackupBlockingOperations() Backup completed.
public void	useTransactionTable(Formatable transactionTable) Use this transaction table, which is gotten from a checkpoint operation.

Inherited from org.apache.derby.iapi.store.raw.Corruptable:: markCorrupt

MODULE	back to summary
public static final String MODULE

Method Detail

blockBackupBlockingOperations back to summary

blockBackupBlockingOperations	back to summary
public boolean blockBackupBlockingOperations(boolean wait) throws StandardException Checks if there any backup blocking operations are in progress and prevents new ones from starting until the backup is finished. Parameters wait:boolean if `true`, waits for the current backup blocking operations in progress to finish. Returns:boolean `true` if there are no backup blocking operations in progress. `false` otherwise. Exceptions StandardException: if interrupted or a runtime exception occurs.

public boolean blockBackupBlockingOperations(boolean wait) throws StandardException

Checks if there any backup blocking operations are in progress and prevents new ones from starting until the backup is finished.

Parameters

wait:boolean: if true, waits for the current backup blocking operations in progress to finish.

Returns:boolean

true if there are no backup blocking operations in progress. false otherwise.

Exceptions

StandardException:: if interrupted or a runtime exception occurs.

createFinished	back to summary
public void createFinished() throws StandardException Database creation finished Exceptions StandardException: Standard Derby exception policy.

createFinished

back to summary

public void createFinished() throws StandardException

Database creation finished

Exceptions

StandardException:: Standard Derby exception policy.

findTransaction	back to summary
public boolean findTransaction(TransactionId id, RawTransaction tran) Find a transaction using a transactionId and make the passed in transaction assume the identity and properties of that transaction. Used in recovery only.

findUserTransaction back to summary

findUserTransaction	back to summary
public RawTransaction findUserTransaction(RawStoreFactory rsf, ContextManager contextMgr, String transName) throws StandardException Find a user transaction within the given raw store and the given contextMgr. If no user transaction exist, then start one with name transName. This method will push a transaction context as described in RawStoreFactory.startTransaction Exceptions StandardException: Standard Derby error policy. See Also `RawStoreFactory#findUserTransaction`, `RawStoreFactory#startTransaction`

public RawTransaction findUserTransaction(RawStoreFactory rsf, ContextManager contextMgr, String transName) throws StandardException

Find a user transaction within the given raw store and the given contextMgr. If no user transaction exist, then start one with name transName. This method will push a transaction context as described in RawStoreFactory.startTransaction

Exceptions

StandardException:: Standard Derby error policy.

firstUpdateInstant	back to summary
public LogInstant firstUpdateInstant() The first log instant that belongs to a transaction that is still active in the raw store. This is the first log record of the longest running transaction at this moment.

getLockFactory	back to summary
public LockFactory getLockFactory() Get the LockFactory to use with this store.

getTransactionInfo	back to summary
public TransactionInfo[] getTransactionInfo() See Also `org.apache.derby.iapi.store.access.AccessFactory#getTransactionInfo`

getTransactionTable	back to summary
public Formatable getTransactionTable() Return the transaction table so it can get logged with the checkpoint log record.

getXAResourceManager	back to summary
public Object getXAResourceManager() throws StandardException Return the module providing XAresource interface to the transaction table. Exceptions StandardException: Standard Derby exception policy.

getXAResourceManager

back to summary

public Object getXAResourceManager() throws StandardException

Return the module providing XAresource interface to the transaction table.

Exceptions

StandardException:: Standard Derby exception policy.

handlePreparedXacts	back to summary
public void handlePreparedXacts(RawStoreFactory rsf) throws StandardException Run through all prepared transactions known to this factory and restore their state such that they remain after recovery, and can be found and handled by a XA transaction manager. This includes creating a context manager for each, pushing a xact context, and reclaiming update locks on all data changed by the transaction. Used only in recovery. Exceptions StandardException: Derby Standard Error policy

handlePreparedXacts

back to summary

public void handlePreparedXacts(RawStoreFactory rsf) throws StandardException

Run through all prepared transactions known to this factory and restore their state such that they remain after recovery, and can be found and handled by a XA transaction manager. This includes creating a context manager for each, pushing a xact context, and reclaiming update locks on all data changed by the transaction. Used only in recovery.

Exceptions

StandardException:: Derby Standard Error policy

hasPreparedXact back to summary

hasPreparedXact	back to summary
public boolean hasPreparedXact() Check if there are any prepared transanctions. MT - unsafe, called during boot, which is single threaded. Returns:boolean `true` if prepared transactions exist, `false` otherwise.

public boolean hasPreparedXact()

Check if there are any prepared transanctions.

MT - unsafe, called during boot, which is single threaded.

Returns:boolean: true if prepared transactions exist, false otherwise.

noActiveUpdateTransaction	back to summary
public boolean noActiveUpdateTransaction() Returns true if the transaction factory has no active updating transaction

resetTranId	back to summary
public void resetTranId() throws StandardException Reset any resettable transaction Id Exceptions StandardException: Standard Derby error policy.

resetTranId

back to summary

public void resetTranId() throws StandardException

Reset any resettable transaction Id

Exceptions

StandardException:: Standard Derby error policy.

rollbackAllTransactions	back to summary
public void rollbackAllTransactions(RawTransaction recoveryTransaction, RawStoreFactory rsf) throws StandardException Rollback and close all transactions known to this factory using a passed in transaction. Used only in recovery. Parameters recoveryTransaction:RawTransaction the transaction used to rollback Exceptions StandardException: Derby Standard Error policy

rollbackAllTransactions

back to summary

public void rollbackAllTransactions(RawTransaction recoveryTransaction, RawStoreFactory rsf) throws StandardException

Rollback and close all transactions known to this factory using a passed in transaction. Used only in recovery.

Parameters

recoveryTransaction:RawTransaction: the transaction used to rollback

Exceptions

StandardException:: Derby Standard Error policy

setRawStoreFactory	back to summary
public void setRawStoreFactory(RawStoreFactory rsf) throws StandardException make Transaction factory aware of which raw store factory it belongs to

startGlobalTransaction back to summary

startGlobalTransaction	back to summary
public RawTransaction startGlobalTransaction(RawStoreFactory rsf, ContextManager contextMgr, int format_id, byte[] global_id, byte[] branch_id) throws StandardException Start a new transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startTransaction Parameters contextMgr:ContextManager is the context manager to use. It must be the current context manager. format_id:int the format id part of the Xid - ie. Xid.getFormatId(). global_id:byte[] the global transaction identifier part of XID - ie. Xid.getGlobalTransactionId(). branch_id:byte[] The branch qualifier of the Xid - ie. Xid.getBranchQaulifier() Exceptions StandardException: Standard Derby error policy. See Also `RawStoreFactory#startGlobalTransaction`

public RawTransaction startGlobalTransaction(RawStoreFactory rsf, ContextManager contextMgr, int format_id, byte[] global_id, byte[] branch_id) throws StandardException

Start a new transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startTransaction

Parameters

contextMgr:ContextManager: is the context manager to use. It must be the current context manager.
format_id:int: the format id part of the Xid - ie. Xid.getFormatId().
global_id:byte[]: the global transaction identifier part of XID - ie. Xid.getGlobalTransactionId().
branch_id:byte[]: The branch qualifier of the Xid - ie. Xid.getBranchQaulifier()

Exceptions

StandardException:: Standard Derby error policy.

startInternalTransaction back to summary

startInternalTransaction	back to summary
public RawTransaction startInternalTransaction(RawStoreFactory rsf, ContextManager contextMgr) throws StandardException Start a new internal transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startInternalTransaction Exceptions StandardException: Standard Derby error policy. See Also `RawStoreFactory#startTransaction`

public RawTransaction startInternalTransaction(RawStoreFactory rsf, ContextManager contextMgr) throws StandardException

Start a new internal transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startInternalTransaction

Exceptions

StandardException:: Standard Derby error policy.

See Also

RawStoreFactory#startTransaction

startNestedReadOnlyUserTransaction back to summary

startNestedReadOnlyUserTransaction	back to summary
public RawTransaction startNestedReadOnlyUserTransaction(RawStoreFactory rsf, RawTransaction parentTransaction, CompatibilitySpace compatibilitySpace, ContextManager contextMgr, String transName) throws StandardException Start a new read only transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startNestedTransaction Parameters rsf:RawStoreFactory the RawStoreFactory parentTransaction:RawTransaction the parent transaction compatibilitySpace:CompatibilitySpace compatibility space to use for locks. contextMgr:ContextManager is the context manager to use. It must be the current context manager. transName:String is the transaction name. It will be displayed in the transactiontable VTI. Exceptions StandardException: Standard Derby error policy. See Also `RawStoreFactory#startNestedReadOnlyUserTransaction`

public RawTransaction startNestedReadOnlyUserTransaction(RawStoreFactory rsf, RawTransaction parentTransaction, CompatibilitySpace compatibilitySpace, ContextManager contextMgr, String transName) throws StandardException

Start a new read only transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startNestedTransaction

Parameters

rsf:RawStoreFactory: the RawStoreFactory
parentTransaction:RawTransaction: the parent transaction
compatibilitySpace:CompatibilitySpace: compatibility space to use for locks.
contextMgr:ContextManager: is the context manager to use. It must be the current context manager.
transName:String: is the transaction name. It will be displayed in the transactiontable VTI.

Exceptions

StandardException:: Standard Derby error policy.

startNestedTopTransaction back to summary

startNestedTopTransaction	back to summary
public RawTransaction startNestedTopTransaction(RawStoreFactory rsf, ContextManager contextMgr) throws StandardException Start a new nested top transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startNestedTopTransaction Exceptions StandardException: Standard Derby error policy. See Also `RawStoreFactory#startTransaction(ContextManager, String)`

public RawTransaction startNestedTopTransaction(RawStoreFactory rsf, ContextManager contextMgr) throws StandardException

Start a new nested top transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startNestedTopTransaction

Exceptions

StandardException:: Standard Derby error policy.

startNestedUpdateUserTransaction back to summary

startNestedUpdateUserTransaction	back to summary
public RawTransaction startNestedUpdateUserTransaction(RawStoreFactory rsf, RawTransaction parentTransaction, ContextManager contextMgr, String transName, boolean flush_log_on_xact_end) throws StandardException Start a new update transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startNestedTransaction Parameters rsf:RawStoreFactory the RawStoreFactory parentTransaction:RawTransaction the parent transaction contextMgr:ContextManager is the context manager to use. It must be the current context manager. transName:String is the transaction name. It will be displayed in the transactiontable VTI. flush_log_on_xact_end:boolean By default should the transaction commit and abort be synced to the log. Normal usage should pick true, unless there is specific performance need and usage works correctly if a commit can be lost on system crash. Exceptions StandardException: Standard Derby error policy. See Also `RawStoreFactory#startNestedUpdateUserTransaction`

public RawTransaction startNestedUpdateUserTransaction(RawStoreFactory rsf, RawTransaction parentTransaction, ContextManager contextMgr, String transName, boolean flush_log_on_xact_end) throws StandardException

Start a new update transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startNestedTransaction

Parameters

rsf:RawStoreFactory: the RawStoreFactory
parentTransaction:RawTransaction: the parent transaction
contextMgr:ContextManager: is the context manager to use. It must be the current context manager.
transName:String: is the transaction name. It will be displayed in the transactiontable VTI.
flush_log_on_xact_end:boolean: By default should the transaction commit and abort be synced to the log. Normal usage should pick true, unless there is specific performance need and usage works correctly if a commit can be lost on system crash.

Exceptions

StandardException:: Standard Derby error policy.

startTransaction back to summary

startTransaction	back to summary
public RawTransaction startTransaction(RawStoreFactory rsf, ContextManager contextMgr, String transName) throws StandardException Start a new transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startTransaction Parameters contextMgr:ContextManager is the context manager to use. It must be the current context manager. transName:String is the transaction name. It will be displayed in the transactiontable VTI. Exceptions StandardException: Standard Derby error policy. See Also `RawStoreFactory#startTransaction`

public RawTransaction startTransaction(RawStoreFactory rsf, ContextManager contextMgr, String transName) throws StandardException

Start a new transaction within the given raw store. This method will push a transaction context as described in RawStoreFactory.startTransaction

Parameters

contextMgr:ContextManager: is the context manager to use. It must be the current context manager.
transName:String: is the transaction name. It will be displayed in the transactiontable VTI.

Exceptions

StandardException:: Standard Derby error policy.

See Also

RawStoreFactory#startTransaction

submitPostCommitWork	back to summary
public boolean submitPostCommitWork(Serviceable work) Submit a post commit work to the post commit daemon. The work is always added to the deamon, regardless of the state it returns. Returns:boolean true if the daemon indicates it is being overloaded, false it's happy. must be MT-safe

submitPostCommitWork

back to summary

public boolean submitPostCommitWork(Serviceable work)

Submit a post commit work to the post commit daemon. The work is always added to the deamon, regardless of the state it returns.

Returns:boolean: true if the daemon indicates it is being overloaded, false it's happy. must be MT-safe

unblockBackupBlockingOperations	back to summary
public void unblockBackupBlockingOperations() Backup completed. Allow backup blocking operations.

useTransactionTable	back to summary
public void useTransactionTable(Formatable transactionTable) throws StandardException Use this transaction table, which is gotten from a checkpoint operation. Use ONLY during recovery. Exceptions StandardException: Standard Derby exception policy.

useTransactionTable

back to summary

public void useTransactionTable(Formatable transactionTable) throws StandardException

Use this transaction table, which is gotten from a checkpoint operation. Use ONLY during recovery.

Exceptions

StandardException:: Standard Derby exception policy.

public Interface TransactionFactory

Field Summary

Method Summary

Field Detail

Method Detail