Spring JDBC 6.1.4 · org.springframework.jdbc.datasource.init.ScriptUtils

Modifier and Type	Field and Description
public static final String	DEFAULT_BLOCK_COMMENT_END_DELIMITER Default end delimiter for block comments within SQL scripts: `"*/"`.
public static final String	DEFAULT_BLOCK_COMMENT_START_DELIMITER Default start delimiter for block comments within SQL scripts: `"/*"`.
public static final String	DEFAULT_COMMENT_PREFIX Default prefix for single-line comments within SQL scripts: `"--"`.
public static final String[]	DEFAULT_COMMENT_PREFIXES Default prefixes for single-line comments within SQL scripts: `["--"]`.
public static final String	DEFAULT_STATEMENT_SEPARATOR Default statement separator within SQL scripts: `";"`.
public static final String	EOF_STATEMENT_SEPARATOR End of file (EOF) SQL statement separator: `"^^^ END OF SCRIPT ^^^"`.
public static final String	FALLBACK_STATEMENT_SEPARATOR Fallback statement separator within SQL scripts: `"\n"`.
private static final Log	logger

Access	Constructor and Description
public	ScriptUtils()

Method Summary

Modifier and Type	Method and Description
private static void	appendSeparatorToScriptIfNecessary(StringBuilder scriptBuilder, String separator)
pack-priv static boolean	containsStatementSeparator(EncodedResource the resource from which the script was read, or `null` if unknown resource, String the SQL script to search within script, String the statement separator to search for separator, String[] the prefixes that identify single-line comments (typically `"--"`) commentPrefixes, String the start block comment delimiter (typically `"/"`) blockCommentStartDelimiter, String the end* block comment delimiter (typically `"*/"`) blockCommentEndDelimiter) Determine if the provided SQL script contains the specified statement separator.
public static void	executeSqlScript(Connection the JDBC connection to use to execute the script; already configured and ready to use connection, Resource the resource to load the SQL script from; encoded with the current platform's default encoding resource) Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags.
public static void	executeSqlScript(Connection the JDBC connection to use to execute the script; already configured and ready to use connection, EncodedResource the resource (potentially associated with a specific encoding) to load the SQL script from resource) Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags.
public static void	executeSqlScript(Connection the JDBC connection to use to execute the script; already configured and ready to use connection, EncodedResource the resource (potentially associated with a specific encoding) to load the SQL script from resource, boolean whether to continue without throwing an exception in the event of an error continueOnError, boolean whether to continue in the event of specifically an error on a `DROP` statement ignoreFailedDrops, String the prefix that identifies single-line comments in the SQL script (typically "--") commentPrefix, String the script statement separator; defaults to ; if not specified and falls back to as a last resort; may be set to ^^^ END OF SCRIPT ^^^ to signal that the script contains a single statement without a separator separator, String the start block comment delimiter blockCommentStartDelimiter, String the end block comment delimiter blockCommentEndDelimiter) Execute the given SQL script.
public static void	executeSqlScript(Connection the JDBC connection to use to execute the script; already configured and ready to use connection, EncodedResource the resource (potentially associated with a specific encoding) to load the SQL script from resource, boolean whether to continue without throwing an exception in the event of an error continueOnError, boolean whether to continue in the event of specifically an error on a `DROP` statement ignoreFailedDrops, String[] the prefixes that identify single-line comments in the SQL script (typically "--") commentPrefixes, String the script statement separator; defaults to ; if not specified and falls back to as a last resort; may be set to ^^^ END OF SCRIPT ^^^ to signal that the script contains a single statement without a separator separator, String the start block comment delimiter blockCommentStartDelimiter, String the end block comment delimiter blockCommentEndDelimiter) Execute the given SQL script.
pack-priv static String	Returns: a `String` containing the script lines readScript(EncodedResource the `EncodedResource` containing the script to be processed resource, String the statement separator in the SQL script (typically ";") separator, String[] the prefixes that identify comments in the SQL script (typically "--") commentPrefixes, String the end block comment delimiter blockCommentEndDelimiter) Read a script from the provided resource, using the supplied comment prefixes and statement separator, and build a `String` containing the lines.
private static String	readScript(LineNumberReader lineNumberReader, String[] commentPrefixes, String separator, String blockCommentEndDelimiter)
pack-priv static void	splitSqlScript(EncodedResource the resource from which the script was read resource, String the SQL script script, String text separating each statement (typically a ';' or newline character) separator, String[] the prefixes that identify SQL line comments (typically "--") commentPrefixes, String the start block comment delimiter; never `null` or empty blockCommentStartDelimiter, String the end block comment delimiter; never `null` or empty blockCommentEndDelimiter, List<String> the list that will contain the individual statements statements) Split an SQL script into separate statements delimited by the provided separator string.
private static boolean	startsWithAny(String script, String[] prefixes, int offset)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_BLOCK_COMMENT_END_DELIMITER	back to summary
public static final String DEFAULT_BLOCK_COMMENT_END_DELIMITER Default end delimiter for block comments within SQL scripts: `"*/"`.

DEFAULT_BLOCK_COMMENT_START_DELIMITER	back to summary
public static final String DEFAULT_BLOCK_COMMENT_START_DELIMITER Default start delimiter for block comments within SQL scripts: `"/*"`.

DEFAULT_COMMENT_PREFIX	back to summary
public static final String DEFAULT_COMMENT_PREFIX Default prefix for single-line comments within SQL scripts: `"--"`.

DEFAULT_COMMENT_PREFIXES	back to summary
public static final String[] DEFAULT_COMMENT_PREFIXES Default prefixes for single-line comments within SQL scripts: `["--"]`. Since 5.2

DEFAULT_STATEMENT_SEPARATOR	back to summary
public static final String DEFAULT_STATEMENT_SEPARATOR Default statement separator within SQL scripts: `";"`.

EOF_STATEMENT_SEPARATOR	back to summary
public static final String EOF_STATEMENT_SEPARATOR End of file (EOF) SQL statement separator: `"^^^ END OF SCRIPT ^^^"`. This value may be supplied as the `separator` to `executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)` to denote that an SQL script contains a single statement (potentially spanning multiple lines) with no explicit statement separator. Note that such a script should not actually contain this value; it is merely a virtual statement separator.

FALLBACK_STATEMENT_SEPARATOR	back to summary
public static final String FALLBACK_STATEMENT_SEPARATOR Fallback statement separator within SQL scripts: `"\n"`. Used if neither a custom separator nor the `DEFAULT_STATEMENT_SEPARATOR` is present in a given script.

logger	back to summary
private static final Log logger

ScriptUtils	back to summary
public ScriptUtils()

Method Detail

appendSeparatorToScriptIfNecessary	back to summary
private static void appendSeparatorToScriptIfNecessary(StringBuilder scriptBuilder, String separator)

containsStatementSeparator back to summary

containsStatementSeparator	back to summary
pack-priv static boolean containsStatementSeparator(EncodedResource resource, String script, String separator, String[] commentPrefixes, String blockCommentStartDelimiter, String blockCommentEndDelimiter) throws ScriptException Determine if the provided SQL script contains the specified statement separator. This method is intended to be used to find the string separating each SQL statement — for example, a ';' character. Any occurrence of the separator within the script will be ignored if it is within a literal block of text enclosed in single quotes (`'`) or double quotes (`"`), if it is escaped with a backslash (`\`), or if it is within a single-line comment or block comment. Parameters resource:EncodedResource the resource from which the script was read, or `null` if unknown script:String the SQL script to search within separator:String the statement separator to search for commentPrefixes:String[] the prefixes that identify single-line comments (typically `"--"`) blockCommentStartDelimiter:String the start block comment delimiter (typically `"/"`) blockCommentEndDelimiter:String the end* block comment delimiter (typically `"*/"`) Since 5.2.16

pack-priv static boolean containsStatementSeparator(EncodedResource resource, String script, String separator, String[] commentPrefixes, String blockCommentStartDelimiter, String blockCommentEndDelimiter) throws ScriptException

Determine if the provided SQL script contains the specified statement separator.

This method is intended to be used to find the string separating each SQL statement — for example, a ';' character.

Any occurrence of the separator within the script will be ignored if it is within a literal block of text enclosed in single quotes (') or double quotes ("), if it is escaped with a backslash (\), or if it is within a single-line comment or block comment.

Parameters

resource:EncodedResource: the resource from which the script was read, or null if unknown
script:String: the SQL script to search within
separator:String: the statement separator to search for
commentPrefixes:String[]: the prefixes that identify single-line comments (typically "--")
blockCommentStartDelimiter:String: the start block comment delimiter (typically "/*")
blockCommentEndDelimiter:String: the end block comment delimiter (typically "*/")

Since

5.2.16

executeSqlScript back to summary

executeSqlScript	back to summary
public static void executeSqlScript(Connection connection, Resource resource) throws ScriptException Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags. Statement separators and comments will be removed before executing individual statements within the supplied script. Warning this method does not release the provided `Connection`. Parameters connection:Connection the JDBC connection to use to execute the script; already configured and ready to use resource:Resource the resource to load the SQL script from; encoded with the current platform's default encoding Exceptions ScriptException: if an error occurred while executing the SQL script See Also `executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)`, `DEFAULT_STATEMENT_SEPARATOR`, `DEFAULT_COMMENT_PREFIX`, `DEFAULT_BLOCK_COMMENT_START_DELIMITER`, `DEFAULT_BLOCK_COMMENT_END_DELIMITER`, `org.springframework.jdbc.datasource.DataSourceUtils#getConnection`, `org.springframework.jdbc.datasource.DataSourceUtils#releaseConnection`

public static void executeSqlScript(Connection connection, Resource resource) throws ScriptException

Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags.

Statement separators and comments will be removed before executing individual statements within the supplied script.

Warning

this method does not release the provided Connection.

Parameters

connection:Connection: the JDBC connection to use to execute the script; already configured and ready to use
resource:Resource: the resource to load the SQL script from; encoded with the current platform's default encoding

Exceptions

ScriptException:: if an error occurred while executing the SQL script

executeSqlScript back to summary

executeSqlScript	back to summary
public static void executeSqlScript(Connection connection, EncodedResource resource) throws ScriptException Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags. Statement separators and comments will be removed before executing individual statements within the supplied script. Warning this method does not release the provided `Connection`. Parameters connection:Connection the JDBC connection to use to execute the script; already configured and ready to use resource:EncodedResource the resource (potentially associated with a specific encoding) to load the SQL script from Exceptions ScriptException: if an error occurred while executing the SQL script See Also `executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)`, `DEFAULT_STATEMENT_SEPARATOR`, `DEFAULT_COMMENT_PREFIX`, `DEFAULT_BLOCK_COMMENT_START_DELIMITER`, `DEFAULT_BLOCK_COMMENT_END_DELIMITER`, `org.springframework.jdbc.datasource.DataSourceUtils#getConnection`, `org.springframework.jdbc.datasource.DataSourceUtils#releaseConnection`

public static void executeSqlScript(Connection connection, EncodedResource resource) throws ScriptException

Execute the given SQL script using default settings for statement separators, comment delimiters, and exception handling flags.

Statement separators and comments will be removed before executing individual statements within the supplied script.

Warning

this method does not release the provided Connection.

Parameters

connection:Connection: the JDBC connection to use to execute the script; already configured and ready to use
resource:EncodedResource: the resource (potentially associated with a specific encoding) to load the SQL script from

Exceptions

ScriptException:: if an error occurred while executing the SQL script

See Also

executeSqlScript back to summary

executeSqlScript	back to summary
public static void executeSqlScript(Connection connection, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, String commentPrefix, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) throws ScriptException Execute the given SQL script. Statement separators and comments will be removed before executing individual statements within the supplied script. Warning this method does not release the provided `Connection`. Parameters connection:Connection the JDBC connection to use to execute the script; already configured and ready to use resource:EncodedResource the resource (potentially associated with a specific encoding) to load the SQL script from continueOnError:boolean whether to continue without throwing an exception in the event of an error ignoreFailedDrops:boolean whether to continue in the event of specifically an error on a `DROP` statement commentPrefix:String the prefix that identifies single-line comments in the SQL script (typically "--") separator:String the script statement separator; defaults to ; if not specified and falls back to as a last resort; may be set to ^^^ END OF SCRIPT ^^^ to signal that the script contains a single statement without a separator blockCommentStartDelimiter:String the start block comment delimiter blockCommentEndDelimiter:String the end block comment delimiter Exceptions ScriptException: if an error occurred while executing the SQL script See Also `DEFAULT_STATEMENT_SEPARATOR`, `FALLBACK_STATEMENT_SEPARATOR`, `EOF_STATEMENT_SEPARATOR`, `org.springframework.jdbc.datasource.DataSourceUtils#getConnection`, `org.springframework.jdbc.datasource.DataSourceUtils#releaseConnection`

public static void executeSqlScript(Connection connection, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, String commentPrefix, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) throws ScriptException

Execute the given SQL script.

Statement separators and comments will be removed before executing individual statements within the supplied script.

Warning

this method does not release the provided Connection.

Parameters

connection:Connection: the JDBC connection to use to execute the script; already configured and ready to use
resource:EncodedResource: the resource (potentially associated with a specific encoding) to load the SQL script from
continueOnError:boolean: whether to continue without throwing an exception in the event of an error
ignoreFailedDrops:boolean: whether to continue in the event of specifically an error on a DROP statement
commentPrefix:String: the prefix that identifies single-line comments in the SQL script (typically "--")
separator:String: the script statement separator; defaults to ; if not specified and falls back to as a last resort; may be set to ^^^ END OF SCRIPT ^^^ to signal that the script contains a single statement without a separator
blockCommentStartDelimiter:String: the start block comment delimiter
blockCommentEndDelimiter:String: the end block comment delimiter

Exceptions

ScriptException:: if an error occurred while executing the SQL script

executeSqlScript back to summary

executeSqlScript	back to summary
public static void executeSqlScript(Connection connection, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, String[] commentPrefixes, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) throws ScriptException Execute the given SQL script. Statement separators and comments will be removed before executing individual statements within the supplied script. Warning this method does not release the provided `Connection`. Parameters connection:Connection the JDBC connection to use to execute the script; already configured and ready to use resource:EncodedResource the resource (potentially associated with a specific encoding) to load the SQL script from continueOnError:boolean whether to continue without throwing an exception in the event of an error ignoreFailedDrops:boolean whether to continue in the event of specifically an error on a `DROP` statement commentPrefixes:String[] the prefixes that identify single-line comments in the SQL script (typically "--") separator:String the script statement separator; defaults to ; if not specified and falls back to as a last resort; may be set to ^^^ END OF SCRIPT ^^^ to signal that the script contains a single statement without a separator blockCommentStartDelimiter:String the start block comment delimiter blockCommentEndDelimiter:String the end block comment delimiter Exceptions ScriptException: if an error occurred while executing the SQL script Since 5.2 See Also `DEFAULT_STATEMENT_SEPARATOR`, `FALLBACK_STATEMENT_SEPARATOR`, `EOF_STATEMENT_SEPARATOR`, `org.springframework.jdbc.datasource.DataSourceUtils#getConnection`, `org.springframework.jdbc.datasource.DataSourceUtils#releaseConnection`

public static void executeSqlScript(Connection connection, EncodedResource resource, boolean continueOnError, boolean ignoreFailedDrops, String[] commentPrefixes, String separator, String blockCommentStartDelimiter, String blockCommentEndDelimiter) throws ScriptException

Execute the given SQL script.

Statement separators and comments will be removed before executing individual statements within the supplied script.

Warning

this method does not release the provided Connection.

Parameters

connection:Connection: the JDBC connection to use to execute the script; already configured and ready to use
resource:EncodedResource: the resource (potentially associated with a specific encoding) to load the SQL script from
continueOnError:boolean: whether to continue without throwing an exception in the event of an error
ignoreFailedDrops:boolean: whether to continue in the event of specifically an error on a DROP statement
commentPrefixes:String[]: the prefixes that identify single-line comments in the SQL script (typically "--")
separator:String: the script statement separator; defaults to ; if not specified and falls back to as a last resort; may be set to ^^^ END OF SCRIPT ^^^ to signal that the script contains a single statement without a separator
blockCommentStartDelimiter:String: the start block comment delimiter
blockCommentEndDelimiter:String: the end block comment delimiter

Exceptions

ScriptException:: if an error occurred while executing the SQL script

Since

5.2

See Also

readScript back to summary

readScript	back to summary
pack-priv static String readScript(EncodedResource resource, String separator, String[] commentPrefixes, String blockCommentEndDelimiter) throws IOException Read a script from the provided resource, using the supplied comment prefixes and statement separator, and build a `String` containing the lines. Lines beginning with one of the comment prefixes are excluded from the results; however, line comments anywhere else — for example, within a statement — will be included in the results. Parameters resource:EncodedResource the `EncodedResource` containing the script to be processed separator:String the statement separator in the SQL script (typically ";") commentPrefixes:String[] the prefixes that identify comments in the SQL script (typically "--") blockCommentEndDelimiter:String the end block comment delimiter Returns:String a `String` containing the script lines Exceptions IOException: in case of I/O errors

pack-priv static String readScript(EncodedResource resource, String separator, String[] commentPrefixes, String blockCommentEndDelimiter) throws IOException

Read a script from the provided resource, using the supplied comment prefixes and statement separator, and build a String containing the lines.

Lines beginning with one of the comment prefixes are excluded from the results; however, line comments anywhere else — for example, within a statement — will be included in the results.

Parameters

resource:EncodedResource: the EncodedResource containing the script to be processed
separator:String: the statement separator in the SQL script (typically ";")
commentPrefixes:String[]: the prefixes that identify comments in the SQL script (typically "--")
blockCommentEndDelimiter:String: the end block comment delimiter

Returns:String

a String containing the script lines

Exceptions

IOException:: in case of I/O errors

readScript	back to summary
private static String readScript(LineNumberReader lineNumberReader, String[] commentPrefixes, String separator, String blockCommentEndDelimiter) throws IOException

splitSqlScript back to summary

splitSqlScript	back to summary
pack-priv static void splitSqlScript(EncodedResource resource, String script, String separator, String[] commentPrefixes, String blockCommentStartDelimiter, String blockCommentEndDelimiter, List<String> statements) throws ScriptException Split an SQL script into separate statements delimited by the provided separator string. Each individual statement will be added to the provided `List`. Within the script, the provided `commentPrefixes` will be honored: any text beginning with one of the comment prefixes 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. Parameters resource:EncodedResource the resource from which the script was read script:String the SQL script separator:String text separating each statement (typically a ';' or newline character) commentPrefixes:String[] the prefixes that identify SQL line comments (typically "--") blockCommentStartDelimiter:String the start block comment delimiter; never `null` or empty blockCommentEndDelimiter:String the end block comment delimiter; never `null` or empty statements:List<String> the list that will contain the individual statements Exceptions ScriptException: if an error occurred while splitting the SQL script Since 5.2

pack-priv static void splitSqlScript(EncodedResource resource, String script, String separator, String[] commentPrefixes, String blockCommentStartDelimiter, String blockCommentEndDelimiter, List<String> statements) throws ScriptException

Split an SQL script into separate statements delimited by the provided separator string. Each individual statement will be added to the provided List.

Within the script, the provided commentPrefixes will be honored: any text beginning with one of the comment prefixes 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.

Parameters

resource:EncodedResource: the resource from which the script was read
script:String: the SQL script
separator:String: text separating each statement (typically a ';' or newline character)
commentPrefixes:String[]: the prefixes that identify SQL line comments (typically "--")
blockCommentStartDelimiter:String: the start block comment delimiter; never null or empty
blockCommentEndDelimiter:String: the end block comment delimiter; never null or empty
statements:List<String>: the list that will contain the individual statements

Exceptions

ScriptException:: if an error occurred while splitting the SQL script

Since

5.2

startsWithAny	back to summary
private static boolean startsWithAny(String script, String[] prefixes, int offset)

public abstract Class ScriptUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail