Skip to content

SQL Database Project tools

Erik Ejlskov Jensen edited this page Nov 29, 2024 · 2 revisions

The SQL Database Project tools are a set of tools to enhance your development experience with SQL Database Projects in Visual Studio. In addition to the traditional SQL Database Project .sqlproj projects, also projects based on the MSBuild.SDK.SqlProj and the Microsoft.Build.Sql SDKs are supported.

Right click the SQL Database Project in Solution Explorer and select a tool:

Data API Builder Scaffold (preview)

This feature allows you to generate a .cmd file to run the Data API Builder dab CLI tool to quickly configure a CRUD Web API with REST and GraphQL endpoints. Read more in my blog post

Analyze (preview)

Runs T-SQL static code analysis against your database project, and displays the results in html format. If you want to add this to your database project during build, follow the guide in my blog post. Thanks to the SqlServer.Rules project for sharing the building blocks for this feature.

Visualize Database Model

Allows you to visualize the schema of the chosen database project. Requires the Visual Studio DGML viewer component (not available for ARM64)

ER Diagram

Generate a Mermaid Entity Relationship diagram of your database project. Requires the Mermaid editor extension in order to view the diagram in Visual Studio.