DacPackageExtensions.BuildPackage Method

  • Reference

Definition

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

Overloads

BuildPackage(Stream, TSqlModel, PackageMetadata)

Creates a package with the specified TSqlModel and saves it to the specified Stream.
BuildPackage(String, TSqlModel, PackageMetadata)

Creates a package with the specified TSqlModel and saves it to the specified location.
BuildPackage(Stream, TSqlModel, PackageMetadata, PackageOptions)

Creates a package with the specified TSqlModel and saves it to the specified Stream. In addition to the TSqlModel, other artifacts such as refactor log and deployment contributors can be specified in packageOptions.
BuildPackage(String, TSqlModel, PackageMetadata, PackageOptions)

Creates a package with the specified TSqlModel and saves it to the specified location. In addition to the TSqlModel, other artifacts such as refactor log and deployment contributors can be specified in packageOptions.

BuildPackage(Stream, TSqlModel, PackageMetadata)

Creates a package with the specified TSqlModel and saves it to the specified Stream.

public static void BuildPackage (System.IO.Stream stream, Microsoft.SqlServer.Dac.Model.TSqlModel model, Microsoft.SqlServer.Dac.PackageMetadata packageMetadata);
static member BuildPackage : System.IO.Stream * Microsoft.SqlServer.Dac.Model.TSqlModel * Microsoft.SqlServer.Dac.PackageMetadata -> unit
Public Sub BuildPackage (stream As Stream, model As TSqlModel, packageMetadata As PackageMetadata)

Parameters

stream
Stream

Stream to which the package content will be serialized.

model
TSqlModel

TSqlModel representing the model to save into the package.

packageMetadata
PackageMetadata

Metadata information that describes the package.

Exceptions

DacServicesException

If there are any errors during package serialization, including errors validating the model.

ArgumentNullException

If the stream or model parameters are null.

Applies to

BuildPackage(String, TSqlModel, PackageMetadata)

Creates a package with the specified TSqlModel and saves it to the specified location.

public static void BuildPackage (string packageFilePath, Microsoft.SqlServer.Dac.Model.TSqlModel model, Microsoft.SqlServer.Dac.PackageMetadata packageMetadata);
static member BuildPackage : string * Microsoft.SqlServer.Dac.Model.TSqlModel * Microsoft.SqlServer.Dac.PackageMetadata -> unit
Public Sub BuildPackage (packageFilePath As String, model As TSqlModel, packageMetadata As PackageMetadata)

Parameters

packageFilePath
String

Path to the package file.

model
TSqlModel

TSqlModel representing the model to save into the package.

packageMetadata
PackageMetadata

Metadata information that describes the package.

Exceptions

DacServicesException

If there are any errors during package serialization, including errors validating the model.

ArgumentNullException

If the packageFilePath or model parameters are null.

Applies to

BuildPackage(Stream, TSqlModel, PackageMetadata, PackageOptions)

Creates a package with the specified TSqlModel and saves it to the specified Stream. In addition to the TSqlModel, other artifacts such as refactor log and deployment contributors can be specified in packageOptions.

public static void BuildPackage (System.IO.Stream stream, Microsoft.SqlServer.Dac.Model.TSqlModel model, Microsoft.SqlServer.Dac.PackageMetadata packageMetadata, Microsoft.SqlServer.Dac.PackageOptions packageOptions);
static member BuildPackage : System.IO.Stream * Microsoft.SqlServer.Dac.Model.TSqlModel * Microsoft.SqlServer.Dac.PackageMetadata * Microsoft.SqlServer.Dac.PackageOptions -> unit
Public Sub BuildPackage (stream As Stream, model As TSqlModel, packageMetadata As PackageMetadata, packageOptions As PackageOptions)

Parameters

stream
Stream

Stream to which the package content will be serialized.

model
TSqlModel

TSqlModel representing the model to save into the package.

packageMetadata
PackageMetadata

Metadata information that describes the package.

packageOptions
PackageOptions

PackageOptions defining advanced options and additional artifacts.

Exceptions

DacServicesException

If there are any errors during package serialization, including errors validating the model.

ArgumentNullException

If the stream or model parameters are null.

Applies to

BuildPackage(String, TSqlModel, PackageMetadata, PackageOptions)

Creates a package with the specified TSqlModel and saves it to the specified location. In addition to the TSqlModel, other artifacts such as refactor log and deployment contributors can be specified in packageOptions.

public static void BuildPackage (string packageFilePath, Microsoft.SqlServer.Dac.Model.TSqlModel model, Microsoft.SqlServer.Dac.PackageMetadata packageMetadata, Microsoft.SqlServer.Dac.PackageOptions packageOptions);
static member BuildPackage : string * Microsoft.SqlServer.Dac.Model.TSqlModel * Microsoft.SqlServer.Dac.PackageMetadata * Microsoft.SqlServer.Dac.PackageOptions -> unit
Public Sub BuildPackage (packageFilePath As String, model As TSqlModel, packageMetadata As PackageMetadata, packageOptions As PackageOptions)

Parameters

packageFilePath
String

Path to the package file.

model
TSqlModel

TSqlModel representing the model to save into the package.

packageMetadata
PackageMetadata

Metadata information that describes the package.

packageOptions
PackageOptions

PackageOptions defining advanced options and additional artifacts.

Exceptions

DacServicesException

If there are any errors during package serialization, including errors validating the model.

ArgumentNullException

If the packageFilePath or model parameters are null.

Applies to