DacPackage Class
Representation of the artifact that contains the definition of a data-tier application.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Dac.DacPackage
Namespace: Microsoft.SqlServer.Dac
Assembly: Microsoft.SqlServer.Dac (in Microsoft.SqlServer.Dac.dll)
Syntax
'Declaration
Public NotInheritable Class DacPackage _
Implements IDisposable
'Usage
Dim instance As DacPackage
public sealed class DacPackage : IDisposable
public ref class DacPackage sealed : IDisposable
[<SealedAttribute>]
type DacPackage =
class
interface IDisposable
end
public final class DacPackage implements IDisposable
The DacPackage type exposes the following members.
Properties
Name | Description | |
---|---|---|
Description | Get an optional summary of this package. | |
Name | Get identifier for this package. | |
PostDeploymentScript | Get stream used to read and write script executed after deploying schema contained in this package. | |
PreDeploymentScript | Get stream used to read and write script executed prior to deploying schema contained in this package. | |
Version | Get version information for this package. |
Top
Methods
Name | Description | |
---|---|---|
Dispose | Release the resources held by this instance. | |
Equals | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Load(Stream) | Load a package from the specified Stream. | |
Load(String) | Load a package file specified by fileName. | |
Load(Stream, DacSchemaModelStorageType) | Loads a package from the specified Stream. | |
Load(String, DacSchemaModelStorageType) | Loada a package file specified by fileName. | |
Load(Stream, DacSchemaModelStorageType, FileAccess) | Load a package from the specified Stream. | |
Load(String, DacSchemaModelStorageType, FileAccess) | Load a package file specified by fileName. | |
ToString | (Inherited from Object.) | |
Unpack | Place the contents of this package into the directory specified by directoryPath. |
Top
Extension Methods
Name | Description | |
---|---|---|
GetCollationString | Gets the collation associated with the specified package. (Defined by DacExtensions.) | |
UpdateModel | 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. (Defined by DacPackageExtensions.) |
Top
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.