org.sakaiproject.warehouse.util.db

Class DbLoader

java.lang.Object

org.sakaiproject.warehouse.util.db.DbLoader

public class DbLoader
extends Object

A tool to set up a OSPI database. This tool was created so that OSPI developers would only have to maintain a single set of xml documents to define the OSPI database schema and data. Previously it was necessary to maintain different scripts for each database we wanted to support.

DbLoader reads the generic types that are specified in tables.xml and tries to map them to local types by querying the database metadata via methods implemented by the JDBC driver. Fallback mappings can be supplied in dbloader.xml for cases where the JDBC driver is not able to determine the appropriate mapping. Such cases will be reported to standard out.

An xsl transformation is used to produce the DROP TABLE and CREATE TABLE SQL statements. These statements can be altered by modifying tables.xsl

all table names should have lower case names

Generic data types (as defined in java.sql.Types) which may be specified in tables.xml include: BIT, TINYINT, SMALLINT, INTEGER, BIGINT, FLOAT, REAL, DOUBLE, NUMERIC, DECIMAL, CHAR, VARCHAR, LONGVARCHAR, DATE, TIME, TIMESTAMP, BINARY, VARBINARY, LONGVARBINARY, NULL, OTHER, JAVA_OBJECT, DISTINCT, STRUCT, ARRAY, BLOB, CLOB, REF

WARNING: YOU MAY WANT TO MAKE A BACKUP OF YOUR DATABASE BEFORE RUNNING DbLoader

DbLoader will perform the following steps:

1. Read configurable properties from dbloader.xml
2. Get database connection from DbService
3. Read tables.xml and issue corresponding DROP TABLE and CREATE TABLE SQL statements.
4. Read data.xml and issue corresponding INSERT/UPDATE/DELETE SQL statements.

Version:

$Revision: 105080 $

Author:

Ken Weiner, kweiner@interactivebusiness.com, modified and adapted to OSPI by Luis F.C. Mendes - University of Delaware

See Also:

Types

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	logger

Constructor Summary

Constructors

Constructor and Description
DbLoader(Connection con)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	alterTable(String alterTableStatement)
protected void	createTable(String createTableStatement)
protected void	dropTable(String dropTableStatement)
Connection	getCon()
String	getDbName()
String	getDbVersion()
String	getDriverName()
String	getDriverVersion()
protected Element	getFirstChildWithName(Element parent, String name)
protected int	getJavaSqlDataTypeOfColumn(Document tablesDocGeneric, String tableName, String columnName)
protected int	getJavaSqlType(String genericDataTypeName)
protected String	getLocalDataTypeName(String genericDataTypeName)
protected String	getNodeValue(Node node)
org.sakaiproject.warehouse.util.db.DbLoader.PropertiesHandler	getPropertiesHandler()
PreparedStatement	getPstmt()
Statement	getStmt()
Hashtable	getTableColumnTypes()
PrintWriter	getTableScriptOut()
Document	getTablesDoc()
Document	getTablesDocGeneric()
protected Element	getTableWithName(Document tablesDoc, String tableName)
protected XMLReader	getXMLReader()
protected void	indexTable(String indexTableStatement)
protected void	initTableScript()
boolean	isAlterTables()
boolean	isCreateTables()
boolean	isCreateTableScript()
boolean	isDropTables()
boolean	isIndexTables()
boolean	isPopulateTables()
protected void	printInfo()
protected void	readProperties(XMLReader parser, InputStream properties)
protected void	replaceDataTypes(Document tablesDoc)
void	runLoader(InputStream tables)
void	setAlterTables(boolean alterTables)
void	setCon(Connection con)
void	setCreateTables(boolean createTables)
void	setCreateTableScript(boolean createTableScript)
void	setDbName(String dbName)
void	setDbVersion(String dbVersion)
void	setDriverName(String driverName)
void	setDriverVersion(String driverVersion)
void	setDropTables(boolean dropTables)
void	setIndexTables(boolean indexTables)
void	setPopulateTables(boolean populateTables)
void	setPropertiesHandler(org.sakaiproject.warehouse.util.db.DbLoader.PropertiesHandler propertiesHandler)
void	setPstmt(PreparedStatement pstmt)
void	setStmt(Statement stmt)
void	setTableColumnTypes(Hashtable tableColumnTypes)
void	setTableScriptOut(PrintWriter tableScriptOut)
void	setTablesDoc(Document tablesDoc)
void	setTablesDocGeneric(Document tablesDocGeneric)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

DbLoader

public DbLoader(Connection con)

Method Detail

runLoader

public void runLoader(InputStream tables)

getXMLReader

protected XMLReader getXMLReader()
                          throws SAXException,
                                 ParserConfigurationException

Throws:

SAXException

ParserConfigurationException

printInfo

protected void printInfo()
                  throws SQLException

Throws:

SQLException

initTableScript

protected void initTableScript()
                        throws IOException

Throws:

IOException

replaceDataTypes

protected void replaceDataTypes(Document tablesDoc)

getJavaSqlDataTypeOfColumn

protected int getJavaSqlDataTypeOfColumn(Document tablesDocGeneric,
                             String tableName,
                             String columnName)

getFirstChildWithName

protected Element getFirstChildWithName(Element parent,
                            String name)

getTableWithName

protected Element getTableWithName(Document tablesDoc,
                       String tableName)

getNodeValue

protected String getNodeValue(Node node)

getLocalDataTypeName

protected String getLocalDataTypeName(String genericDataTypeName)

getJavaSqlType

protected int getJavaSqlType(String genericDataTypeName)

dropTable

protected void dropTable(String dropTableStatement)

createTable

protected void createTable(String createTableStatement)

alterTable

protected void alterTable(String alterTableStatement)

indexTable

protected void indexTable(String indexTableStatement)

readProperties

protected void readProperties(XMLReader parser,
                  InputStream properties)
                       throws SAXException,
                              IOException

Throws:

SAXException

IOException

getCon

public Connection getCon()

setCon

public void setCon(Connection con)

getStmt

public Statement getStmt()

setStmt

public void setStmt(Statement stmt)

getPstmt

public PreparedStatement getPstmt()

setPstmt

public void setPstmt(PreparedStatement pstmt)

getTablesDoc

public Document getTablesDoc()

setTablesDoc

public void setTablesDoc(Document tablesDoc)

getTablesDocGeneric

public Document getTablesDocGeneric()

setTablesDocGeneric

public void setTablesDocGeneric(Document tablesDocGeneric)

isCreateTableScript

public boolean isCreateTableScript()

setCreateTableScript

public void setCreateTableScript(boolean createTableScript)

isPopulateTables

public boolean isPopulateTables()

setPopulateTables

public void setPopulateTables(boolean populateTables)

getTableScriptOut

public PrintWriter getTableScriptOut()

setTableScriptOut

public void setTableScriptOut(PrintWriter tableScriptOut)

isDropTables

public boolean isDropTables()

setDropTables

public void setDropTables(boolean dropTables)

isCreateTables

public boolean isCreateTables()

setCreateTables

public void setCreateTables(boolean createTables)

getDbName

public String getDbName()

setDbName

public void setDbName(String dbName)

getDbVersion

public String getDbVersion()

setDbVersion

public void setDbVersion(String dbVersion)

getDriverName

public String getDriverName()

setDriverName

public void setDriverName(String driverName)

getDriverVersion

public String getDriverVersion()

setDriverVersion

public void setDriverVersion(String driverVersion)

isAlterTables

public boolean isAlterTables()

setAlterTables

public void setAlterTables(boolean alterTables)

isIndexTables

public boolean isIndexTables()

setIndexTables

public void setIndexTables(boolean indexTables)

getTableColumnTypes

public Hashtable getTableColumnTypes()

setTableColumnTypes

public void setTableColumnTypes(Hashtable tableColumnTypes)

getPropertiesHandler

public org.sakaiproject.warehouse.util.db.DbLoader.PropertiesHandler getPropertiesHandler()

setPropertiesHandler

public void setPropertiesHandler(org.sakaiproject.warehouse.util.db.DbLoader.PropertiesHandler propertiesHandler)