DacServices.GenerateDeployReport Method (DacPackage, String, DacDeployOptions, Nullable<CancellationToken>)
Creates an XML report of the steps needed to deploy the schema of the supplied DacPackage to a database.
Namespace: Microsoft.SqlServer.Dac
Assembly: Microsoft.SqlServer.Dac (in Microsoft.SqlServer.Dac.dll)
Syntax
'Declaration
Public Function GenerateDeployReport ( _
package As DacPackage, _
targetDatabaseName As String, _
options As DacDeployOptions, _
cancellationToken As Nullable(Of CancellationToken) _
) As String
'Usage
Dim instance As DacServices
Dim package As DacPackage
Dim targetDatabaseName As String
Dim options As DacDeployOptions
Dim cancellationToken As Nullable(Of CancellationToken)
Dim returnValue As String
returnValue = instance.GenerateDeployReport(package, _
targetDatabaseName, options, cancellationToken)
public string GenerateDeployReport(
DacPackage package,
string targetDatabaseName,
DacDeployOptions options,
Nullable<CancellationToken> cancellationToken
)
public:
String^ GenerateDeployReport(
DacPackage^ package,
String^ targetDatabaseName,
DacDeployOptions^ options,
Nullable<CancellationToken> cancellationToken
)
member GenerateDeployReport :
package:DacPackage *
targetDatabaseName:string *
options:DacDeployOptions *
cancellationToken:Nullable<CancellationToken> -> string
public function GenerateDeployReport(
package : DacPackage,
targetDatabaseName : String,
options : DacDeployOptions,
cancellationToken : Nullable<CancellationToken>
) : String
Parameters
- package
Type: Microsoft.SqlServer.Dac.DacPackage
The DacPackage containing schema to be deployed.
- targetDatabaseName
Type: String
The name of the target database for deployment.
- options
Type: Microsoft.SqlServer.Dac.DacDeployOptions
The instance of DacDeployOptions that specifies properties that affect various aspects of the deployment report creation.
- cancellationToken
Type: Nullable<CancellationToken>
The 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.
Return Value
Type: String
The string of XML that details the steps of the package deployment.
Exceptions
Exception | Condition |
---|---|
DacServicesException | If a problem occurs during report generation. |
OperationCanceledException | If the CancellationToken has a cancellation requested and the operation could be cancelled. |