YugabyteDB
Published 15 January 2025
- Verified Versions: 2.20, 2024.1, 2.21
- Maintainer: Flyway Open-Source Community
Supported Versions and Support Levels
- For information regarding the supported version and support levels available, please see Supported Databases for Flyway
- For information regarding the Flyway features available, please see Flyway feature summary
Driver
The preferred driver for this plugin is YugabyteDB JDBC driver.
| Item | Details |
|---|---|
| URL format | jdbc:yugabytedb://host:port/database |
| SSL support | Yes - add ?ssl=true |
| Ships with Flyway Command-line | No |
| Maven Central coordinates | com.yugabyte:jdbc-yugabytedb |
| Supported versions | 42.3.5-yb-1 and later |
| Default Java class | com.yugabyte.Driver |
| Flyway Community implementation | flyway-community-db-support |
PostgreSQL Driver
Alternatively, one can also use the PostgreSQL JDBC Driver with this plugin.
| Item | Details |
|---|---|
| URL format | jdbc:postgresql://host:port/database |
| SSL support | Yes - add ?ssl=true |
| Ships with Flyway Command-line | Yes |
| Maven Central coordinates | org.postgresql:postgresql |
| Supported versions | 9.3-1104-jdbc4 and later |
| Default Java class | org.postgresql.Driver |
Java Usage
YugabyteDB support is a separate dependency for Flyway and will need to be added to your Java project to access these features.
Maven
Open Source
<dependency>
<groupId>org.flywaydb</groupId>
<artifactId>flyway-database-yugabytedb</artifactId>
</dependency>
Gradle
Open Source
buildscript {
dependencies {
implmentation "org.flywaydb:flyway-database-yugabytedb"
}
}
Notes
YugabyteDB is a variant of PostgreSQL and Flyway usage is the same for the two databases. For more details, please refer to the PostgreSQL page.
Limitations
- AWS SecretsManager is not supported with YugabyteDB.