DacPackageExtensions.UpdateModel 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

Updates the model in a DacPackage, replacing the current model with a new one.

Before updating, the model will be validated and if errors are encountered a DacServicesException will be thrown. If callers wish to block on warnings as well as errors, they must validate the model by calling Validate() and checking if any errors or warnings are included in the messages returned.

Note: only the model is replaced - all other artifacts such as refactor log, pre-deployment script, post-deployment script and and contributor artifacts are not altered. If any of these artifacts rely on elements that are no longer in the updated model then deployment may fail. It is the responsibility of the caller to ensure that these artifacts are consistent with the new model. The Package API can be used to update other artifacts such as the refactor log and scripts and keep them consistent with the updated model. These artifacts are stored as package parts and are identified by their URI. Package parts can be examined using GetParts(). Please refer to the Package API for further information about updating package parts.

public static void UpdateModel (this Microsoft.SqlServer.Dac.DacPackage dacPackage, Microsoft.SqlServer.Dac.Model.TSqlModel newModel, Microsoft.SqlServer.Dac.PackageMetadata packageMetadata);
static member UpdateModel : Microsoft.SqlServer.Dac.DacPackage * Microsoft.SqlServer.Dac.Model.TSqlModel * Microsoft.SqlServer.Dac.PackageMetadata -> unit
<Extension()>
Public Sub UpdateModel (dacPackage As DacPackage, newModel As TSqlModel, packageMetadata As PackageMetadata)

Parameters

dacPackage
DacPackage

DacPackage to be updated

newModel
TSqlModel

TSqlModel representing the model to save into the package.

packageMetadata
PackageMetadata

PackageMetadata describing the name, version and description to use for the DacPackage, or null if the package information should remain the same.

Exceptions

DacServicesException

If the dacPackage was not loaded with ReadWrite.

ArgumentNullException

If the dacPackage or newModel parameters are null.

Applies to