注释类型 SqlConfig
@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited public @interface SqlConfig
@SqlConfig
defines metadata that is used to determine how to parse and execute SQL scripts configured via the@Sql
annotation.Configuration Scope
When declared as a class-level annotation on an integration test class,
@SqlConfig
serves as global configuration for all SQL scripts within the test class hierarchy. When declared directly via theconfig
attribute of the@Sql
annotation,@SqlConfig
serves as local configuration for the SQL scripts declared within the enclosing@Sql
annotation.Default Values
Every attribute in
@SqlConfig
has an implicit default value which is documented in the javadocs of the corresponding attribute. Due to the rules defined for annotation attributes in the Java Language Specification, it is unfortunately not possible to assign a value ofnull
to an annotation attribute. Thus, in order to support overrides of inherited global configuration,@SqlConfig
attributes have an explicitdefault
value of either""
for Strings orDEFAULT
for Enums. This approach allows local declarations of@SqlConfig
to selectively override individual attributes from global declarations of@SqlConfig
by providing a value other than""
orDEFAULT
.Inheritance and Overrides
Global
@SqlConfig
attributes are inherited whenever local@SqlConfig
attributes do not supply an explicit value other than""
orDEFAULT
. Explicit local configuration therefore overrides global configuration.- 从以下版本开始:
- 4.1
- 作者:
- Sam Brannen, Tadaya Tsuyukubo
- 另请参阅:
Sql
可选元素概要
可选元素 修饰符和类型 可选元素 说明 String
blockCommentEndDelimiter
The end delimiter that identifies block comments within the SQL scripts.String
blockCommentStartDelimiter
The start delimiter that identifies block comments within the SQL scripts.String
commentPrefix
The prefix that identifies single-line comments within the SQL scripts.String
dataSource
The bean name of theDataSource
against which the scripts should be executed.String
encoding
The encoding for the supplied SQL scripts, if different from the platform encoding.SqlConfig.ErrorMode
errorMode
The mode to use when an error is encountered while executing an SQL statement.String
separator
The character string used to separate individual statements within the SQL scripts.String
transactionManager
The bean name of thePlatformTransactionManager
that should be used to drive transactions.SqlConfig.TransactionMode
transactionMode
The mode to use when determining whether SQL scripts should be executed within a transaction.
元素详细资料
dataSource
String dataSource
The bean name of theDataSource
against which the scripts should be executed.The name is only required if there is more than one bean of type
DataSource
in the test'sApplicationContext
. If there is only one such bean, it is not necessary to specify a bean name.Defaults to an empty string, requiring that one of the following is true:
- An explicit bean name is defined in a global declaration of
@SqlConfig
. - The data source can be retrieved from the transaction manager by using reflection to invoke a public method named
getDataSource()
on the transaction manager. - There is only one bean of type
DataSource
in the test'sApplicationContext
. - The
DataSource
to use is named"dataSource"
.
- 默认值:
- ""
- An explicit bean name is defined in a global declaration of
transactionManager
String transactionManager
The bean name of thePlatformTransactionManager
that should be used to drive transactions.The name is only used if there is more than one bean of type
PlatformTransactionManager
in the test'sApplicationContext
. If there is only one such bean, it is not necessary to specify a bean name.Defaults to an empty string, requiring that one of the following is true:
- An explicit bean name is defined in a global declaration of
@SqlConfig
. - There is only one bean of type
PlatformTransactionManager
in the test'sApplicationContext
. TransactionManagementConfigurer
has been implemented to specify whichPlatformTransactionManager
bean should be used for annotation-driven transaction management.- The
PlatformTransactionManager
to use is named"transactionManager"
.
- 默认值:
- ""
- An explicit bean name is defined in a global declaration of
transactionMode
SqlConfig.TransactionMode transactionMode
The mode to use when determining whether SQL scripts should be executed within a transaction.Defaults to
DEFAULT
.Can be set to
SqlConfig.TransactionMode.ISOLATED
to ensure that the SQL scripts are executed in a new, isolated transaction that will be immediately committed.- 默认值:
- org.springframework.test.context.jdbc.SqlConfig.TransactionMode.DEFAULT
separator
String separator
The character string used to separate individual statements within the SQL scripts.Implicitly defaults to
";"
if not specified and falls back to"\n"
as a last resort.May be set to
ScriptUtils.EOF_STATEMENT_SEPARATOR
to signal that each script contains a single statement without a separator.- 默认值:
- ""
commentPrefix
String commentPrefix
The prefix that identifies single-line comments within the SQL scripts.Implicitly defaults to
"--"
.- 默认值:
- ""
blockCommentStartDelimiter
String blockCommentStartDelimiter
The start delimiter that identifies block comments within the SQL scripts.Implicitly defaults to
"/*"
.- 默认值:
- ""
blockCommentEndDelimiter
String blockCommentEndDelimiter
The end delimiter that identifies block comments within the SQL scripts.Implicitly defaults to
"*/"
.- 默认值:
- ""
errorMode
SqlConfig.ErrorMode errorMode
The mode to use when an error is encountered while executing an SQL statement.Defaults to
DEFAULT
.- 另请参阅:
SqlConfig.ErrorMode
- 默认值:
- org.springframework.test.context.jdbc.SqlConfig.ErrorMode.DEFAULT