Package io.micronaut.test.annotation

Annotation Interface Sql

@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited @Repeatable(Sqls.class) public @interface Sql
Annotation that can be applied to a test scenario to execute SQL against a test database prior to the sceario being run.
Since:
4.1.0
Author:
Tim Yates

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Sql.Phase
    The phase of the test to execute the SQL scripts.
    static @interface 
    Sql.Sqls
    Wrapper annotation class to allow multiple Sql annotations per test class or method.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    dataSourceName
    The name of the datasource to use for the SQL scripts.
    Sql.Phase
    phase
    The phase of the test to execute the SQL scripts.
    Class<?>
    resourceType
     
    String[]
    scripts
    Scripts to execute, e.g.
    String[]
    value
     

  • Element Details

    • value

      @AliasFor(member="scripts") String[] value
      Returns:
      The SQL scripts to execute
      Default:
      {}

    • dataSourceName

      String dataSourceName
      The name of the datasource to use for the SQL scripts.
      Returns:
      The datasource name
      Default:
      "default"

    • phase

      Sql.Phase phase
      The phase of the test to execute the SQL scripts.
      Returns:
      The phase
      Default:
      BEFORE_ALL

    • scripts

      @AliasFor(member="value") String[] scripts
      Scripts to execute, e.g. "classpath:foo.sql".
      Returns:
      The SQL scripts to execute
      Default:
      {}

    • resourceType

      Class<?> resourceType
      Returns:
      The type of the resource to use for the SQL scripts.
      Default:
      javax.sql.DataSource.class