CockroachDB

• Verified Versions: v21.1, v24.2
• Maintainer: Redgate

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

Java Usage

CockroachDB support is a separate dependency for Flyway and will need to be added to your Java project to access these features. CockroachDB is found within the flyway-database-postgresql plugin module.

Maven

Redgate

<dependency>
    <groupId>com.redgate.flyway</groupId>
    <artifactId>flyway-database-postgresql</artifactId>
</dependency>

Open Source

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

Gradle

Redgate

dependencies {
    implementation "com.redgate.flyway:flyway-database-postgresql"
}

Open Source

dependencies {
    implementation "org.flywaydb:flyway-database-postgresql"
}

SQL Script Syntax

• Standard SQL syntax with statement delimiter ;

Compatibility

• DDL exported by pg_dump can be used unchanged in a Flyway migration.
• Any CockroachDB sql script executed by Flyway, can be executed by the CockroachDB command-line tool and other PostgreSQL-compatible tools (after the placeholders have been replaced).

Example

/* Single line comment */
CREATE TABLE test_data (
 value VARCHAR(25) NOT NULL PRIMARY KEY
);


/*
Multi-line
comment
*/

-- Placeholder
INSERT INTO ${tableName} (name) VALUES ('Mr. T');

Limitations

• No support for psql meta-commands with no JDBC equivalent like \set

Additional Information

• See CockroachDB's walkthrough on using Flyway here