Skip to content

Document the need for Liquibase and Flyway starters #49839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
snicoll merged 2 commits into from
Apr 3, 2026
+4 −4
Merged

Document the need for Liquibase and Flyway starters #49839

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebe074c
Adapt documentation for Liquibase and Flyway to new modules
ppapaj Mar 30, 2026
c9cb517
Polish "Adapt documentation for Liquibase and Flyway to new modules"
snicoll Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .../spring-boot-docs/src/docs/antora/modules/how-to/pages/data-initialization.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ Spring Boot supports two higher-level migration tools: https://flywaydb.org/[Fly
=== Execute Flyway Database Migrations on Startup

To automatically run Flyway database migrations on startup, add the appropriate Flyway module to your classpath.
In-memory and file-based databases are supported by `org.flywaydb:flyway-core`.
Otherwise, a database-specific module is required.
In-memory and file-based databases are supported by the `spring-boot-starter-flyway` starter.
Other cases require also a database-specific module.
For example, use `org.flywaydb:flyway-database-postgresql` with PostgreSQL and `org.flywaydb:flyway-mysql` with MySQL.
See https://documentation.red-gate.com/fd/supported-databases-and-versions-143754067.html[the Flyway Documentation] for further details.

Expand Down Expand Up @@ -169,11 +169,11 @@ With that setup, migrations in `dev/db/migration` run only when the `dev` profil
[[howto.data-initialization.migration-tool.liquibase]]
=== Execute Liquibase Database Migrations on Startup

To automatically run Liquibase database migrations on startup, add the `org.liquibase:liquibase-core` to your classpath.
To automatically run Liquibase database migrations on startup, add the `spring-boot-starter-liquibase` starter to your classpath.

[NOTE]
====
When you add the `org.liquibase:liquibase-core` to your classpath, database migrations run by default for both during application startup and before your tests run.
When you add `spring-boot-starter-liquibase` to your classpath, database migrations run by default for both during application startup and before your tests run.
This behavior can be customized by using the configprop:spring.liquibase.enabled[] property, setting different values in the `main` and `test` configurations.
It is not possible to use two different ways to initialize the database (for example Liquibase for application startup, JPA for test runs).
====
Expand Down