• Verified Versions: 2008, 2025
• 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

Configuration

SQL-Server-specific configuration can be found here.

Java Usage

SQL Server support is a separate dependency for Flyway and will need to be added to your Java project to access these features.

Maven

Redgate

<dependency>
    <groupId>com.redgate.flyway</groupId>
    <artifactId>flyway-sqlserver</artifactId>
</dependency>

Open Source

<dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-sqlserver</artifactId>
</dependency>

Gradle

Redgate

buildscript {
    dependencies {
        implementation "com.redgate.flyway:flyway-sqlserver"
    }
}

Open Source

buildscript {
    dependencies {
        implementation "org.flywaydb:flyway-sqlserver"
    }
}

SQL Script Syntax

• Standard SQL syntax with statement delimiter GO
• T-SQL

Compatibility

• DDL exported by SQL Server can be used unchanged in a Flyway migration.
• Any SQL Server sql script executed by Flyway, can be executed by Sqlcmd, SQL Server Management Studio and other SQL Server-compatible tools (after the placeholders have been replaced).

Example

/* Single line comment */
CREATE TABLE Customers (
CustomerId smallint identity(1,1),
Name nvarchar(255),
Priority tinyint
)
CREATE TABLE Sales (
TransactionId smallint identity(1,1),
CustomerId smallint,
[Net Amount] int,
Completed bit
)
GO

/*
Multi-line
comment
*/
-- TSQL
CREATE TRIGGER dbo.Update_Customer_Priority
 ON dbo.Sales
AFTER INSERT, UPDATE, DELETE
AS
WITH CTE AS (
 select CustomerId from inserted
 union
 select CustomerId from deleted
)
UPDATE Customers
SET
 Priority =
   case
     when t.Total < 10000 then 3
     when t.Total between 10000 and 50000 then 2
     when t.Total > 50000 then 1
     when t.Total IS NULL then NULL
   end
FROM Customers c
INNER JOIN CTE ON CTE.CustomerId = c.CustomerId
LEFT JOIN (
 select
   Sales.CustomerId,
   SUM([Net Amount]) Total
 from Sales
 inner join CTE on CTE.CustomerId = Sales.CustomerId
 where
   Completed = 1
 group by Sales.CustomerId
) t ON t.CustomerId = c.CustomerId
GO

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

Authentication

SQL Server supports several methods of authentication, including SQL Server Authentication, Windows Integrated Authentication, Microsoft Entra ID, and Kerberos.

For how to use authentication methods, see Connecting to environments. For credential storage and retrieval, see Storing and retrieving credentials.

Note: Flyway depends on Microsoft's JDBC drivers, which have many environmental dependencies to enable different authentication types. Refer to the Microsoft JDBC Driver for SQL Server documentation when troubleshooting authentication problems.

Connecting to a Named Instance

When connecting to a named instance, the JDBC URL must be of the form:

jdbc:sqlserver://<server_name>;instanceName=<instance_name>;databaseName=<database_name>

For example:

jdbc:sqlserver://test_server;instanceName=test_instance;databaseName=test_database

Note: If a named instance is used along with the <host>:<port> syntax in the JDBC URL, the driver will connect to the port over the named instance.

Limitations

• Flyway's automatic detection for whether SQL statements are valid in transactions does not apply to CREATE/ALTER/DROP statements acting on memory-optimized tables (that is, those created with WITH (MEMORY_OPTIMIZED = ON)). You will need to override the executeInTransaction setting to be false, on a per-script basis.
• SQL Server is unable to change the default schema for a session. Therefore, setting the flyway.defaultSchema property has no value, unless used for a Placeholder in your sql scripts. If you decide to use flyway.defaultSchema, it also must exist in flyway.schemas.
• By default, the flyway schema history table will try to write to the default schema for the database connection. You may specify which schema to write this table to by setting flyway.schemas=custom_schema, as the first entry will become the default schema if flyway.defaultSchema itself is not set.
• With these limitations in mind, please refer to the properties or options mentioned herefor descriptions/consequences.
• If using the JTDS driver, then setting ANSI_NULLS or QUOTED_IDENTIFIER in a script will cause an error. This is a driver limitation, and can be solved by using the Microsoft driver instead.
• When running clean, no users will be dropped