This is useful for non-embedded databases whose SQL dialect does not support an - * {@code IF EXISTS} clause in a {@code DROP} statement. + *
This is useful for a non-embedded database whose SQL dialect does not + * support an {@code IF EXISTS} clause in a {@code DROP} statement. *
The default is {@code false} so that if the populator runs accidentally, it will - * fail fast if the script starts with a {@code DROP} statement. + * fail fast if a script starts with a {@code DROP} statement. * @param ignoreFailedDrops {@code true} if failed drop statements should be ignored */ public void setIgnoreFailedDrops(boolean ignoreFailedDrops) { @@ -219,7 +220,8 @@ public class ResourceDatabasePopulator implements DatabasePopulator { } /** - * Execute this {@code DatabasePopulator} against the given {@link DataSource}. + * Execute this {@code ResourceDatabasePopulator} against the given + * {@link DataSource}. *
Delegates to {@link DatabasePopulatorUtils#execute}. * @param dataSource the {@code DataSource} to execute against * @throws ScriptException if an error occurs @@ -231,8 +233,10 @@ public class ResourceDatabasePopulator implements DatabasePopulator { } /** - * {@link EncodedResource} is not a sub-type of {@link Resource}. Thus we always need - * to wrap each script resource in an encoded resource. + * {@link EncodedResource} is not a sub-type of {@link Resource}. Thus we + * always need to wrap each script resource in an {@code EncodedResource} + * using the configured {@linkplain #setSqlScriptEncoding encoding}. + * @param script the script to wrap */ private EncodedResource encodeScript(Resource script) { return new EncodedResource(script, this.sqlScriptEncoding); diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/init/ScriptUtils.java b/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/init/ScriptUtils.java index 9f23e00979..aa86368949 100644 --- a/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/init/ScriptUtils.java +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/datasource/init/ScriptUtils.java @@ -50,19 +50,19 @@ public abstract class ScriptUtils { private static final Log logger = LogFactory.getLog(ScriptUtils.class); /** - * Default statement separator within SQL scripts. + * Default statement separator within SQL scripts: {@code ";"}. */ public static final String DEFAULT_STATEMENT_SEPARATOR = ";"; /** - * Fallback statement separator within SQL scripts. - *
Used if neither a custom defined separator nor the + * Fallback statement separator within SQL scripts: {@code "\n"}. + *
Used if neither a custom separator nor the * {@link #DEFAULT_STATEMENT_SEPARATOR} is present in a given script. */ public static final String FALLBACK_STATEMENT_SEPARATOR = "\n"; /** - * End of file (EOF) SQL statement separator. + * End of file (EOF) SQL statement separator: {@code "^^^ END OF SCRIPT ^^^"}. *
This value may be supplied as the {@code separator} to {@link
* #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String)}
* to denote that an SQL script contains a single statement (potentially
@@ -73,17 +73,17 @@ public abstract class ScriptUtils {
public static final String EOF_STATEMENT_SEPARATOR = "^^^ END OF SCRIPT ^^^";
/**
- * Default prefix for line comments within SQL scripts.
+ * Default prefix for single-line comments within SQL scripts: {@code "--"}.
*/
public static final String DEFAULT_COMMENT_PREFIX = "--";
/**
- * Default start delimiter for block comments within SQL scripts.
+ * Default start delimiter for block comments within SQL scripts: {@code "/*"}.
*/
public static final String DEFAULT_BLOCK_COMMENT_START_DELIMITER = "/*";
/**
- * Default end delimiter for block comments within SQL scripts.
+ * Default end delimiter for block comments within SQL scripts: "*/".
*/
public static final String DEFAULT_BLOCK_COMMENT_END_DELIMITER = "*/";
@@ -351,8 +351,8 @@ public abstract class ScriptUtils {
}
/**
- * Execute the given SQL script using default settings for separator separators,
- * comment delimiters, and exception handling flags.
+ * 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. *
Do not use this method to execute DDL if you expect rollback. @@ -362,8 +362,8 @@ public abstract class ScriptUtils { * current platform's default encoding * @throws ScriptException if an error occurred while executing the SQL script * @see #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String) - * @see #DEFAULT_COMMENT_PREFIX * @see #DEFAULT_STATEMENT_SEPARATOR + * @see #DEFAULT_COMMENT_PREFIX * @see #DEFAULT_BLOCK_COMMENT_START_DELIMITER * @see #DEFAULT_BLOCK_COMMENT_END_DELIMITER */ @@ -372,8 +372,8 @@ public abstract class ScriptUtils { } /** - * Execute the given SQL script using default settings for separator separators, - * comment delimiters, and exception handling flags. + * 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. *
Do not use this method to execute DDL if you expect rollback. @@ -383,8 +383,8 @@ public abstract class ScriptUtils { * to load the SQL script from * @throws ScriptException if an error occurred while executing the SQL script * @see #executeSqlScript(Connection, EncodedResource, boolean, boolean, String, String, String, String) - * @see #DEFAULT_COMMENT_PREFIX * @see #DEFAULT_STATEMENT_SEPARATOR + * @see #DEFAULT_COMMENT_PREFIX * @see #DEFAULT_BLOCK_COMMENT_START_DELIMITER * @see #DEFAULT_BLOCK_COMMENT_END_DELIMITER */ @@ -406,8 +406,8 @@ public abstract class ScriptUtils { * in the event of an error * @param ignoreFailedDrops whether or not to continue in the event of specifically * an error on a {@code DROP} statement - * @param commentPrefix the prefix that identifies comments in the SQL script — - * typically "--" + * @param commentPrefix the prefix that identifies single-line comments in the + * SQL script — typically "--" * @param separator the script statement separator; defaults to * {@value #DEFAULT_STATEMENT_SEPARATOR} if not specified and falls back to * {@value #FALLBACK_STATEMENT_SEPARATOR} as a last resort; may be set to