org.h2.tools
Class RunScript

java.lang.Object
  org.h2.util.Tool
      org.h2.tools.RunScript

public class RunScript
extends Tool

Runs a SQL script against a database.

H2.resource:

Field Summary

Fields inherited from class org.h2.util.Tool

out

Constructor Summary

RunScript()

Method Summary

static java.sql.ResultSet	execute(java.sql.Connection conn, java.io.Reader reader) Executes the SQL commands in a script file against a database.
static void	execute(java.lang.String url, java.lang.String user, java.lang.String password, java.lang.String fileName, java.lang.String charsetName, boolean continueOnError) Executes the SQL commands in a script file against a database.
static void	main(java.lang.String... args) Options are case sensitive.
void	run(java.lang.String... args) Executes the contents of a SQL script file against a database.
void	setCheckResults(boolean check) If results of statements should be cross-checked with the expected output.
void	setShowResults(boolean show) If the statements as well as the results should be printed to the output.

Methods inherited from class org.h2.util.Tool

printNoDatabaseFilesFound, readArgBoolean, setOut, showUsage, throwUnsupportedOption

Methods inherited from class java.lang.Object

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

Constructor Detail

RunScript

public RunScript()

Method Detail

main

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

Options are case sensitive. Supported options are:

[-help] or [-?]	Print the list of options
[-url "<url>"]	The database URL (jdbc:...)
[-user <user>]	The user name (default: sa)
[-password <pwd>]	The password
[-script <file>]	The script file to run (default: backup.sql)
[-driver <class>]	The JDBC driver class to use (not required in most cases)
[-showResults]	Show the statements and the results of queries
[-checkResults]	Check if the query results match the expected results
[-options ...]	RUNSCRIPT options (embedded H2; -*Results not supported)

Parameters:

args - the command line arguments

Throws:

java.sql.SQLException

H2.resource:

run

public void run(java.lang.String... args)
         throws java.sql.SQLException

Executes the contents of a SQL script file against a database. This tool is usually used to create a database from script. It can also be used to analyze performance problems by running the tool using Java profiler settings such as:

 java -Xrunhprof:cpu=samples,depth=16 ...
 

To include local files when using remote databases, use the special syntax:

 @INCLUDE fileName
 

This syntax is only supported by this tool. Embedded RUNSCRIPT SQL statements will be executed by the database.

Specified by:

run in class Tool

Parameters:

args - the command line arguments

Throws:

java.sql.SQLException

execute

public static java.sql.ResultSet execute(java.sql.Connection conn,
                                         java.io.Reader reader)
                                  throws java.sql.SQLException

Executes the SQL commands in a script file against a database.

Parameters:

conn - the connection to a database

reader - the reader

Returns:

the last result set

Throws:

java.sql.SQLException

execute

public static void execute(java.lang.String url,
                           java.lang.String user,
                           java.lang.String password,
                           java.lang.String fileName,
                           java.lang.String charsetName,
                           boolean continueOnError)
                    throws java.sql.SQLException

Executes the SQL commands in a script file against a database.

Parameters:

url - the database URL

user - the user name

password - the password

fileName - the script file

charsetName - the character set name or null for UTF-8

continueOnError - if execution should be continued if an error occurs

Throws:

java.sql.SQLException

setShowResults

public void setShowResults(boolean show)

If the statements as well as the results should be printed to the output.

Parameters:

show - true if yes

setCheckResults

public void setCheckResults(boolean check)

If results of statements should be cross-checked with the expected output. The expected result is the next line(s) of the script, commented.

Parameters:

check - true if yes