org.apache.derby.iapi.store.raw
Interface RawStoreFactory

All Superinterfaces:
Corruptable
All Known Implementing Classes:
RawStore

public interface RawStoreFactory
extends Corruptable

RawStoreFactory implements a single unit of transactional storage. A RawStoreFactory contains Segments and Segments contain Containers.

Segments are identified by integer identifiers that are unique within a RawStoreFactory.

Containers are also identified by unique integer identifiers within a RawStoreFactory, but will overlap with segment identifiers.

LIMITS
This is a list of (hopefully) all limits within the raw store. Where a size has more than one limit all are documented (rather than just the most restrictive) so that the correct limit can be found if the most restictive is every removed.

Access and RawStore work together to provide the ACID properties of transactions. On a high level, RawStore deals with anything that directly impacts persistency. On a more detailed level, RawStore provides logging, rollback and recovery, data management on page, page allocation and deallocation, container allocation and deallocation.

RawStore is organized as 3 branches, transaction, data, and logging. These branches each have its own "factory", the transaction factory hands out transactions, the data factory hands out containers, and the log factory hands out logger (or log buffers) for transactions to write on. For a more detailed description on these factories, please see their corresponding javadocs. MT - Thread Safe

See Also:
ContainerHandle

Field Summary
static int CONTAINER_CACHE_SIZE_DEFAULT
          Default value for CONTAINER_CACHE_SIZE_PARAMETER (100).
static int CONTAINER_CACHE_SIZE_MAXIMUM
          Maximum container cache size we will accept (MAXINT).
static int CONTAINER_CACHE_SIZE_MINIMUM
          Minimum container cache size accepted (2).
static java.lang.String CONTAINER_CACHE_SIZE_PARAMETER
          Property name for the number of open files to maintain associated with the page cache.
static java.lang.String CONTAINER_INITIAL_PAGES
          Property name for container which attempts to be created with an initial size of this many pages.
static java.lang.String CRYPTO_OLD_EXTERNAL_KEY_VERIFY_FILE
          A File used to save the old copy of the verify key (Attribute.CRYPTO_EXTERNAL_KEY_VERIFY_FILE) file during re-encryption of the database.
static java.lang.String DATA_ENCRYPT_ALGORITHM_VERSION
          This variable is used to store the encryption scheme to allow for any future changes in encryption schemes of data This property has been introduced in version 10 Value starts at 1
static int DB_ENCRYPTION_IN_CLEANUP
           
static int DB_ENCRYPTION_IN_PROGRESS
           
static int DB_ENCRYPTION_IN_UNDO
           
static java.lang.String DB_ENCRYPTION_STATUS
           
static int DEFAULT_ENCRYPTION_BLOCKSIZE
          default encryption block size In old existing databases (ie 5.1.x), the default encryption block size used is 8.
static int DERBY_STORE_MAJOR_VERSION_10
          Derby 10 Store Major version
static int DERBY_STORE_MINOR_VERSION_1
          Derby Store Minor Version (1)
static int DERBY_STORE_MINOR_VERSION_2
          Derby Store Minor Version (2)
static int DERBY_STORE_MINOR_VERSION_3
          Derby Store Minor Version (3)
static int DERBY_STORE_MINOR_VERSION_4
          Derby Store Minor Version (4)
static java.lang.String ENCRYPTED_KEY
          If dataEncryption is true, store the encrypted key in services.properties file.
static int ENCRYPTION_ALIGNMENT
          encryption alignment requirement.
static java.lang.String ENCRYPTION_BLOCKSIZE
          encryption block size used during creation of encrypted database This property is not set by the user; it is set by the engine when RawStore boots up during creation of an encrypted database
static java.lang.String KEEP_TRANSACTION_LOG
          for debugging, keep all transaction logs intact.
static java.lang.String LOG_ENCRYPT_ALGORITHM_VERSION
          Store the encryption scheme used for logging This will allow for any future changes in encryption schemes of logs This variable has been introduced in version 10 and value starts at 1.
static short MAX_CONTAINER_INITIAL_PAGES
          Maximum number of initial pages when a container is created
static int MINIMUM_RECORD_SIZE_DEFAULT
          Default value for MINIMUM_RECORD_SIZE_PARAMETER for heap tables that allow overflow.
static int MINIMUM_RECORD_SIZE_MINIMUM
          Minimum value for MINIMUM_RECORD_SIZE_PARAMETER (1).
static java.lang.String MINIMUM_RECORD_SIZE_PARAMETER
          Property name for the default minimum record size to be used in the storage area.
static java.lang.String MODULE
          module name
static java.lang.String OLD_ENCRYPTED_KEY
          When the datbase is getting re-encrypted old encrypted key is stored in the service.properties until re-encyrption successfully completes or rolled back.
static int PAGE_CACHE_SIZE_DEFAULT
          Default value for PAGE_CACHE_SIZE_PARAMETER (1000).
static int PAGE_CACHE_SIZE_MAXIMUM
          Maximum page cache size we will accept (MAXINT).
static int PAGE_CACHE_SIZE_MINIMUM
          Minimum page cache size we will accept (40).
static java.lang.String PAGE_CACHE_SIZE_PARAMETER
          Property name for the page cache size to be used in the storage area.
static java.lang.String PAGE_RESERVED_SPACE_PARAMETER
          Property name for percentage of space to leave free on page for updates.
static java.lang.String PAGE_RESERVED_ZERO_SPACE_STRING
           
static java.lang.String PAGE_REUSABLE_RECORD_ID
          Property name for container which reuses recordId when a page is reused.
static int PAGE_SIZE_DEFAULT
          Default value for PAGE_SIZE_PARAMETER (4096).
static int PAGE_SIZE_MINIMUM
          Minimum page size we will accept (1024).
static java.lang.String PAGE_SIZE_STRING
           
static java.lang.String PATCH_INITPAGE_RECOVER_ERROR
          The following is a to enable patch for databases with recovery errors during redo of InitPage.
static java.lang.String PRE_ALLOCATE_PAGE
          Property name for the number of pages we try to pre-allocate in one /** synchronous I/O
static int STREAM_FILE_BUFFER_SIZE_DEFAULT
          Default value for STREAM_FILE_BUFFER_SIZE_PARAMETER (16384).
static int STREAM_FILE_BUFFER_SIZE_MAXIMUM
          Maximum stream file buffer size we will accept (MAXINT).
static int STREAM_FILE_BUFFER_SIZE_MINIMUM
          Minimum stream file buffer size we will accept (1024).
static java.lang.String STREAM_FILE_BUFFER_SIZE_PARAMETER
          Property name for buffer size to be used in the stream file container.
 
Method Summary
 void backup(java.lang.String backupDir, boolean wait)
          Backup the database to backupDir.
 void backupAndEnableLogArchiveMode(java.lang.String backupDir, boolean deleteOnlineArchivedLogFiles, boolean wait)
          Backup the database to a backup directory and enable the log archive mode that will keep the archived log files required for roll-forward from this version backup.
 java.io.Serializable changeBootPassword(java.util.Properties properties, java.io.Serializable changePassword)
          Change the boot password.
 void checkpoint()
          Checkpoint the database.
 boolean checkVersion(int requiredMajorVersion, int requiredMinorVersion, java.lang.String feature)
          Check to see if a database has been upgraded to the required level in order to use a store feature.
 void createFinished()
           
 int decrypt(byte[] ciphertext, int offset, int length, byte[] cleartext, int outputOffset)
          Decrypt cleartext from ciphertext.
 void disableLogArchiveMode(boolean deleteOnlineArchivedLogFiles)
          disables the log archival process, i.e No old log files will be kept around for a roll-forward recovery.
 int encrypt(byte[] cleartext, int offset, int length, byte[] ciphertext, int outputOffset, boolean newEngine)
          Encrypt cleartext into ciphertext.
 void failover(java.lang.String dbname)
          Start failover for this database.
 Transaction findUserTransaction(ContextManager contextMgr, java.lang.String transName)
          Find a user transaction in the context manager, which must be the current context manager.
 void freeze()
          Freeze the database temporarily so a backup can be taken.
 void freezePersistentStore()
          Freeze the database from altering any persistent storage.
 DaemonService getDaemon()
          If this raw store has a daemon that services its need, return the daemon.
 java.lang.String getDataFactoryModule()
           
 int getEncryptionBlockSize()
          Returns the encryption block size used during creation of the encrypted database
 LockFactory getLockFactory()
          Get the LockFactory to use with this store.
 java.lang.String getLogFactoryModule()
           
 long getMaxContainerId()
          Return an id which can be used to create a container.
 void getRawStoreProperties(PersistentSet tc)
          Get JBMS properties relavent to raw store
 java.lang.String getTransactionFactoryModule()
           
 TransactionInfo[] getTransactionInfo()
           
 TransactionFactory getXactFactory()
          Get the Transaction Factory to use with this store.
 java.lang.Object getXAResourceManager()
           
 void idle()
          Idle the raw store as much as possible.
 boolean isReadOnly()
          Is the store read-only.
 ScanHandle openFlushedScan(DatabaseInstant start, int groupsIWant)
          Get a flushed scan.
 int random()
          Returns a secure random number for this raw store - if database is not encrypted, returns 0.
 Transaction startGlobalTransaction(ContextManager contextMgr, int format_id, byte[] global_id, byte[] local_id)
          Create a global user transaction, almost all work within the raw store is performed in the context of a transaction.
 Transaction startInternalTransaction(ContextManager contextMgr)
          Create an internal transaction.
 Transaction startNestedReadOnlyUserTransaction(CompatibilitySpace compatibilitySpace, ContextManager contextMgr, java.lang.String transName)
          Create a nested user transaction, almost all work within the raw store is performed in the context of a transaction.
 Transaction startNestedUpdateUserTransaction(ContextManager contextMgr, java.lang.String transName)
          Create a nested user transaction, almost all work within the raw store is performed in the context of a transaction.
 void startReplicationMaster(java.lang.String dbmaster, java.lang.String host, int port, java.lang.String replicationMode)
          Start the replication master role for this database
 Transaction startTransaction(ContextManager contextMgr, java.lang.String transName)
          Create a user transaction, almost all work within the raw store is performed in the context of a transaction.
 void stopReplicationMaster()
          Stop the replication master role for this database.
 void unfreeze()
          Unfreeze the database after a backup has been taken.
 void unfreezePersistentStore()
          Unfreeze the database, persistent storage can now be altered.
 
Methods inherited from interface org.apache.derby.iapi.store.raw.Corruptable
markCorrupt
 

Field Detail

DERBY_STORE_MINOR_VERSION_1

static final int DERBY_STORE_MINOR_VERSION_1
Derby Store Minor Version (1)

See Also:
Constant Field Values

DERBY_STORE_MINOR_VERSION_2

static final int DERBY_STORE_MINOR_VERSION_2
Derby Store Minor Version (2)

See Also:
Constant Field Values

DERBY_STORE_MINOR_VERSION_3

static final int DERBY_STORE_MINOR_VERSION_3
Derby Store Minor Version (3)

See Also:
Constant Field Values

DERBY_STORE_MINOR_VERSION_4

static final int DERBY_STORE_MINOR_VERSION_4
Derby Store Minor Version (4)

See Also:
Constant Field Values

DERBY_STORE_MAJOR_VERSION_10

static final int DERBY_STORE_MAJOR_VERSION_10
Derby 10 Store Major version

See Also:
Constant Field Values

PAGE_SIZE_DEFAULT

static final int PAGE_SIZE_DEFAULT
Default value for PAGE_SIZE_PARAMETER (4096).

See Also:
Constant Field Values

PAGE_SIZE_MINIMUM

static final int PAGE_SIZE_MINIMUM
Minimum page size we will accept (1024).

See Also:
Constant Field Values

PAGE_SIZE_STRING

static final java.lang.String PAGE_SIZE_STRING
See Also:
Constant Field Values

PAGE_CACHE_SIZE_PARAMETER

static final java.lang.String PAGE_CACHE_SIZE_PARAMETER
Property name for the page cache size to be used in the storage area. Equal to 'derby.storage.pageCacheSize'

See Also:
Constant Field Values

PAGE_CACHE_SIZE_DEFAULT

static final int PAGE_CACHE_SIZE_DEFAULT
Default value for PAGE_CACHE_SIZE_PARAMETER (1000).

See Also:
Constant Field Values

PAGE_CACHE_SIZE_MINIMUM

static final int PAGE_CACHE_SIZE_MINIMUM
Minimum page cache size we will accept (40).

See Also:
Constant Field Values

PAGE_CACHE_SIZE_MAXIMUM

static final int PAGE_CACHE_SIZE_MAXIMUM
Maximum page cache size we will accept (MAXINT).

See Also:
Constant Field Values

CONTAINER_CACHE_SIZE_PARAMETER

static final java.lang.String CONTAINER_CACHE_SIZE_PARAMETER
Property name for the number of open files to maintain associated with the page cache. Internally this is referred to as the "ContainerCache". Each object in this cache maps to a java level "open" file on a file in the database directory. Although actual implementation depends on JVM implementation, this usually maps to underlying open file resources in the underlying operating system. Setting this number too high may result in I/O failures reported by Derby, which are the result of hitting some user and/or OS limit on the number of open files allowed. These I/O errors may happen during read, write and/or open operations. Sometimes these limits can be avoided simply by executing an OS specific command to raise the maximum open files allowed by whatever mechanism is used to control resources allowed to be consumed by the JVM. Derby may also open other files separate from this cache, so exausting the open file resource may cause other operations than I/O to data pages to fail. A partial list of these operations includes: recovery logging, error logging, external sorting, and LOB disk overflow. The default maximum size of this cache is 100 open files. The minimum size of this cache is 2 open files, attempting to set this cache to a smaller size or a negative number will result in a size 2 cache. Setting the cache size to a number bigger than an INT, or any sort of illegal format number will result in a cache size of 100 open files. Equal to 'derby.storage.fileCacheSize'

See Also:
Constant Field Values

CONTAINER_CACHE_SIZE_DEFAULT

static final int CONTAINER_CACHE_SIZE_DEFAULT
Default value for CONTAINER_CACHE_SIZE_PARAMETER (100).

See Also:
Constant Field Values

CONTAINER_CACHE_SIZE_MINIMUM

static final int CONTAINER_CACHE_SIZE_MINIMUM
Minimum container cache size accepted (2).

See Also:
Constant Field Values

CONTAINER_CACHE_SIZE_MAXIMUM

static final int CONTAINER_CACHE_SIZE_MAXIMUM
Maximum container cache size we will accept (MAXINT).

See Also:
Constant Field Values

MAX_CONTAINER_INITIAL_PAGES

static final short MAX_CONTAINER_INITIAL_PAGES
Maximum number of initial pages when a container is created

See Also:
Constant Field Values

MINIMUM_RECORD_SIZE_PARAMETER

static final java.lang.String MINIMUM_RECORD_SIZE_PARAMETER
Property name for the default minimum record size to be used in the storage area. Minimum record size is the minimum number of bytes that a record will reserve on disk.

See Also:
Constant Field Values

MINIMUM_RECORD_SIZE_DEFAULT

static final int MINIMUM_RECORD_SIZE_DEFAULT
Default value for MINIMUM_RECORD_SIZE_PARAMETER for heap tables that allow overflow. By setting minimumRecordSize to 12 bytes, we guarantee there is enough space to update the row even there is not enough space on the page. The 12 bytes will guarantee there is room for an overflow pointer (page + id).

See Also:
Constant Field Values

MINIMUM_RECORD_SIZE_MINIMUM

static final int MINIMUM_RECORD_SIZE_MINIMUM
Minimum value for MINIMUM_RECORD_SIZE_PARAMETER (1).

See Also:
Constant Field Values

PAGE_RESERVED_SPACE_PARAMETER

static final java.lang.String PAGE_RESERVED_SPACE_PARAMETER
Property name for percentage of space to leave free on page for updates.

See Also:
Constant Field Values

PAGE_RESERVED_ZERO_SPACE_STRING

static final java.lang.String PAGE_RESERVED_ZERO_SPACE_STRING
See Also:
Constant Field Values

PRE_ALLOCATE_PAGE

static final java.lang.String PRE_ALLOCATE_PAGE
Property name for the number of pages we try to pre-allocate in one /** synchronous I/O

See Also:
Constant Field Values

PAGE_REUSABLE_RECORD_ID

static final java.lang.String PAGE_REUSABLE_RECORD_ID
Property name for container which reuses recordId when a page is reused. Defaults to false, which means recordId is never reused. This property should NOT be set by the end user, only Access should set it for special conglomerates which does not count on permanant unique recordIds for all records.

See Also:
Constant Field Values

STREAM_FILE_BUFFER_SIZE_PARAMETER

static final java.lang.String STREAM_FILE_BUFFER_SIZE_PARAMETER
Property name for buffer size to be used in the stream file container. Equal to 'derby.storage.streamFileBufferSize'

See Also:
Constant Field Values

STREAM_FILE_BUFFER_SIZE_DEFAULT

static final int STREAM_FILE_BUFFER_SIZE_DEFAULT
Default value for STREAM_FILE_BUFFER_SIZE_PARAMETER (16384).

See Also:
Constant Field Values

STREAM_FILE_BUFFER_SIZE_MINIMUM

static final int STREAM_FILE_BUFFER_SIZE_MINIMUM
Minimum stream file buffer size we will accept (1024).

See Also:
Constant Field Values

STREAM_FILE_BUFFER_SIZE_MAXIMUM

static final int STREAM_FILE_BUFFER_SIZE_MAXIMUM
Maximum stream file buffer size we will accept (MAXINT).

See Also:
Constant Field Values

CONTAINER_INITIAL_PAGES

static final java.lang.String CONTAINER_INITIAL_PAGES
Property name for container which attempts to be created with an initial size of this many pages. Defaults to 1 page.
All containers are guarenteed to be created with at least 1 page, if this property is set, it will attempt to allocate CONTAINER_INITIAL_PAGES, but with no guarentee. CONTAIENR_INITIAL_PAGES legally ranges from 1 to MAX_CONTAINER_INITIAL_PAGES. Values < 1 will be set to 1 and values > MAX_CONTAINER_INITIAL_PAGES will be set to MAX_CONTAINER_INITIAL_PAGES This property should only be set in the PROPERTIES list in a CREATE TABLE or CREATE INDEX statement. The global setting of this property has no effect.

See Also:
Constant Field Values

ENCRYPTION_ALIGNMENT

static final int ENCRYPTION_ALIGNMENT
encryption alignment requirement.

See Also:
Constant Field Values

DEFAULT_ENCRYPTION_BLOCKSIZE

static final int DEFAULT_ENCRYPTION_BLOCKSIZE
default encryption block size In old existing databases (ie 5.1.x), the default encryption block size used is 8. Do not change this value unless you account for downgrade issues

See Also:
Constant Field Values

ENCRYPTION_BLOCKSIZE

static final java.lang.String ENCRYPTION_BLOCKSIZE
encryption block size used during creation of encrypted database This property is not set by the user; it is set by the engine when RawStore boots up during creation of an encrypted database

See Also:
Constant Field Values

DATA_ENCRYPT_ALGORITHM_VERSION

static final java.lang.String DATA_ENCRYPT_ALGORITHM_VERSION
This variable is used to store the encryption scheme to allow for any future changes in encryption schemes of data This property has been introduced in version 10 Value starts at 1

See Also:
Constant Field Values

LOG_ENCRYPT_ALGORITHM_VERSION

static final java.lang.String LOG_ENCRYPT_ALGORITHM_VERSION
Store the encryption scheme used for logging This will allow for any future changes in encryption schemes of logs This variable has been introduced in version 10 and value starts at 1.

See Also:
Constant Field Values

ENCRYPTED_KEY

static final java.lang.String ENCRYPTED_KEY
If dataEncryption is true, store the encrypted key in services.properties file. It is really the encrypted key, but the property key is called the encryptedBootPassword.

See Also:
Constant Field Values

OLD_ENCRYPTED_KEY

static final java.lang.String OLD_ENCRYPTED_KEY
When the datbase is getting re-encrypted old encrypted key is stored in the service.properties until re-encyrption successfully completes or rolled back. It is really the old encryptedkey, but the property key is called the OldEncryptedBootPassword.

See Also:
Constant Field Values

DB_ENCRYPTION_STATUS

static final java.lang.String DB_ENCRYPTION_STATUS
See Also:
Constant Field Values

DB_ENCRYPTION_IN_PROGRESS

static final int DB_ENCRYPTION_IN_PROGRESS
See Also:
Constant Field Values

DB_ENCRYPTION_IN_UNDO

static final int DB_ENCRYPTION_IN_UNDO
See Also:
Constant Field Values

DB_ENCRYPTION_IN_CLEANUP

static final int DB_ENCRYPTION_IN_CLEANUP
See Also:
Constant Field Values

CRYPTO_OLD_EXTERNAL_KEY_VERIFY_FILE

static final java.lang.String CRYPTO_OLD_EXTERNAL_KEY_VERIFY_FILE
A File used to save the old copy of the verify key (Attribute.CRYPTO_EXTERNAL_KEY_VERIFY_FILE) file during re-encryption of the database.

See Also:
Constant Field Values

KEEP_TRANSACTION_LOG

static final java.lang.String KEEP_TRANSACTION_LOG
for debugging, keep all transaction logs intact.

See Also:
Constant Field Values

PATCH_INITPAGE_RECOVER_ERROR

static final java.lang.String PATCH_INITPAGE_RECOVER_ERROR
The following is a to enable patch for databases with recovery errors during redo of InitPage. If this property is set and the page on the disk is corrupted and is getting exceptions like invalid page format ids, we cook up the page during the recovery time. We have seen this kind of problem with 1.5.1 databases from customer Tridium ( Bug no: 3813). This patch needs to be kept unless we find the problem is during recovery process. If we discover this problem is actaully happening at the recovery then this patch should be backed out.

See Also:
Constant Field Values

MODULE

static final java.lang.String MODULE
module name

See Also:
Constant Field Values
Method Detail

isReadOnly

boolean isReadOnly()
Is the store read-only.


getLockFactory

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


startTransaction

Transaction startTransaction(ContextManager contextMgr,
                             java.lang.String transName)
                             throws StandardException
Create a user transaction, almost all work within the raw store is performed in the context of a transaction.

Starting a transaction always performs the following steps.

  1. Create an raw store transaction context
  2. Create a new idle transaction and then link it to the context. Only one user transaction and one nested user transaction can be active in a context at any one time. After a commit the transaction may be re-used.

    Raw Store Transaction Context Behaviour
    The cleanupOnError() method of this context behaves as follows:

    • If error is an instance of StandardException that has a severity less than ExceptionSeverity.TRANSACTION_SEVERITY then no action is taken.
    • If error is an instance of StandardException that has a severity equal to ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, and the transaction returned to the idle state.
    • If error is an instance of StandardException that has a severity greater than ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.
    • If error is not an instance of StandardException then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.

    Parameters:
    contextMgr - is the context manager to use. An exception will be thrown if context is not the current context.
    transName - is the name of the transaction. Thsi name will be displayed by the transactiontable VTI.
    Throws:
    StandardException - Standard Derby error policy
    See Also:
    Transaction, Context, StandardException

startGlobalTransaction

Transaction startGlobalTransaction(ContextManager contextMgr,
                                   int format_id,
                                   byte[] global_id,
                                   byte[] local_id)
                                   throws StandardException
Create a global user transaction, almost all work within the raw store is performed in the context of a transaction.

The (format_id, global_id, branch_id) triplet is meant to come exactly from a javax.transaction.xa.Xid. We don't use Xid so that the system can be delivered on a non-1.2 vm system and not require the javax classes in the path.

Starting a transaction always performs the following steps.

  1. Create an raw store transaction context
  2. Create a new idle transaction and then link it to the context. Only one user transaction can be active in a context at any one time. After a commit the transaction may be re-used.

    Raw Store Transaction Context Behaviour
    The cleanupOnError() method of this context behaves as follows:

    • If error is an instance of StandardException that has a severity less than ExceptionSeverity.TRANSACTION_SEVERITY then no action is taken.
    • If error is an instance of StandardException that has a severity equal to ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, and the transaction returned to the idle state.
    • If error is an instance of StandardException that has a severity greater than ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.
    • If error is not an instance of StandardException then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.

    Parameters:
    contextMgr - is the context manager to use. An exception will be thrown if context is not the current context.
    format_id - the format id part of the Xid - ie. Xid.getFormatId().
    global_id - the global transaction identifier part of XID - ie. Xid.getGlobalTransactionId().
    local_id - The branch qualifier of the Xid - ie. Xid.getBranchQaulifier()
    Throws:
    StandardException - Standard Derby error policy
    See Also:
    Transaction, Context, StandardException

findUserTransaction

Transaction findUserTransaction(ContextManager contextMgr,
                                java.lang.String transName)
                                throws StandardException
Find a user transaction in the context manager, which must be the current context manager. If a user transaction does not already exist, then create one @see #startTransaction

Parameters:
contextMgr - the context manager to use. An exception will be thrown if context is not the current context.
transName - If a new transaction is started, it will be given this name. The name is displayed in the transactiontable VTI.
Throws:
StandardException - Standard Derby error policy
See Also:
startTransaction(org.apache.derby.iapi.services.context.ContextManager, java.lang.String)

startInternalTransaction

Transaction startInternalTransaction(ContextManager contextMgr)
                                     throws StandardException
Create an internal transaction.

Starting an internal transaction always performs the following steps.

  1. Create an raw store internal transaction context
  2. Create a new idle internal transaction and then link it to the context.

    AN internal transaction is identical to a user transaction with the exception that

    • Logical operations are not supported
    • Savepoints are not supported
    • Containers are not closed when commit() is called.
    • Pages are not unlatched (since containers are not closed) when commit() is called.
    • During recovery time internal transactions are rolled back before user transactions.
    Only one internal transaction can be active in a context at any one time. After a commit the transaction may be re-used.

    Raw Store Internal Transaction Context Behaviour
    The cleanupOnError() method of this context behaves as follows:

    • If error is an instance of StandardException that has a severity less than ExceptionSeverity.TRANSACTION_SEVERITY then the internal transaction is aborted, the internal transaction is closed, the context is popped off the stack, and an exception of severity Transaction exception is re-thrown.
    • If error is an instance of StandardException that has a severity greater than or equal to ExceptionSeverity.TRANSACTION_SEVERITY then the context's internal transaction is aborted, the internal transaction is closed and the context is popped off the stack.
    • If error is not an instance of StandardException then the context's internal transaction is aborted, the internal transaction is closed and the context is popped off the stack.

    Throws:
    StandardException - Standard Derby error policy
    See Also:
    Transaction, Context, StandardException

startNestedReadOnlyUserTransaction

Transaction startNestedReadOnlyUserTransaction(CompatibilitySpace compatibilitySpace,
                                               ContextManager contextMgr,
                                               java.lang.String transName)
                                               throws StandardException
Create a nested user transaction, almost all work within the raw store is performed in the context of a transaction.

A nested user transaction is exactly the same as a user transaction, except that one can specify a compatibility space to associate with the transaction. Starting a transaction always performs the following steps.

  1. Create an raw store transaction context
  2. Create a new idle transaction and then link it to the context. Only one user transaction and one nested user transaction can be active in a context at any one time. After a commit the transaction may be re-used.

    Raw Store Transaction Context Behaviour
    The cleanupOnError() method of this context behaves as follows:

    • If error is an instance of StandardException that has a severity less than ExceptionSeverity.TRANSACTION_SEVERITY then no action is taken.
    • If error is an instance of StandardException that has a severity equal to ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, and the transaction returned to the idle state. If a user transaction exists on the context stack then that transaction is aborted also.
    • If error is an instance of StandardException that has a severity greater than ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.
    • If error is not an instance of StandardException then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.

    Parameters:
    compatibilitySpace - compatibility space to use for locks.
    contextMgr - is the context manager to use. An exception will be thrown if context is not the current context.
    transName - is the name of the transaction. This name will be displayed by the transactiontable VTI.
    Throws:
    StandardException - Standard Derby error policy
    See Also:
    Transaction, Context, StandardException

startNestedUpdateUserTransaction

Transaction startNestedUpdateUserTransaction(ContextManager contextMgr,
                                             java.lang.String transName)
                                             throws StandardException
Create a nested user transaction, almost all work within the raw store is performed in the context of a transaction.

A nested user transaction is exactly the same as a user transaction, except that one can specify a compatibility space to associate with the transaction. Starting a transaction always performs the following steps.

  1. Create an raw store transaction context
  2. Create a new idle transaction and then link it to the context. Only one user transaction and one nested user transaction can be active in a context at any one time. After a commit the transaction may be re-used.

    Raw Store Transaction Context Behaviour
    The cleanupOnError() method of this context behaves as follows:

    • If error is an instance of StandardException that has a severity less than ExceptionSeverity.TRANSACTION_SEVERITY then no action is taken.
    • If error is an instance of StandardException that has a severity equal to ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, and the transaction returned to the idle state. If a user transaction exists on the context stack then that transaction is aborted also.
    • If error is an instance of StandardException that has a severity greater than ExceptionSeverity.TRANSACTION_SEVERITY then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.
    • If error is not an instance of StandardException then the context's transaction is aborted, the transaction closed, and the context is popped off the stack.

    Parameters:
    contextMgr - is the context manager to use. An exception will be thrown if context is not the current context.
    transName - is the name of the transaction. This name will be displayed by the transactiontable VTI.
    Throws:
    StandardException - Standard Derby error policy
    See Also:
    Transaction, Context, StandardException

getTransactionInfo

TransactionInfo[] getTransactionInfo()
See Also:
AccessFactory.getTransactionInfo()

startReplicationMaster

void startReplicationMaster(java.lang.String dbmaster,
                            java.lang.String host,
                            int port,
                            java.lang.String replicationMode)
                            throws StandardException
Start the replication master role for this database

Parameters:
dbmaster - The master database that is being replicated.
host - The hostname for the slave
port - The port the slave is listening on
replicationMode - The type of replication contract. Currently only asynchronous replication is supported, but 1-safe/2-safe/very-safe modes may be added later.
Throws:
StandardException - Standard Derby exception policy, thrown on error.

stopReplicationMaster

void stopReplicationMaster()
                           throws StandardException
Stop the replication master role for this database.

Throws:
StandardException - Standard Derby exception policy, thrown on error.

failover

void failover(java.lang.String dbname)
              throws StandardException
Start failover for this database.

Parameters:
dbname - the replication database that is being failed over.
Throws:
StandardException - Standard Derby exception policy, 1) If the failover succeeds, an exception is thrown to indicate that the master database was shutdown after a successful failover 2) If a failure occurs during network communication with slave.

freeze

void freeze()
            throws StandardException
Freeze the database temporarily so a backup can be taken.

Please see Derby on line documentation on backup and restore.

Throws:
StandardException - Thrown on error

unfreeze

void unfreeze()
              throws StandardException
Unfreeze the database after a backup has been taken.

Please see Derby on line documentation on backup and restore.

Throws:
StandardException - Thrown on error

backup

void backup(java.lang.String backupDir,
            boolean wait)
            throws StandardException
Backup the database to backupDir.

Please see Derby on line documentation on backup and restore.

Parameters:
backupDir - the name of the directory where the backup should be stored.
wait - if true, waits for all the backup blocking operations in progress to finish.
Throws:
StandardException - Thrown on error

backupAndEnableLogArchiveMode

void backupAndEnableLogArchiveMode(java.lang.String backupDir,
                                   boolean deleteOnlineArchivedLogFiles,
                                   boolean wait)
                                   throws StandardException
Backup the database to a backup directory and enable the log archive mode that will keep the archived log files required for roll-forward from this version backup.

Parameters:
backupDir - the directory name where the database backup should go. This directory will be created if not it does not exist.
deleteOnlineArchivedLogFiles - If true deletes online archived log files that exist before this backup, delete will occur only after backup is complete.
wait - if true, waits for all the backup blocking operations in progress to finish.
Throws:
StandardException - Thrown on error

disableLogArchiveMode

void disableLogArchiveMode(boolean deleteOnlineArchivedLogFiles)
                           throws StandardException
disables the log archival process, i.e No old log files will be kept around for a roll-forward recovery.

Parameters:
deleteOnlineArchivedLogFiles - If true deletes all online archived log files that exist before this call immediately; Only restore that can be performed after disabling log archive mode is version recovery.
Throws:
StandardException - Thrown on error

checkpoint

void checkpoint()
                throws StandardException
Checkpoint the database. The raw store will wait for any current checkpoints to complete. It will start a new checkpoint and not return until that checkpoint completes.

Throws:
StandardException - Standard Derby error policy

idle

void idle()
          throws StandardException
Idle the raw store as much as possible.

Throws:
StandardException - Standard Derby error policy

openFlushedScan

ScanHandle openFlushedScan(DatabaseInstant start,
                           int groupsIWant)
                           throws StandardException
Get a flushed scan.

Parameters:
start - The instant for the beginning of the scan.
groupsIWant - log record groups the caller wants to scan.
Throws:
StandardException - StandardDerby error policy

getDaemon

DaemonService getDaemon()
If this raw store has a daemon that services its need, return the daemon. If not, return null


getTransactionFactoryModule

java.lang.String getTransactionFactoryModule()

getDataFactoryModule

java.lang.String getDataFactoryModule()

getLogFactoryModule

java.lang.String getLogFactoryModule()

getXAResourceManager

java.lang.Object getXAResourceManager()
                                      throws StandardException
Throws:
StandardException

createFinished

void createFinished()
                    throws StandardException
Throws:
StandardException

getRawStoreProperties

void getRawStoreProperties(PersistentSet tc)
                           throws StandardException
Get JBMS properties relavent to raw store

Throws:
StandardException - Standard Derby exception policy.

freezePersistentStore

void freezePersistentStore()
                           throws StandardException
Freeze the database from altering any persistent storage.

Throws:
StandardException - Standard Derby exception policy.

unfreezePersistentStore

void unfreezePersistentStore()
                             throws StandardException
Unfreeze the database, persistent storage can now be altered.

Throws:
StandardException - Standard Derby exception policy.

encrypt

int encrypt(byte[] cleartext,
            int offset,
            int length,
            byte[] ciphertext,
            int outputOffset,
            boolean newEngine)
            throws StandardException
Encrypt cleartext into ciphertext.

Throws:
StandardException - Standard Derby Error Policy
See Also:
CipherProvider.encrypt(byte[], int, int, byte[], int)

decrypt

int decrypt(byte[] ciphertext,
            int offset,
            int length,
            byte[] cleartext,
            int outputOffset)
            throws StandardException
Decrypt cleartext from ciphertext.

Throws:
StandardException - Standard Derby Error Policy
See Also:
CipherProvider.decrypt(byte[], int, int, byte[], int)

getEncryptionBlockSize

int getEncryptionBlockSize()
Returns the encryption block size used during creation of the encrypted database


random

int random()
Returns a secure random number for this raw store - if database is not encrypted, returns 0.


changeBootPassword

java.io.Serializable changeBootPassword(java.util.Properties properties,
                                        java.io.Serializable changePassword)
                                        throws StandardException
Change the boot password. Return the encrypted form of the secret key. The new value must be a String of the form: oldBootPassword, newBootPassword

Throws:
StandardException - Standard Derby Error Policy

getMaxContainerId

long getMaxContainerId()
                       throws StandardException
Return an id which can be used to create a container.

Return an id number with is greater than any existing container in the current database. Caller will use this to allocate future container numbers - most likely caching the value and then incrementing it as it is used.

Returns:
The an id which can be used to create a container.
Throws:
StandardException - Standard exception policy.

getXactFactory

TransactionFactory getXactFactory()
Get the Transaction Factory to use with this store.


checkVersion

boolean checkVersion(int requiredMajorVersion,
                     int requiredMinorVersion,
                     java.lang.String feature)
                     throws StandardException
Check to see if a database has been upgraded to the required level in order to use a store feature.

Parameters:
requiredMajorVersion - required database Engine major version
requiredMinorVersion - required database Engine minor version
feature - Non-null to throw an exception, null to return the state of the version match.
Returns:
true if the database has been upgraded to the required level, false otherwise.
Throws:
StandardException - if the database is not at the require version when feature feature is not null .

Built on Thu 2010-12-23 20:49:13+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.