public abstract class ScriptUtils extends Object
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_BLOCK_COMMENT_END_DELIMITER
Default end delimiter for block comments within SQL scripts.
|
static String |
DEFAULT_BLOCK_COMMENT_START_DELIMITER
Default start delimiter for block comments within SQL scripts.
|
static String |
DEFAULT_COMMENT_PREFIX
Default prefix for line comments within SQL scripts.
|
static String |
DEFAULT_STATEMENT_SEPARATOR
Default statement separator within SQL scripts.
|
static String |
FALLBACK_STATEMENT_SEPARATOR
Fallback statement separator within SQL scripts.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
containsSqlScriptDelimiters(String script,
String delim)
Does the provided SQL script contain the specified delimiter?
|
static void |
executeSqlScript(Connection connection,
String scriptPath,
String script) |
static void |
executeSqlScript(Connection connection,
String scriptPath,
String script,
boolean continueOnError,
boolean ignoreFailedDrops,
String commentPrefix,
String separator,
String blockCommentStartDelimiter,
String blockCommentEndDelimiter)
Execute the given SQL script.
|
static void |
splitSqlScript(String resource,
String script,
String separator,
String commentPrefix,
String blockCommentStartDelimiter,
String blockCommentEndDelimiter,
List<String> statements)
Split an SQL script into separate statements delimited by the provided
separator string.
|
public static final String DEFAULT_STATEMENT_SEPARATOR
public static final String FALLBACK_STATEMENT_SEPARATOR
Used if neither a custom defined separator nor the
DEFAULT_STATEMENT_SEPARATOR
is present in a given script.
public static final String DEFAULT_COMMENT_PREFIX
public static final String DEFAULT_BLOCK_COMMENT_START_DELIMITER
public static final String DEFAULT_BLOCK_COMMENT_END_DELIMITER
public static void splitSqlScript(String resource, String script, String separator, String commentPrefix, String blockCommentStartDelimiter, String blockCommentEndDelimiter, List<String> statements)
List
.
Within the script, the provided commentPrefix
will be honored:
any text beginning with the comment prefix and extending to the end of the
line will be omitted from the output. Similarly, the provided
blockCommentStartDelimiter
and blockCommentEndDelimiter
delimiters will be honored: any text enclosed in a block comment will be
omitted from the output. In addition, multiple adjacent whitespace characters
will be collapsed into a single space.
resource
- the resource from which the script was readscript
- the SQL script; never null
or emptyseparator
- text separating each statement — typically a ';' or
newline character; never null
commentPrefix
- the prefix that identifies SQL line comments —
typically "--"; never null
or emptyblockCommentStartDelimiter
- the start block comment delimiter;
never null
or emptyblockCommentEndDelimiter
- the end block comment delimiter;
never null
or emptystatements
- the list that will contain the individual statementspublic static boolean containsSqlScriptDelimiters(String script, String delim)
script
- the SQL scriptdelim
- String delimiting each statement - typically a ';' characterpublic static void executeSqlScript(Connection connection, String scriptPath, String script) throws ScriptException
ScriptException
public static void executeSqlScript(Connection connection, String scriptPath, String script, boolean continueOnError, boolean ignoreFailedDrops, String commentPrefix, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) throws ScriptException
Statement separators and comments will be removed before executing individual statements within the supplied script.
Do not use this method to execute DDL if you expect rollback.
connection
- the JDBC connection to use to execute the script; already
configured and ready to usescriptPath
- the resource (potentially associated with a specific encoding)
to load the SQL script fromscript
- the raw script contentcontinueOnError
- whether or not to continue without throwing an exception
in the event of an errorignoreFailedDrops
- whether or not to continue in the event of specifically
an error on a DROP
statementcommentPrefix
- the prefix that identifies comments in the SQL script —
typically "--"separator
- the script statement separator; defaults to
";" if not specified and falls back to
"\n" as a last resortblockCommentStartDelimiter
- the start block comment delimiter; never
null
or emptyblockCommentEndDelimiter
- the end block comment delimiter; never
null
or empty @throws ScriptException if an error occurred while executing the SQL scriptScriptException
Copyright © 2016. All rights reserved.