DacServices.GenerateDriftReport Method

Definition

Namespace:

Microsoft.SqlServer.Dac

Assembly:

Microsoft.SqlServer.Dac.dll

Package:

Microsoft.SqlServer.DacFx v162.2.111

Overloads

GenerateDriftReport(String, Nullable<CancellationToken>)	Create XML report of the drift that has occurred since the database was last registered.
GenerateDriftReport(String, DacSchemaModelStorageType, Nullable<CancellationToken>)	Create XML report of the drift that has occurred since the database was last registered.

GenerateDriftReport(String, Nullable<CancellationToken>)

Create XML report of the drift that has occurred since the database was last registered.

public string GenerateDriftReport (string targetDatabaseName, System.Threading.CancellationToken? cancellationToken = default);

member this.GenerateDriftReport : string * Nullable<System.Threading.CancellationToken> -> string

Public Function GenerateDriftReport (targetDatabaseName As String, Optional cancellationToken As Nullable(Of CancellationToken) = Nothing) As String

Parameters

targetDatabaseName

String

Name of the target database for deployment.

cancellationToken

Nullable<CancellationToken>

Optional CancellationToken that can be used to indicate that the operation should be cancelled. Use of this object does not guarantee that the operation will be cancelled.

Returns

String

String of XML that details the database drift, or null if the database has not been registered.

Exceptions

DacServicesException

If a problem occurs during report generation.

OperationCanceledException

If the CancellationToken has a cancellation requested and the operation could be cancelled.

GenerateDriftReport(String, DacSchemaModelStorageType, Nullable<CancellationToken>)

Create XML report of the drift that has occurred since the database was last registered.

public string GenerateDriftReport (string targetDatabaseName, Microsoft.SqlServer.Dac.DacSchemaModelStorageType modelStorageType, System.Threading.CancellationToken? cancellationToken = default);

member this.GenerateDriftReport : string * Microsoft.SqlServer.Dac.DacSchemaModelStorageType * Nullable<System.Threading.CancellationToken> -> string

Public Function GenerateDriftReport (targetDatabaseName As String, modelStorageType As DacSchemaModelStorageType, Optional cancellationToken As Nullable(Of CancellationToken) = Nothing) As String

Parameters

targetDatabaseName

String

Name of the target database for deployment.

modelStorageType

DacSchemaModelStorageType

Specifies the type of backing storage for a schema model.

cancellationToken

Nullable<CancellationToken>

Optional CancellationToken that can be used to indicate that the operation should be cancelled. Use of this object does not guarantee that the operation will be cancelled.

Returns

String

String of XML that details the database drift, or null if the database has not been registered.

Exceptions

DacServicesException

If a problem occurs during report generation.

OperationCanceledException

If the CancellationToken has a cancellation requested and the operation could be cancelled.