org.rhq.core.db.ant.dbupgrade

Class DBUpgrader

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.rhq.core.db.ant.dbupgrade.DBUpgrader

public class DBUpgrader
extends org.apache.tools.ant.Task

ANT task that performs database upgrades of an existing schema.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

Constructors

Constructor and Description
DBUpgrader()
DBUpgrader(Connection connection)

Method Summary

Methods

Modifier and Type	Method and Description
SchemaSpec	createSchemaSpec() Creates a new schema spec object.
void	execute()
Connection	getConnection() Gets a connection to the database as configured by this task's attributes.
DatabaseType	getDatabaseType() Returns the type of database that is being upgraded.
Collection<TypeMap>	getTypeMaps() Returns the collection of database type mappings.
void	setConnection(Connection connection) This can be used to programatically override the JDBC connection to be used by this task.
void	setJdbcPassword(String jdbcPassword) The database user's credentials used to log into the database.
void	setJdbcUrl(String jdbcUrl) The URL to the database that is to be upgraded.
void	setJdbcUser(String jdbcUser) Log into the database as this user.
void	setKeyColumn(String k) This is the name of the column in the table that identifies the row that has the schema version in it.
void	setKeyMatch(String m) This is the value of the key column that identifies the row whose value column is the schema version.
void	setTable(String t) The table name that contains the row where the schema version can be found.
void	setTargetSchemaVersion(String v) This is the schema version that the schema should be upgraded to.
void	setTypeMap(File f) A file that contains database type mappings.
void	setValueColumn(String v) The column in the table whose value is the schema version.
protected boolean	shouldExecSpecVersion(SchemaVersion version) Returns true if the given version's schema spec should be executed.

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

DBUpgrader

public DBUpgrader()

DBUpgrader

public DBUpgrader(Connection connection)

Method Detail

setJdbcUrl

public void setJdbcUrl(String jdbcUrl)

The URL to the database that is to be upgraded.

Parameters:

jdbcUrl -

setJdbcUser

public void setJdbcUser(String jdbcUser)

Log into the database as this user.

Parameters:

jdbcUser -

setJdbcPassword

public void setJdbcPassword(String jdbcPassword)

The database user's credentials used to log into the database.

Parameters:

jdbcPassword -

setValueColumn

public void setValueColumn(String v)

The column in the table whose value is the schema version. The value in this column tells you what version the schema is currently at.

Parameters:

v - value column name

setTable

public void setTable(String t)

The table name that contains the row where the schema version can be found. This table must have a value column whose value is the schema version and it must have a key column whose value matches setKeyMatch(String) (which simply identifies the row that contains the schema version value).

Parameters:

t - table name

setKeyColumn

public void setKeyColumn(String k)

This is the name of the column in the table that identifies the row that has the schema version in it. Finding the row where this key column's value is setKeyMatch(String) will get you the row whose value in the value column is the schema version.

Parameters:

k - key column name

setKeyMatch

public void setKeyMatch(String m)

This is the value of the key column that identifies the row whose value column is the schema version.

Parameters:

m - key value identifying the row that has the schema version

setTypeMap

public void setTypeMap(File f)

A file that contains database type mappings. This is rarely going to be used, since database type mappings never change (unless future databases add new types or change the semantics of their current types).

Parameters:

f - mapping file

setTargetSchemaVersion

public void setTargetSchemaVersion(String v)

This is the schema version that the schema should be upgraded to.

Parameters:

v - schema version

createSchemaSpec

public SchemaSpec createSchemaSpec()

Creates a new schema spec object.

Returns:

new schema spec

getTypeMaps

public Collection<TypeMap> getTypeMaps()

Returns the collection of database type mappings.

Returns:

collection of type mappings

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

See Also:

Task.execute()

shouldExecSpecVersion

protected boolean shouldExecSpecVersion(SchemaVersion version)

Returns true if the given version's schema spec should be executed.

Parameters:

version -

Returns:

true if this version is on the upgrade path

getConnection

public Connection getConnection()
                         throws SQLException

Gets a connection to the database as configured by this task's attributes.

Returns:

database connection

Throws:

SQLException

setConnection

public void setConnection(Connection connection)

This can be used to programatically override the JDBC connection to be used by this task.

Parameters:

connection -

getDatabaseType

public DatabaseType getDatabaseType()

Returns the type of database that is being upgraded.

Returns:

db type