Back to Flyway

YugabyteDB

documentation/Reference/Database Driver Reference/YugabyteDB.md

latest3.5 KB
Original Source
  • Verified Versions: 2.20, 2024.1, 2.21
  • Maintainer: {% include community-db.html %}

Supported Versions and Support Levels

{% include database-boilerplate.html %}

Driver

The preferred driver for this plugin is YugabyteDB JDBC driver.

ItemDetails
URL format<code>jdbc:yugabytedb://<i>host</i>:<i>port</i>/<i>database</i></code>
SSL supportYes - add ?ssl=true
Ships with Flyway Command-lineNo
Maven Central coordinatescom.yugabyte:jdbc-yugabytedb
Supported versions42.3.5-yb-1 and later
Default Java classcom.yugabyte.Driver
Flyway Community implementationflyway-community-db-support

PostgreSQL Driver

Alternatively, one can also use the PostgreSQL JDBC Driver with this plugin.

ItemDetails
URL format<code>jdbc:postgresql://<i>host</i>:<i>port</i>/<i>database</i></code>
SSL supportYes - add ?ssl=true
Ships with Flyway Command-lineYes
Maven Central coordinatesorg.postgresql:postgresql
Supported versions9.3-1104-jdbc4 and later
Default Java classorg.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

xml

<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-database-yugabytedb</artifactId>
</dependency>

Gradle

Open Source

groovy
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.