SQL Server Data Tools, SDK-style (preview)

  • Article

SQL Server Data Tools (SSDT) is a set of development tools in Visual Studio with focused on building SQL Server databases and Azure SQL databases. SDK-style SQL projects in Visual Studio enable the next generation of SQL projects as part of the SQL Server Data Tools, SDK-style (preview) feature available for Visual Studio 2022. The SQL projects capability extends to CI/CD pipelines, enabling you to automate the build and deployment of your database projects with the SqlPackage CLI.

Overview

The original SQL project format is based on MSBuild (.NET Framework) and is the format used by SQL Server Data Tools in Visual Studio. The SDK-style project format is based on the new SDK-style projects (Microsoft.Build.Sql) and is the format used by the SQL Database Projects extension for Azure Data Studio and VS Code. The Microsoft.Build.Sql project SDK is more flexible than the original SQL projects and contains new features:

  • .NET 8 support (cross platform)
  • NuGet package references for database references
  • Default globbing pattern for .sql files in the project

New development work should consider using the SDK-style project format, as it's the format that will be supported in the future. SDK-style projects have a superset of functionality from original SQL projects and existing SQL projects can be converted to SDK-style projects through modification of the project file. The exception to the functionality coverage is support for SQLCLR objects, which require .NET Framework and aren't supported in SDK-style projects.

Further documentation on SQL projects is available in the SQL database projects topic and the Microsoft.Build.Sql SDK is available on GitHub and on NuGet.org.

Install

Warning

The SDK-style SQL projects feature is in preview and side-by-side install with the original SQL projects isn't supported. Installing the SDK-style SQL projects in a standalone Visual Studio instance is advised.

To install the SDK-style SQL projects in Visual Studio 2022, follow these steps:

  1. Download and install Visual Studio 2022 preview (17.12 preview 2 or later) from the Visual Studio download page.
  2. During install, select the Individual components tab and search for "SQL" to locate and select "SQL Server Data Tools SDK-style (Preview)". Selecting this item automatically selects required dependencies.
  3. Continue the install without selecting workloads or extra features.

Screenshot of the Visual Studio installer with the individual components tab open.

The Visual Studio documentation provides additional information on modifying Visual Studio installations to select individual components.

Unexpected behavior may occur if the SDK-style SQL projects are installed side-by-side with the original SQL projects and installing SDK-style SQL Server Data Tools is advised as a standalone component. To verify what components are part of a Visual Studio install, use the Help menu in Visual Studio and select About Microsoft Visual Studio. Several approaches are available to utilize multiple Visual Studio instances on a single machine:

  • Install different release channels of Visual Studio, such as Visual Studio 2022 and Visual Studio 2022 preview.
  • Install different editions of Visual Studio, such as Visual Studio Community and Visual Studio Enterprise.
  • Install to a specific directory to separate a Visual Studio instance from a previously installed version.

Limitations

A full comparison of functionality between the SQL projects tools is available in SQL projects tools. The SDK-style SQL projects feature in Visual Studio has the following limitations:

  • Side-by-side install with original SQL projects isn't supported
  • The SQL project file uses the extension .sqlprojx instead of .sqlproj in Visual Studio 17.12 preview 2
  • SQLCLR objects aren't supported
  • Schema compare interface isn't enabled
  • Table designer interface isn't enabled
  • Data comparison interface isn't enabled
  • Database unit testing isn't enabled

Support for SDK-style SQL projects in Visual Studio is in preview and installing from the latest Visual Studio 2022 preview release is recommended. The SQL projects feature in Visual Studio is under active development and feedback is welcome through the Developer Community.

Convert existing projects

Microsoft.Build.Sql SDK-style SQL projects can be created from scratch or converted from existing SQL projects. The conversion of an original SQL project to a Microsoft.Build.Sql project can be done in place but creating a backup of the project before converting is recommended. To convert an existing SQL project to an SDK-style project, follow the steps in the Convert original SQL project how-to guide.

Related content