Starter

DB Migrator Listener

Starter-backed listener support for running Helix database migrations during service startup.

Artifact
helix-dbmigrator-listener-spring-boot-starter

Usage

build.gradle

Groovy DSL

dependencies {
    implementation helix.dbmigrator.listener.springboot.starter
}

build.gradle.kts

Kotlin DSL

dependencies {
    implementation(helix.dbmigrator.listener.springboot.starter)
}

Configuration

This starter uses the helix.dbmigrator.listener property namespace.

  • helix.dbmigrator.listener.enabled (Boolean): Name of the property that enables this database migration listener.
  • helix.dbmigrator.listener.local-envs (List): Name of the property that allows the user to specify a comma-delimited list of environment names to consider as local environments for database migration purposes.
  • helix.dbmigrator.listener.env-name.override (String): Name of the property that allows you to override the current runtime environment name to be used when evaluating which migrations to run.
  • app.database.migrate-on-start (Boolean): Property that enables migration on application startup.
  • app.database.clean-migrate (Boolean): Property that enables clean migration.