Flyway

Database connections in Flyway Desktop

Flyway Desktop needs to communicate with the following databases:

  • Development database to track schema model changes as DDL CREATE scripts for version control
  • If you are generating migrations:
    • Shadow database (learn more)
    • Read-only database for baselining (if your project is not greenfield)
    • (Optional) Target databases to manually migrate (might be useful for Proof of Concepts before setting up a CI/CD pipeline)

Schemas

SQL Server - By default, we use all schemas.  If you want to limit tracking changes to a subset of schemas, set up a filter for this. 

Oracle - A list of comma separated schemas can be specified when setting up the connection to the Development Database.  

It is currently expected that these schemas will be the same across all databases used within Flyway Desktop. The one exception to this is that if only a single schema is being tracked when using Oracle, the shadow database can be set to a shadow schema instead, removing the need for an extra database.

A flyway_schema_history table will be added to the first schema in your list to track migration scripts that have been run on it.

Connecting to Oracle Databases

The following parameters are needed when connecting to Oracle databases:

  • JDBC URL: the standard JDBC URL format for Oracle databases.  Examples:
     jdbc:oracle:thin:@//<host>:<port>/<service>
    jdbc:oracle:thin:@<tns_entry>
    See Oracle official documentation.
  • Username: the username to use to connect.
  • Password: the password to use to connect.

Connecting to SQL Server databases

The following parameters are required when connecting to SQL Server Databases:

  • JDBC URL: the standard JDBC URL format for SQL Server databases. Example:
    jdbc:sqlserver://<host>:<port>;databaseName=<database>
    See SQL Server official documentation.

Flyway Desktop supports the following authentication types:

  • Integrated (Windows authentication)
  • SQL Password
  • Azure Active Directory Integrated
  • Azure Active Directory Password
  • Azure Active Directory Interactive (see Using Azure Interactive Authentication for details)

Connecting to PostgreSQL databases

  • JDBC URL:
    Aurora PostgreSQL : jdbc:postgresql://<instance>.<region>.rds.amazonaws.com:<port>/<database>?<key1>=<value1>&<key2>=<value2>...
    PostgreSQL             : jdbc:postgresql://<host>:<port>/<database>?<key1>=<value1>&<key2>=<value2>...

A preview of Schema model support in Postgres is currently available.  Learn more.

Other databases

You can view the example JDBC URLs for other databases that Flyway supports as part of the sample configuration file


Didn't find what you were looking for?