com.serotonin.mango.db.upgrade

Class DBUpgrade

java.lang.Object

com.serotonin.db.DaoUtils

com.serotonin.mango.db.dao.BaseDao

com.serotonin.mango.db.upgrade.DBUpgrade

Direct Known Subclasses:

Upgrade1_12_4

public abstract class DBUpgrade
extends BaseDao

Base class for instances that perform database upgrades. The naming of subclasses follows the convention 'Upgrade[maj]_[min]_[mic]', where '[maj]_[min]_[mic]' is the version that the class upgrades from. The subclass must be in this package.

Author:

Matthew Lohbihler

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_DATABASE_TYPE
private static org.apache.commons.logging.Log	LOG

Fields inherited from class com.serotonin.db.DaoUtils

dataSource, ejt, tm

Constructor Summary

Constructors

Constructor and Description
DBUpgrade()

Method Summary

Modifier and Type	Method and Description
static void	checkUpgrade()
protected java.io.OutputStream	createUpdateLogOutputStream(java.lang.String version)
protected abstract java.lang.String	getNewSchemaVersion()
static boolean	isUpgradeNeeded(java.lang.String schemaVersion)
protected void	runScript(java.util.Map<java.lang.String,java.lang.String[]> scripts, java.io.OutputStream out)
protected void	runScript(java.lang.String[] script, java.io.OutputStream out) Convenience method for subclasses
protected abstract void	upgrade()

Methods inherited from class com.serotonin.mango.db.dao.BaseDao

boolToChar, charToBool, deleteInChunks, doInsert, doInsert, doInsert, doInsertLong, doInsertLong, doInsertLong, generateUniqueXid, getGeneratedKeyName, getPreparedStatementCreator, isXidUnique

Methods inherited from class com.serotonin.db.DaoUtils

batchUpdate, createDelimitedList, createDelimitedList, createDelimitedList, createIntValuePairs, createKeyValuePairs, dbEncodeSearchString, getInt, getTransactionManager, getTransactionTemplate, now, query, query, query, query, query, query, queryForList, queryForList, queryForObject, queryForObject, queryForObject, setInt

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

DEFAULT_DATABASE_TYPE

protected static final java.lang.String DEFAULT_DATABASE_TYPE

See Also:

Constant Field Values

Constructor Detail

DBUpgrade

public DBUpgrade()

Method Detail

checkUpgrade

public static void checkUpgrade()

upgrade

protected abstract void upgrade()
                         throws java.lang.Exception

Throws:

java.lang.Exception

getNewSchemaVersion

protected abstract java.lang.String getNewSchemaVersion()

runScript

protected void runScript(java.lang.String[] script,
                         java.io.OutputStream out)
                  throws java.lang.Exception

Convenience method for subclasses

Parameters:

script - the array of script lines to run

out - the stream to which to direct output from running the script

Throws:

java.lang.Exception - if something bad happens

runScript

protected void runScript(java.util.Map<java.lang.String,java.lang.String[]> scripts,
                         java.io.OutputStream out)
                  throws java.lang.Exception

Throws:

java.lang.Exception

createUpdateLogOutputStream

protected java.io.OutputStream createUpdateLogOutputStream(java.lang.String version)

isUpgradeNeeded

public static boolean isUpgradeNeeded(java.lang.String schemaVersion)