Flyway multitenant extension

[rmanibus]

Quarkus Extension: Flyway Support for Hibernate Multitenancy

Overview

This pull request introduces a new Quarkus extension, quarkus-flyway-multitenant, which enables Flyway integration with Hibernate in multitenant schema-based mode.

Currently, Hibernate handles schema-based multitenancy effectively, but there is no built-in way to manage schema creation or apply migrations lazily for specific tenants. This extension bridges that gap, allowing users to manage migrations in multitenancy scenarios with greater flexibility.

Key Features

Flyway Schema Migration per Tenant:

The extension provides the @FlywayPersistenceUnit annotation, allowing developers to inject Flyway objects for individual tenants or persistence units.

@Inject
@FlywayPersistenceUnit(tenantId = "tenant1")
Flyway flywayForTenant1;

or

@Inject
@FlywayPersistenceUnit()
FlywayContainer flywayContainer;

public void migrateTenant2() {
  flywayContainer.getFlyway("tenant2").migrate();
}

Automatic Migration at Startup:

Support for specifying tenants to be migrated at application startup through the FlywayTenantSupport interface when the quarkus.flyway.multitenant.migrate-at-start property is enabled.

@FlywayPersistenceUnit()
public class TenantToInitialize implements FlywayTenantSupport {
    @Override
    public List<String> getTenantsToInitialize() {
        return List.of("tenant1", "tenant2");
    }
}

On-demand Migration:

Support for lazy migration when a tenant is resolved using a custom FlywayTenantResolverDecorator that runs migrations automatically for the resolved tenant.

This is not included in this PR since the user might want to customize the decorator logic, add caching, but an example implementation is provided in the doc. I am planning to provide a customizable implementation in a subsequent PR.

How to Use

Add the quarkus-flyway-multitenant extension to your project:

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-flyway-multitenant</artifactId>
</dependency>

Use the @FlywayPersistenceUnit annotation to inject Flyway instances for specific tenants or persistence units.

To automatically run migrations on startup for a set of tenants, implement the FlywayTenantSupport interface.

For automatic tenant-specific migrations during tenant resolution, decorate your TenantResolver.

related to #37080

[rmanibus]

cc @geoand

[github-actions]

🎊 PR Preview b46c8ef has been successfully built and deployed to https://quarkus-pr-main-43892-preview.surge.sh/version/main/guides/

• Images of blog posts older than 3 months are not available.
• Newsletters older than 3 months are not available.

[geoand]

Nice!

I'll have a close look in the following days, but I see that CI is not happy.
I see this in the logs:

Run ./update-extension-dependencies.sh and add the modified pom.xml files to your commit.

[quarkus-bot]

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 5c8b85a.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

Warning

There are other workflow runs running, you probably need to wait for their status before merging.

[rmanibus]

not sure about the naming of this one

[quarkus-bot]

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit 5c8b85a.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

You can consult the Develocity build scans.