DacServices.Publish(DacPackage, String, PublishOptions) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dac

Assembly:: Microsoft.SqlServer.Dac.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.

Publish the supplied package to a database. This method supports returning the script used when publishing along with a deployment report summarizing the actions taken during Publish

public Microsoft.SqlServer.Dac.PublishResult Publish (Microsoft.SqlServer.Dac.DacPackage package, string targetDatabaseName, Microsoft.SqlServer.Dac.PublishOptions publishOptions);

member this.Publish : Microsoft.SqlServer.Dac.DacPackage * string * Microsoft.SqlServer.Dac.PublishOptions -> Microsoft.SqlServer.Dac.PublishResult

Public Function Publish (package As DacPackage, targetDatabaseName As String, publishOptions As PublishOptions) As PublishResult

Parameters

package: DacPackage

DacPackage containing schema to be deployed.

targetDatabaseName: String

Name of the target database for deployment.

publishOptions: PublishOptions

Instance of PublishOptions that specifies what is reported back - the deployment script, deployment report, as we all how to configure various aspects of the deployment.

Returns

PublishResult

PublishResult, containing the script(s) and/or report if requested by the caller

Exceptions

ArgumentException

If the value for any of the required parameters is a null reference or an empty string.

DacServicesException

If an error occurs during deployment.

OperationCanceledException

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

Applies to