net.jmatrix.db.schema

Class DBM

java.lang.Object

net.jmatrix.db.schema.DBM

public class DBM
extends Object

Command line entry point for database management. Inputs include: - connection properties - directory of Versions Recommended Updates: Case 1: checksum of latest version mismatch. Latest version must have been APPLY Action: reapply version Case 2: (After case 1) DB version less than DiskVersion Action: UpdateAll - applies all versions up to and including current version. Case 3: DB Version is ahead of disk version (likely a rollback of software) - all rollback versions must have been APPLYed. If MANUAL - cannot be rolled back. Action: Rollback to specified version - applying rollback scripts in reverse order back to the version specified on disk. Confirm checksum. Other cases: - Mid version checksum mismatch - log schema error and continue. - File checksum does not match file checksum in DB. File was changed. - Last DB Version checksum mismatch - Schema was altered out of band.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLY
static String	DBM
static String	MANUAL
static String	ROLLBACK

Constructor Summary

Constructors

Constructor and Description
DBM(ConnectionInfo ci, File p)
DBM(String driver, String url, String user, String pass, File p)

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(String version)
void	destroy()
void	executeActionsWithLock(List<Action> actions)
void	executeActionWithLock(Action a)
boolean	executeStatement(SQLStatement sql)
DBVersion	findPreviousDBApply(Version version)
void	forceUnlock(String id)
Version	getCurrentDBVersion()
DBMData	getDBMData()
DBMLock	getExistingLock()
Version	getMaxDiskVersion()
void	init()
void	initDB()
DBMLock	lock()
void	reapply(String version)
List<Action>	recommendUpdateActions() This method makes logical comparisons between disk and db versions and recommends actions to bring the two in sync.
boolean	reloadDBVersions()
List<DiskVersion>	reloadDiskVersions()
void	rollback(String version)
void	rollbackDb(String version) Executes rollback using rollback SQL found on the current version on disk.
void	rollbackDisk(String version) Executes rollback using rollback SQL found on the current version on disk.
void	setVersion(String ver) Manually sets the version to some value.
void	showDBHistory()
void	showDiskVersions()
void	showVersionStatus()
void	unlock(DBMLock lock)
void	updateAll() Executes all recommended updates - which could include rollbacks.

Methods inherited from class java.lang.Object

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

Field Detail

DBM

public static final String DBM

See Also:

Constant Field Values

APPLY

public static final String APPLY

See Also:

Constant Field Values

ROLLBACK

public static final String ROLLBACK

See Also:

Constant Field Values

MANUAL

public static final String MANUAL

See Also:

Constant Field Values

Constructor Detail

DBM

public DBM(String driver,
   String url,
   String user,
   String pass,
   File p)
    throws SQLException

Throws:

SQLException

DBM

public DBM(ConnectionInfo ci,
   File p)
    throws SQLException

Throws:

SQLException

Method Detail

getDBMData

public DBMData getDBMData()

init

public void init()
          throws IOException,
                 SQLException

Throws:

IOException

SQLException

destroy

public void destroy()

initDB

public void initDB()
            throws SQLException,
                   IOException

Throws:

SQLException

IOException

showDBHistory

public void showDBHistory()
                   throws Exception

Throws:

Exception

showDiskVersions

public void showDiskVersions()
                      throws Exception

Throws:

Exception

showVersionStatus

public void showVersionStatus()
                       throws NoSuchMethodException,
                              SecurityException,
                              IllegalAccessException,
                              IllegalArgumentException,
                              InvocationTargetException,
                              IOException,
                              SQLException

Throws:

NoSuchMethodException

SecurityException

IllegalAccessException

IllegalArgumentException

InvocationTargetException

IOException

SQLException

reloadDBVersions

public boolean reloadDBVersions()
                         throws SQLException

Throws:

SQLException

reloadDiskVersions

public List<DiskVersion> reloadDiskVersions()
                                     throws IOException

Throws:

IOException

getMaxDiskVersion

public Version getMaxDiskVersion()
                          throws IOException

Throws:

IOException

setVersion

public void setVersion(String ver)
                throws SQLException,
                       NoSuchMethodException,
                       SecurityException,
                       IllegalAccessException,
                       IllegalArgumentException,
                       InvocationTargetException,
                       IOException

Manually sets the version to some value. This can be helpful when starting to manage a schema 'in flight'

Throws:

IOException

InvocationTargetException

IllegalArgumentException

IllegalAccessException

SecurityException

NoSuchMethodException

SQLException

reapply

public void reapply(String version)
             throws SQLException,
                    InterruptedException

Throws:

SQLException

InterruptedException

rollback

public void rollback(String version)
              throws SQLException,
                     IOException,
                     InterruptedException

Throws:

SQLException

IOException

InterruptedException

rollbackDisk

public void rollbackDisk(String version)
                  throws SQLException,
                         IOException,
                         InterruptedException

Executes rollback using rollback SQL found on the current version on disk.

Throws:

SQLException

IOException

InterruptedException

rollbackDb

public void rollbackDb(String version)
                throws SQLException,
                       IOException,
                       InterruptedException

Executes rollback using rollback SQL found on the current version on disk.

Throws:

SQLException

IOException

InterruptedException

apply

public void apply(String version)
           throws SQLException,
                  IOException,
                  InterruptedException

Throws:

SQLException

IOException

InterruptedException

findPreviousDBApply

public DBVersion findPreviousDBApply(Version version)

recommendUpdateActions

public List<Action> recommendUpdateActions()
                                    throws IOException,
                                           SQLException

This method makes logical comparisons between disk and db versions and recommends actions to bring the two in sync. Common scenarios: 1) Disk version greater than db version - recommend apply disk versions 2) DB Version greater than disk version - recommend rollback if possible 3) Current disk revision checksum differnet than that in db. recommend: reapply current version.

Throws:

IOException

SQLException

executeActionWithLock

public void executeActionWithLock(Action a)
                           throws SQLException,
                                  InterruptedException

Throws:

SQLException

InterruptedException

executeActionsWithLock

public void executeActionsWithLock(List<Action> actions)
                            throws SQLException,
                                   InterruptedException

Throws:

SQLException

InterruptedException

updateAll

public void updateAll()
               throws SQLException,
                      IOException,
                      InterruptedException

Executes all recommended updates - which could include rollbacks.

Throws:

SQLException

IOException

InterruptedException

getCurrentDBVersion

public Version getCurrentDBVersion()
                            throws SQLException

Throws:

SQLException

getExistingLock

public DBMLock getExistingLock()
                        throws SQLException

Throws:

SQLException

executeStatement

public boolean executeStatement(SQLStatement sql)
                         throws SQLException

Throws:

SQLException

lock

public DBMLock lock()
             throws InterruptedException,
                    SQLException

Throws:

InterruptedException

SQLException

unlock

public void unlock(DBMLock lock)
            throws SQLException

Throws:

SQLException

forceUnlock

public void forceUnlock(String id)
                 throws SQLException

Throws:

SQLException