org.rhq.core.db.setup

Class DBSetup

java.lang.Object

org.rhq.core.db.setup.DBSetup

public class DBSetup
extends Object

Performs XML parsing of the database schema and data files and sets up the database accordingly. This has the ability to not only set up the database, but also to purge the database of the schemas and data.

Constructor Summary

Constructors

Constructor and Description
DBSetup(Connection connection) Creates a new instance with an already established connection.
DBSetup(String jdbc_url, String username, String password) Creates a new DBSetup object where this object is not in console mode (meaning messages will not be emitted to the console).
DBSetup(String jdbc_url, String username, String password, boolean consoleMode) Creates a new DBSetup object where this object is in console mode (meaning messages will be emitted to the console).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clear(String file_name) Purges the entire schema of all existing data.
boolean	clear(String file_name, String table_name) Purges data from the schema.
protected void	doSQL(String sql) Executes the given SQL.
protected Statement	doSQL(String sql, boolean returnPreparedStatement) This method either executes the given SQL (if returnPreparedStatement is false) or it just prepares it in a statement and expects the caller to execute the statement.
void	export(String file) Exports an existing schema to a DBSetup XML file.
protected Connection	getConnection() Gets the live connection that this object is using.
protected DatabaseType	getDatabaseType() Gets the database type information of the database this object is currently connected to.
protected String	getJdbcUser() Returns the username that this object will use when connecting to the database.
static void	main(String[] args) A console application that can be used to run the DBSetup from a command line.
void	setup(String file_name) Performs the full database setup.
void	setup(String file_name, String table_name, boolean data_only, boolean do_delete) Performs the actual database setup.
boolean	uninstall(String file_name) This is the reverse of setup - that is, it removes a schema from a database, deleting all data with it.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBSetup

public DBSetup(String jdbc_url,
       String username,
       String password)

Creates a new DBSetup object where this object is not in console mode (meaning messages will not be emitted to the console).

Parameters:

jdbc_url - the JDBC URL used to connect to the database

username - the user that will be logged into the database

password - user's credentials

DBSetup

public DBSetup(String jdbc_url,
       String username,
       String password,
       boolean consoleMode)

Creates a new DBSetup object where this object is in console mode (meaning messages will be emitted to the console).

Parameters:

jdbc_url - the JDBC URL used to connect to the database

username - the user that will be logged into the database

password - user's credentials

consoleMode - indicates if messages should be emitted to the console

DBSetup

public DBSetup(Connection connection)
        throws Exception

Creates a new instance with an already established connection.

Parameters:

connection -

Throws:

Exception

Method Detail

main

public static void main(String[] args)

A console application that can be used to run the DBSetup from a command line. The arguments are as follows:

 DBSetup -op=setup|clear|uninstall|uninstallsetup
         -jdbcurl=<db-url> [-jdbcuser=<username>] [-jdbcpassword=<password>]
         -file=<dbsetup-xml-file>
 

where:

• -op: Defines what operation to perform:
  • export: exports an existing database schema and its data to an XML file
  • setup: creates the new database schema and inserts all data
  • clear: deletes all data from the schema but leaves the schema in the database
  • uninstall: deletes all data and the schema itself from the database
  • uninstallsetup: performs an uninstall first, and then a setup
• -jdbcurl: JDBC URL used to connect to the database
• -jdbcuser: username that is used to connect to the database
• -jdbcpassword: credentials of the user
• -file=<dbsetup-xml-file>: specifies the path to the DBSetup XML file that is read or exported to

Parameters:

args - see description

setup

public void setup(String file_name)
           throws Exception

Performs the full database setup.

Parameters:

file_name - the path to the database setup XML file

Throws:

Exception

See Also:

setup(String, String, boolean, boolean)

setup

public void setup(String file_name,
         String table_name,
         boolean data_only,
         boolean do_delete)
           throws Exception

Performs the actual database setup. This will read the source XML file and will perform the necessary SQL to create the schema and insert the data.

Parameters:

file_name - the file that contains the DBSetup XML content.

table_name - if not null, only this table will be setup

data_only - if true does not create the schema; only inserts data into an existing schema

do_delete - if true, and table_name was specified, this will delete all rows from that table before inserting the new data. The table must exist. It only makes sense to use this with data_only set to true.

Throws:

Exception

clear

public boolean clear(String file_name)
              throws Exception

Purges the entire schema of all existing data. The schema (tables, views, etc) are left intact.

Parameters:

file_name - the path to the database setup XML file

Returns:

true if all data was successfully deleted; false if at least one failure occurred when trying remove data from the tables

Throws:

Exception

See Also:

clear(String, String), uninstall(String)

clear

public boolean clear(String file_name,
            String table_name)
              throws Exception

Purges data from the schema. If table is not null, only that table will be cleared of data; the remaining tables will have their data remain as-is.

Parameters:

file_name - the path to the database setup XML file

table_name - the table to clear, if null, then all tables are cleared

Returns:

true if all data was successfully deleted; false if at least one failure occurred when trying remove data from the tables

Throws:

Exception

See Also:

uninstall(String)

uninstall

public boolean uninstall(String file_name)
                  throws Exception

This is the reverse of setup - that is, it removes a schema from a database, deleting all data with it.

Parameters:

file_name - the file that contains the DBSetup XML content.

Returns:

true if all views and tables were successfully removed; false if at least one failure occurred when trying remove views and tables

Throws:

Exception

export

public void export(String file)
            throws Exception

Exports an existing schema to a DBSetup XML file.

NOTE: you cannot use the generated XML file for input into DBSetup. This exported XML file is only for reference purposes; it is not generated in a way that can be used to recreate the DB. Use your database vendor's backup/restore utilities to export databases for backup and recovery.

Parameters:

file - the XML file that will contain the exported schema

Throws:

Exception

doSQL

protected void doSQL(String sql)
              throws SQLException

Executes the given SQL.

Parameters:

sql -

Throws:

SQLException

doSQL

protected Statement doSQL(String sql,
              boolean returnPreparedStatement)
                   throws SQLException

This method either executes the given SQL (if returnPreparedStatement is false) or it just prepares it in a statement and expects the caller to execute the statement. The caller must close the returned prepared statement (which occurs if returnPreparedStatement is true)

Parameters:

sql - an SQL Data Manipulation Language (DML) statement, such as INSERT, UPDATE or DELETE; or an SQL statement that returns nothing, such as a DDL statement

returnPreparedStatement - if true, the SQL isn't executed; it is just prepared

Returns:

the statement (which may be a prepared statement or may be the statement that was executed)

Throws:

SQLException

getConnection

protected Connection getConnection()

Gets the live connection that this object is using. If one hasn't been created yet, null is returned.

Returns:

live connection

getDatabaseType

protected DatabaseType getDatabaseType()

Gets the database type information of the database this object is currently connected to. If there is not a live connection to a database, null is returned.

Returns:

database type

getJdbcUser

protected String getJdbcUser()

Returns the username that this object will use when connecting to the database.

Returns:

username