Share via


DacServices.GenerateDeployReport Method

Definition

Overloads

GenerateDeployReport(Stream, DacPackage, DacPackage, String, DacDeployOptions)

Create XML report of the steps needed to deploy the differences between the schemas of the supplied source and target DacPackage instances to a database.

GenerateDeployReport(DacPackage, DacPackage, String, DacDeployOptions)

Create XML report of the steps needed to deploy the differences between the schemas of the supplied source and target DacPackage instances to a database.

GenerateDeployReport(DacPackage, String, DacDeployOptions, Nullable<CancellationToken>)

Create XML report of the steps needed to deploy the schema of the supplied DacPackage to a database.

GenerateDeployReport(Stream, DacPackage, DacPackage, String, DacDeployOptions)

Create XML report of the steps needed to deploy the differences between the schemas of the supplied source and target DacPackage instances to a database.

public static void GenerateDeployReport (System.IO.Stream outputStream, Microsoft.SqlServer.Dac.DacPackage sourcePackage, Microsoft.SqlServer.Dac.DacPackage targetPackage, string targetDatabaseName, Microsoft.SqlServer.Dac.DacDeployOptions options = default);
static member GenerateDeployReport : System.IO.Stream * Microsoft.SqlServer.Dac.DacPackage * Microsoft.SqlServer.Dac.DacPackage * string * Microsoft.SqlServer.Dac.DacDeployOptions -> unit
Public Shared Sub GenerateDeployReport (outputStream As Stream, sourcePackage As DacPackage, targetPackage As DacPackage, targetDatabaseName As String, Optional options As DacDeployOptions = Nothing)

Parameters

outputStream
Stream

Stream to which to write the deployment report.

sourcePackage
DacPackage

DacPackage containing the source schema to be compared.

targetPackage
DacPackage

DacPackage containing the target schema to be compared.

targetDatabaseName
String

Name of the target database for deployment.

options
DacDeployOptions

Instance of DacDeployOptions that specifies properties that affect various aspects of the deployment report creation.

Exceptions

If a problem occurs during report generation.

Applies to

GenerateDeployReport(DacPackage, DacPackage, String, DacDeployOptions)

Create XML report of the steps needed to deploy the differences between the schemas of the supplied source and target DacPackage instances to a database.

public static string GenerateDeployReport (Microsoft.SqlServer.Dac.DacPackage sourcePackage, Microsoft.SqlServer.Dac.DacPackage targetPackage, string targetDatabaseName, Microsoft.SqlServer.Dac.DacDeployOptions options = default);
static member GenerateDeployReport : Microsoft.SqlServer.Dac.DacPackage * Microsoft.SqlServer.Dac.DacPackage * string * Microsoft.SqlServer.Dac.DacDeployOptions -> string
Public Shared Function GenerateDeployReport (sourcePackage As DacPackage, targetPackage As DacPackage, targetDatabaseName As String, Optional options As DacDeployOptions = Nothing) As String

Parameters

sourcePackage
DacPackage

DacPackage containing the source schema to be compared.

targetPackage
DacPackage

DacPackage containing the target schema to be compared.

targetDatabaseName
String

Name of the target database for deployment.

options
DacDeployOptions

Instance of DacDeployOptions that specifies properties that affect various aspects of the deployment report creation.

Returns

String of XML that details the steps of the deployment.

Exceptions

If a problem occurs during report generation.

Applies to

GenerateDeployReport(DacPackage, String, DacDeployOptions, Nullable<CancellationToken>)

Create XML report of the steps needed to deploy the schema of the supplied DacPackage to a database.

public string GenerateDeployReport (Microsoft.SqlServer.Dac.DacPackage package, string targetDatabaseName, Microsoft.SqlServer.Dac.DacDeployOptions options = default, System.Threading.CancellationToken? cancellationToken = default);
member this.GenerateDeployReport : Microsoft.SqlServer.Dac.DacPackage * string * Microsoft.SqlServer.Dac.DacDeployOptions * Nullable<System.Threading.CancellationToken> -> string
Public Function GenerateDeployReport (package As DacPackage, targetDatabaseName As String, Optional options As DacDeployOptions = Nothing, Optional cancellationToken As Nullable(Of CancellationToken) = Nothing) As String

Parameters

package
DacPackage

DacPackage containing schema to be deployed.

targetDatabaseName
String

Name of the target database for deployment.

options
DacDeployOptions

Instance of DacDeployOptions that specifies properties that affect various aspects of the deployment report creation.

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 of XML that details the steps of the package deployment.

Exceptions

If a problem occurs during report generation.

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

Applies to