Skip to content

mssql-schema-compare.md

Latest commit

 

History

History
83 lines (53 loc) · 4.92 KB

mssql-schema-compare.md

File metadata and controls

83 lines (53 loc) · 4.92 KB
title Overview of the Schema Compare Feature in the MSSQL Extension for Visual Studio Code
description Learn how the Schema Compare feature simplifies comparing databases, and gives you full control when synchronizing them, even across different database versions.
author tauseefsiddique10
ms.author tsiddique
ms.reviewer roblescarlos, randolphwest
ms.date 08/20/2025
ms.service sql
ms.subservice vs-code-sql-extensions
ms.topic overview
ms.collection
data-tools
ai-usage ai-assisted

Schema Compare

This article provides an overview of the Schema Compare feature for the MSSQL extension in Visual Studio Code. Schema Compare compares two database definitions, and applies the differences from the source to the target, including active database connections, .dacpac files, and SQL projects.

Schema Compare simplifies the process of comparing databases, and gives you full control when synchronizing them, even across different database versions. You can selectively filter specific differences, and categories of differences, before applying any changes.

Features

Schema Compare provides the following features:

  • Compare schemas between two .dacpac files, databases, or SQL projects.
  • View results as a set of actions to match a target against the source.
  • Selectively exclude actions listed in results.
  • Set options that control the scope of the comparison.
  • Apply changes directly to the target, or generate a script to apply changes at a later time.
  • Save the comparison.

:::image type="content" source="media/mssql-schema-compare/schema-compare-main-view.png" alt-text="Screenshot of the main view of Schema Compare showing differences between source and target." lightbox="media/mssql-schema-compare/schema-compare-main-view.png":::

Install the MSSQL extension

To user the Schema Compare features, install the MSSQL extension for Visual Studio Code:

  1. In Visual Studio Code, select the Extensions icon to view available extensions.

    :::image type="content" source="media/mssql-schema-compare/schema-compare-install.png" alt-text="Screenshot of installing the MSSQL extension in Visual Studio Code.":::

  2. Search for the SQL Server (mssql) extension and select it to view its details. Select Install to add the extension.

  3. Once installed, Reload to enable the extension in Visual Studio Code (only required when installing an extension for the first time).

Compare schemas

To compare schemas, open the Schema Compare dialog box. To do so, follow these steps:

  1. To open the Schema Compare dialog box, right-click a database in Object Explorer and select Schema Compare. The database you select is set as the Source database in the comparison.

    :::image type="content" source="media/mssql-schema-compare/schema-compare-enter.png" alt-text="Screenshot of Opening Schema Compare by right-clicking a database in Object Explorer.":::

  2. Select one of the ellipses (...) to change the Source and Target of your Schema Compare and select OK.

    :::image type="content" source="media/mssql-schema-compare/schema-compare-menu.png" alt-text="Screenshot of Changing the source and target in the Schema Compare menu." lightbox="media/mssql-schema-compare/schema-compare-menu.png":::

  3. To customize your comparison, select the Options button in the toolbar.

    :::image type="content" source="media/mssql-schema-compare/schema-compare-options.png" alt-text="Screenshot of Opening the options menu in the Schema Compare." lightbox="media/mssql-schema-compare/schema-compare-options.png":::

  4. Select Compare to view the results of the comparison.

    :::image type="content" source="media/mssql-schema-compare/schema-compare-button.png" alt-text="Screenshot of Selecting the Compare button to view schema differences." lightbox="media/mssql-schema-compare/schema-compare-button.png":::

Apply changes

  1. Navigate through the object list, and ensure that you select the objects you would like to apply changes to.

    :::image type="content" source="media/mssql-schema-compare/schema-compare-diff-view.png" alt-text="Screenshot of Viewing the list of schema differences in the Schema Compare." lightbox="media/mssql-schema-compare/schema-compare-diff-view.png":::

  2. Apply the changes to your target.

    :::image type="content" source="media/mssql-schema-compare/schema-compare-apply.png" alt-text="Screenshot of Applying selected schema changes to the target database." lightbox="media/mssql-schema-compare/schema-compare-apply.png":::

Related content