SchemaComparison Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Dac.Compare

Assembly:: Microsoft.SqlServer.Dac.Extensions.dll

Package:: Microsoft.SqlServer.DacFx.x64 v140.3881.1

Package:: Microsoft.SqlServer.DacFx v150.5282.3

Package:: Microsoft.SqlServer.DacFx v160.6161.0

Package:: Microsoft.SqlServer.DacFx v162.2.111

Package:: Microsoft.Data.Tools.Msbuild v10.0.61804.210

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Class that allows comparing schema between two types of entities: databases and dacpac files

public sealed class SchemaComparison

type SchemaComparison = class

Public NotInheritable Class SchemaComparison

Inheritance: Object
SchemaComparison

Constructors

SchemaComparison(SchemaCompareEndpoint, SchemaCompareEndpoint)	SchemaComparison constructor that takes endpoints that specify the source and target for comparison.
SchemaComparison(String)	SchemaComparison constructor that uses a schema compare file (.scmp file) for all comparison settings. Only dacpac and/or database and/or sql project endpoints may be compared.

Properties

ExcludedSourceObjects	Elements in the source database model to exclude from comparison.
ExcludedTargetObjects	Elements in the target database model to exclude from comparison.
Options	Options that affect the behavior of package deployment.
Source	The SchemaCompareEndpoint that refers to a schema source.
Target	The SchemaCompareEndpoint that refers to a target. Comparison will update the target to match the source.

Methods

Compare()	Performs schema comparison, populating comparison results.
Compare(CancellationToken)	Performs schema comparison, populating comparison results.
SaveToFile(String, Boolean)	Saves the SchemaComparison as an scmp file.
SaveToStream(Stream)	Saves the SchemaComparison as an scmp file into a stream

Applies to