Enum Class SqlConfig.ErrorMode

java.lang.Object
java.lang.Enum<SqlConfig.ErrorMode>
org.springframework.test.context.jdbc.SqlConfig.ErrorMode
All Implemented Interfaces:
Serializable, Comparable<SqlConfig.ErrorMode>, Constable
Enclosing class:
SqlConfig

public static enum SqlConfig.ErrorMode extends Enum<SqlConfig.ErrorMode>
Enumeration of modes that dictate how errors are handled while executing SQL statements.
  • Enum Constant Details

    • DEFAULT

      public static final SqlConfig.ErrorMode DEFAULT
      Indicates that the default error mode should be used.

      The meaning of default depends on the context in which @SqlConfig is declared:

      • If @SqlConfig is declared only locally, the default error mode is FAIL_ON_ERROR.
      • If @SqlConfig is declared globally, the default error mode is FAIL_ON_ERROR.
      • If @SqlConfig is declared globally and locally, the default error mode for the local declaration is inherited from the global declaration.
    • FAIL_ON_ERROR

      public static final SqlConfig.ErrorMode FAIL_ON_ERROR
      Indicates that script execution will fail if an error is encountered. In other words, no errors should be ignored.

      This is effectively the default error mode so that if a script is accidentally executed, it will fail fast if any SQL statement in the script results in an error.

      See Also:
    • CONTINUE_ON_ERROR

      public static final SqlConfig.ErrorMode CONTINUE_ON_ERROR
      Indicates that all errors in SQL scripts should be logged but not propagated as exceptions.

      CONTINUE_ON_ERROR is the logical opposite of FAIL_ON_ERROR and a superset of IGNORE_FAILED_DROPS.

      See Also:
    • IGNORE_FAILED_DROPS

      public static final SqlConfig.ErrorMode IGNORE_FAILED_DROPS
      Indicates that failed SQL DROP statements can be ignored.

      This is useful for a non-embedded database whose SQL dialect does not support an IF EXISTS clause in a DROP statement.

      See Also:
  • Method Details

    • values

      public static SqlConfig.ErrorMode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static SqlConfig.ErrorMode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null