com.goldencode.p2j.persist.deploy

Class ScriptRunner

java.lang.Object

com.goldencode.p2j.persist.deploy.ScriptRunner

Direct Known Subclasses:

H2ScriptRunner, MariaDbScriptRunner, PostgreSQLScriptRunner

public abstract class ScriptRunner
extends java.lang.Object

Run SQL script against the database

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ScriptRunner.ScriptType Script type

Field Summary

Fields

Modifier and Type	Field and Description
protected Dialect	dialect The target database dialect
private static java.util.regex.Pattern	JDBC Pattern for the JDBC URL parsing
protected static CentralLogger	LOG Logger
protected java.util.Map<java.lang.String,java.lang.String>	placeholders Map for placeholder values
protected java.util.List<java.lang.String>	scripts Scripts to be run
protected ScriptRunner.ScriptType	scriptType Script type
protected boolean	usePlaceholders If placeholders should be used

Constructor Summary

Constructors

Constructor and Description
ScriptRunner(Dialect dialect) Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	addScriptPath(java.util.List<java.lang.String> scriptNames) Add script path to script names
protected void	applyDDLScripts(java.sql.Connection conn)
protected java.lang.String	applyPlaceholders(java.sql.Connection conn, java.lang.String source) Substitutes variables as placeholders within a SQL string by values.
protected void	applySchema(java.sql.Connection conn) Apply SQL scripts using connection
protected void	applyScripts(java.sql.Connection conn, ScriptSplitter splitter) Apply SQL scripts using connection
protected abstract void	applyUdfScripts(java.sql.Connection conn) Apply SQL scripts.
static void	createMissingUdfs(Database db) Check for missing UDFs and create them.
protected abstract void	createMissingUdfs(java.lang.String dbname, java.lang.String url, java.lang.String adm, java.lang.String pwd) Check for missing UDFs and create them.
protected java.util.List<java.lang.String>	defaultUdfScripts() Provide a list of default UDF scripts
protected void	execute(java.sql.Connection conn, java.lang.String sql) Execute an SQL statement.
static void	main(java.lang.String... args) Runner main method.
protected java.util.List<java.lang.String>	makeScripts(java.util.List<java.lang.String> scriptNames) Make full script files names from script names
protected void	parseCmdLine(java.lang.String[] args) Parse command line arguments.
private java.lang.String	readLine(java.io.Reader r) Read the next line from the source Reader.
private void	runScript(java.sql.Connection conn, java.io.Reader script) Run UDFs SQL script against the database.
private void	runScript(java.sql.Connection conn, java.io.Reader script, ScriptSplitter splitter) Run UDFs SQL script against the database.
boolean	supportsUdfScripts() Check if UDFs are created with script

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final CentralLogger LOG

Logger

JDBC

private static final java.util.regex.Pattern JDBC

Pattern for the JDBC URL parsing

placeholders

protected java.util.Map<java.lang.String,java.lang.String> placeholders

Map for placeholder values

usePlaceholders

protected boolean usePlaceholders

If placeholders should be used

dialect

protected final Dialect dialect

The target database dialect

scripts

protected java.util.List<java.lang.String> scripts

Scripts to be run

scriptType

protected ScriptRunner.ScriptType scriptType

Script type

Constructor Detail

ScriptRunner

public ScriptRunner(Dialect dialect)

Constructor.

Parameters:

dialect - the target database dialect

Method Detail

main

public static void main(java.lang.String... args)
                 throws java.lang.Exception

Runner main method.

Parameters:

args - Command line arguments, as follows: [<db url>, <user>, <password>, <command>].

Throws:

java.lang.Exception - On error.

parseCmdLine

protected void parseCmdLine(java.lang.String[] args)

Parse command line arguments.

Parameters:

args - command line arguments;

supportsUdfScripts

public boolean supportsUdfScripts()

Check if UDFs are created with script

Returns:

true if UDFs are created with script

defaultUdfScripts

protected java.util.List<java.lang.String> defaultUdfScripts()

Provide a list of default UDF scripts

Returns:

the list of default UDF scripts;

applyDDLScripts

protected void applyDDLScripts(java.sql.Connection conn)
                        throws java.sql.SQLException,
                               java.io.IOException

Throws:

java.sql.SQLException

java.io.IOException

applyPlaceholders

protected java.lang.String applyPlaceholders(java.sql.Connection conn,
                                             java.lang.String source)

Substitutes variables as placeholders within a SQL string by values.

Parameters:

conn - Database connection.

source - The SQL statement to be executed.

Returns:

The SQL statement with the placeholders substituted by values.

applyUdfScripts

protected abstract void applyUdfScripts(java.sql.Connection conn)
                                 throws java.sql.SQLException,
                                        java.io.IOException

Apply SQL scripts.

Parameters:

conn - Database connection.

Throws:

java.sql.SQLException - on SQL error.

java.io.IOException - on script reading error.

createMissingUdfs

protected abstract void createMissingUdfs(java.lang.String dbname,
                                          java.lang.String url,
                                          java.lang.String adm,
                                          java.lang.String pwd)
                                   throws java.sql.SQLException,
                                          PersistenceException

Check for missing UDFs and create them.

Parameters:

dbname - Database name.

url - Database JDBC URL.

adm - Admin login.

pwd - Admin password.

Throws:

java.sql.SQLException - on SQL error.

PersistenceException - on script reading error.

createMissingUdfs

public static void createMissingUdfs(Database db)
                              throws java.sql.SQLException,
                                     PersistenceException

Check for missing UDFs and create them.

Parameters:

db - Database.

Throws:

java.sql.SQLException - on SQL error.

PersistenceException - on script reading error.

addScriptPath

protected java.util.List<java.lang.String> addScriptPath(java.util.List<java.lang.String> scriptNames)

Add script path to script names

Parameters:

scriptNames - original script names

Returns:

list of full script names

makeScripts

protected java.util.List<java.lang.String> makeScripts(java.util.List<java.lang.String> scriptNames)

Make full script files names from script names

Parameters:

scriptNames - original script names

Returns:

list of full script names

applyScripts

protected void applyScripts(java.sql.Connection conn,
                            ScriptSplitter splitter)
                     throws java.io.IOException,
                            java.sql.SQLException

Apply SQL scripts using connection

Parameters:

conn - connection

splitter - script splitter

Throws:

java.io.IOException - on I/O error

java.sql.SQLException - on database error

applySchema

protected void applySchema(java.sql.Connection conn)
                    throws java.io.IOException,
                           java.sql.SQLException

Apply SQL scripts using connection

Parameters:

conn - connection

Throws:

java.io.IOException - on I/O error

java.sql.SQLException - on database error

runScript

private void runScript(java.sql.Connection conn,
                       java.io.Reader script,
                       ScriptSplitter splitter)
                throws java.io.IOException,
                       java.sql.SQLException

Run UDFs SQL script against the database.

Parameters:

conn - The database connection.

script - The reader for the script.

Throws:

java.io.IOException - In I/O error.

java.sql.SQLException - In database error.

runScript

private void runScript(java.sql.Connection conn,
                       java.io.Reader script)
                throws java.io.IOException,
                       java.sql.SQLException

Run UDFs SQL script against the database.

Parameters:

conn - The database connection.

script - The reader for the script.

Throws:

java.io.IOException - In I/O error.

java.sql.SQLException - In database error.

execute

protected void execute(java.sql.Connection conn,
                       java.lang.String sql)
                throws java.sql.SQLException

Execute an SQL statement.

Parameters:

conn - The database connection.

sql - The SQL statement to be executed.

Throws:

java.sql.SQLException - On error.

readLine

private java.lang.String readLine(java.io.Reader r)
                           throws java.io.IOException

Read the next line from the source Reader.

Parameters:

r - The reader for the source file.

Returns:

next line of null if EOF.

Throws:

java.io.IOException - In the event of an I/O error.