DacServices.GenerateDeployScript Method (DacPackage, String, DacDeployOptions, Nullable<CancellationToken>)

Creates a Transact-SQL script that can be used to deploy the schema of the supplied DacPackage to a database.

Namespace:  Microsoft.SqlServer.Dac
Assembly:  Microsoft.SqlServer.Dac (in Microsoft.SqlServer.Dac.dll)

public string GenerateDeployScript(
	DacPackage package,
	string targetDatabaseName,
	DacDeployOptions options,
	Nullable<CancellationToken> cancellationToken
)

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 script 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 Transact-SQL script used to create or update database schema based on the supplied DacPackage.

ExceptionCondition
DacServicesException

If a problem occurs during script generation.

OperationCanceledException

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

Community Additions

Show: