Package ca.uhn.fhir.jpa.migrate.tasks.api

Enum TaskFlagEnum

java.lang.Object
java.lang.Enum<TaskFlagEnum>
ca.uhn.fhir.jpa.migrate.tasks.api.TaskFlagEnum
All Implemented Interfaces:
Serializable, Comparable<TaskFlagEnum>
public enum TaskFlagEnum extends Enum<TaskFlagEnum>

  • Enum Constant Details

    • HEAVYWEIGHT_SKIP_BY_DEFAULT

      public static final TaskFlagEnum HEAVYWEIGHT_SKIP_BY_DEFAULT
      This task should be skipped by default on live system migrations. Use this flag in cases where the benefit of applying a migration doesn't justify the effort, and only use this flag in cases where skipping the task will not leave the system in an unusable state.

      This flag is intended for situations where a change to the schema would be useful to add to the default initialized schema, but would not be worth the effort of applying in-place to large databases due to the outsized effort it would take.

      USE THIS FLAG WITH CAUTION: It means that the migrator unit tests will execute the task, but live migrations probably won't. So think long and hard before you set it!

    • RUN_DURING_SCHEMA_INITIALIZATION

      public static final TaskFlagEnum RUN_DURING_SCHEMA_INITIALIZATION
      Should this task run even if we're doing the very first initialization of an empty schema. By default, we skip most tasks during that pass, since they just take up time and the schema should be fully initialized by the InitializeSchemaTask

    • FAILURE_ALLOWED

      public static final TaskFlagEnum FAILURE_ALLOWED
      This task is allowed to fail, and failure won't abort the migration. Upon any detected failures, the task will still be recorded as having been successfully complected. A failure in this context means that the SQL statement(s) being executed returned a non-successful response, or timed out.

    • DO_NOTHING

      public static final TaskFlagEnum DO_NOTHING
      This task should not actually do anything, and will always be recorded as a success. Use this flag for tasks that are no longer needed, e.g. because they are superseded by later tasks or because they turned out to be a bad idea.

  • Method Details

    • values

      public static TaskFlagEnum[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static TaskFlagEnum valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
      NullPointerException - if the argument is null