Package Package Package Class

Definition

Represents the package container. This class cannot be inherited.

public ref class Package sealed : Microsoft::SqlServer::Dts::Runtime::EventsProvider, Microsoft::SqlServer::Dts::Runtime::IDTSConfigurationControl, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProviderEx, Microsoft::SqlServer::Dts::Runtime::IDTSSequence
public sealed class Package : Microsoft.SqlServer.Dts.Runtime.EventsProvider, Microsoft.SqlServer.Dts.Runtime.IDTSConfigurationControl, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProviderEx, Microsoft.SqlServer.Dts.Runtime.IDTSSequence
Public NotInheritable Class Package
Inherits EventsProvider
Implements IDTSConfigurationControl, IDTSExecutionPath, IDTSPackagePath, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSSequence
Inheritance
Implements

Remarks

The package is a collection of other containers, connections, tasks, transformations, variables, configurations, and precedence constraints. Packages can be created programmatically, or by using the SSIS Designer graphical tool. Packages can be saved to various locations, including Microsoft SQL Server or an XML file.

For more information about packages, see Integration Services (SSIS) Packages.

Constructors

Package() Package() Package()

Initializes a new instance of the Package class.

Properties

CertificateContext CertificateContext CertificateContext

Gets or sets the certificate context.

CertificateObject CertificateObject CertificateObject

Gets or sets the X.509 certificate object for the package.

CheckpointFileName CheckpointFileName CheckpointFileName

Gets or sets the name of the file that captures the checkpoint information, which enables a package to restart.

CheckpointUsage CheckpointUsage CheckpointUsage

Gets or sets a value that specifies if or when a package is restarted.

CheckSignatureOnLoad CheckSignatureOnLoad CheckSignatureOnLoad

Gets or sets a value indicating whether the digital signature is checked when a package is loaded.

Configurations Configurations Configurations

Gets the collection of configurations for the package. A package can have more than one configuration associated with it. This property is read-only.

Connections Connections Connections

Gets the collection of connection managers for the package.

CreationDate CreationDate CreationDate

Gets or sets the date and time that the package was created.

CreationName CreationName CreationName

Returns the string that is used to create an instance of the DtsContainer object. This property is read-only.

(Inherited from DtsContainer)
CreatorComputerName CreatorComputerName CreatorComputerName

Gets or sets the name of the computer on which the package was created.

CreatorName CreatorName CreatorName

Gets or sets the name of the individual who created the package.

DebugMode DebugMode DebugMode

Gets or sets a Boolean that indicates whether the DtsContainer object is in debug mode and whether it should fire the OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) event while running.

(Inherited from DtsContainer)
DelayValidation DelayValidation DelayValidation

Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.

(Inherited from DtsContainer)
Description Description Description

Gets or sets the description of the DtsContainer object.

(Inherited from DtsContainer)
DesignEvents DesignEvents DesignEvents

Gets or sets an IDTSEvents that indicates if the designer or other third-party client is to receive events during design time.

DesignTimeProperties DesignTimeProperties DesignTimeProperties

Gets or sets the design time properties of a package such as layout information.

Disable Disable Disable

A Boolean that indicates if the DtsContainer object is disabled.

(Inherited from DtsContainer)
DisableEventHandlers DisableEventHandlers DisableEventHandlers

Gets or sets a Boolean that indicates whether the event handlers on task are disabled.

(Inherited from EventsProvider)
DumpDescriptor DumpDescriptor DumpDescriptor

Specify when a dump file should be generated.

DumpOnAnyError DumpOnAnyError DumpOnAnyError

Specify if a dump file should be generated when any error occurs during package execution.

EnableConfigurations EnableConfigurations EnableConfigurations

Gets or sets a value that indicates whether the package loads configurations.

EnableDump EnableDump EnableDump

Specify if the dump file generation is enabled.

EncryptCheckpoints EncryptCheckpoints EncryptCheckpoints

Gets or sets a value that indicates whether the checkpoint files are encrypted.

Errors Errors Errors

Gets the collection of errors associated with the package. This field is read-only.

EventHandlers EventHandlers EventHandlers

Returns a collection of event handler objects. This field is read-only.

(Inherited from EventsProvider)
EventInfos EventInfos EventInfos

Returns a collection of EventInfo objects. This field is read-only.

(Inherited from EventsProvider)
Executables Executables Executables

Gets the collection of executable objects contained within the package that are a part of the package workflow.

ExecutionDuration ExecutionDuration ExecutionDuration

Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.

(Inherited from DtsContainer)
ExecutionResult ExecutionResult ExecutionResult

Returns a value that indicates the success or failure of the execution of the DtsContainer object.

(Inherited from DtsContainer)
ExecutionStatus ExecutionStatus ExecutionStatus

Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call.

(Inherited from DtsContainer)
ExtendedProperties ExtendedProperties ExtendedProperties

Gets the ExtendedProperties collection for the package.

FailPackageOnFailure FailPackageOnFailure FailPackageOnFailure

Gets or sets a value that indicates whether the package fails when a task or component in the package fails.

FailParentOnFailure FailParentOnFailure FailParentOnFailure

Gets or sets a Boolean that defines whether the parent container fails when a child container fails.

(Inherited from DtsContainer)
ForcedExecutionValue ForcedExecutionValue ForcedExecutionValue

If the ForceExecutionValue property is set to True, gets or sets a value that specifies the optional execution value that the package returns.

(Inherited from DtsContainer)
ForceExecutionResult ForceExecutionResult ForceExecutionResult

Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container.

(Inherited from DtsContainer)
ForceExecutionValue ForceExecutionValue ForceExecutionValue

Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.

(Inherited from DtsContainer)
HasExpressions HasExpressions HasExpressions

Gets a value that indicates whether the package has expressions.

ID ID ID

Returns the ID, which is a GUID, of the DtsContainer. The value is read-only.

(Inherited from DtsContainer)
IgnoreConfigurationsOnLoad IgnoreConfigurationsOnLoad IgnoreConfigurationsOnLoad

Gets or sets a value that indicates whether the package ignores configurations when the package is loaded.

InteractiveMode InteractiveMode InteractiveMode

Gets or sets a value that indicates whether the tasks should show user interface objects while executing.

IsDefaultLocaleID IsDefaultLocaleID IsDefaultLocaleID

A Boolean that indicates whether the container uses the default locale. This property is read-only.

(Inherited from DtsContainer)
IsolationLevel IsolationLevel IsolationLevel

Gets or sets the isolation level of the transaction in the DtsContainer object.

(Inherited from DtsContainer)
LocaleID LocaleID LocaleID

Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed.

(Inherited from DtsContainer)
LogEntryInfos LogEntryInfos LogEntryInfos

Returns a LogEntryInfos object. This property is read-only.

(Inherited from DtsContainer)
LoggingMode LoggingMode LoggingMode

Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container.

(Inherited from DtsContainer)
LoggingOptions LoggingOptions LoggingOptions

Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.

(Inherited from DtsContainer)
LogProviders LogProviders LogProviders

Gets the collection of log providers associated with the package.

MaxConcurrentExecutables MaxConcurrentExecutables MaxConcurrentExecutables

Gets or sets the number of threads that a package can create.

MaximumErrorCount MaximumErrorCount MaximumErrorCount

Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running.

(Inherited from DtsContainer)
Name Name Name

Gets or sets the name of the DtsContainer.

(Inherited from DtsContainer)
OfflineMode OfflineMode OfflineMode

Gets or sets a value that indicates whether the package is working in offline mode.

PackagePassword PackagePassword PackagePassword

Sets the value of the password for the package. This property is write-only.

PackagePriorityClass PackagePriorityClass PackagePriorityClass

Specifies the Win32 thread priority class of the package thread.

PackageType PackageType PackageType

Specifies a value that identifies the tool that created the package.

PackageUpgradeOptions PackageUpgradeOptions PackageUpgradeOptions

Gets or sets the upgrade options for the package.

Parameters Parameters Parameters

Gets the parameters collection for the package.

Parent Parent Parent

Returns the parent container. The value is read-only.

(Inherited from DtsContainer)
PrecedenceConstraints PrecedenceConstraints PrecedenceConstraints

Gets the collection of the PrecedenceConstraint objects. This field is read-only.

Project Project Project

Gets or sets the specified project associated with the package.

Properties Properties Properties

Gets the collection of the DtsProperties object for the package.

ProtectionLevel ProtectionLevel ProtectionLevel

Gets the level of protection on the package.

SafeRecursiveProjectPackageExecution SafeRecursiveProjectPackageExecution SafeRecursiveProjectPackageExecution

Gets or sets a value that indicates whether recursive execution of the package is safe.

SaveCheckpoints SaveCheckpoints SaveCheckpoints

Gets or sets a value that indicates whether the package will use checkpoints during package execution.

Site Site Site

Gets or sets the site for the container.

(Inherited from DtsContainer)
StartTime StartTime StartTime

Returns the time that the container began execution. This property is read-only.

(Inherited from DtsContainer)
StopTime StopTime StopTime

Returns the time that the container ended execution. This property is read-only.

(Inherited from DtsContainer)
SuppressConfigurationWarnings SuppressConfigurationWarnings SuppressConfigurationWarnings

Gets or sets a value that indicates whether the warnings generated by configurations are suppressed.

SuspendRequired SuspendRequired SuspendRequired

Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.

(Inherited from DtsContainer)
TransactionOption TransactionOption TransactionOption

Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.

(Inherited from DtsContainer)
UpdateObjects UpdateObjects UpdateObjects

\* Member deprecated; see Remarks. ***** Gets or sets a value that indicates whether the extensible objects can be updated at package load time if an updated version is found.

VariableDispenser VariableDispenser VariableDispenser

Returns a VariableDispenser object so variables associated with the container can be locked.

(Inherited from DtsContainer)
Variables Variables Variables

Returns a collection that contains the variables associated with this container. This property is read-only.

(Inherited from DtsContainer)
VersionBuild VersionBuild VersionBuild

Gets the build version of the package.

VersionComments VersionComments VersionComments

Gets the version comments associated with the package.

VersionGUID VersionGUID VersionGUID

Gets the version GUID generated when the package is first created. This field is read-only.

VersionMajor VersionMajor VersionMajor

Gets the major build version of the package.

VersionMinor VersionMinor VersionMinor

Gets the minor build version of the package.

Warnings Warnings Warnings

Gets the collection of warnings set on the package. This field is read-only.

Methods

AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager)

This method is called by the run-time engine when a task or container is created, and passes it a BreakpointManager manager to allow the task to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.

(Inherited from DtsContainer)
AddDataTapPoint(String, String, Int32, String) AddDataTapPoint(String, String, Int32, String) AddDataTapPoint(String, String, Int32, String)

Add a data tap point on a given data flow path of the given data flow task.

CheckSignature() CheckSignature() CheckSignature()

Checks the status of the digital signature of the package.

ComputeExpressions(Boolean) ComputeExpressions(Boolean) ComputeExpressions(Boolean)

Compute expressions of the package object.

Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from DtsContainer)
Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
Execute() Execute() Execute()

Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution.

Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object)

Runs the application, container, or package as part of a package workflow.

(Inherited from DtsContainer)
ExportConfigurationFile(String) ExportConfigurationFile(String) ExportConfigurationFile(String)

Creates an XML file that contains all deployable variables in the package.

FindReferencedObjects(Object) FindReferencedObjects(Object) FindReferencedObjects(Object)

Returns a reference object enumeration.

GetBreakpointTargets(IDTSBreakpointSite, Boolean) GetBreakpointTargets(IDTSBreakpointSite, Boolean) GetBreakpointTargets(IDTSBreakpointSite, Boolean)

Returns a BreakpointTargets collection. Depending on the setting of the onlyEnabled parameter, the collection contains all breakpoint targets in the package, or only enabled breakpoint targets.

GetExecutionPath() GetExecutionPath() GetExecutionPath()

Returns the execution path of the current package.

GetExpression(String) GetExpression(String) GetExpression(String)

Returns a value that contains the expression for the specified property. Null means no expression is assigned.

GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
GetObjectFromPackagePath(String, DtsProperty) GetObjectFromPackagePath(String, DtsProperty) GetObjectFromPackagePath(String, DtsProperty)

Returns a package property and the object from the specified package path.

GetPackagePath() GetPackagePath() GetPackagePath()

Returns a value that contains the relative path to the package location.

ImportConfigurationFile(String) ImportConfigurationFile(String) ImportConfigurationFile(String)

Loads a configuration file associated with the package.

LoadFromXML(String, IDTSEvents) LoadFromXML(String, IDTSEvents) LoadFromXML(String, IDTSEvents)

Loads a package and all its objects that have been saved to memory in XML format. To load a package that is saved to the hard drive, use the LoadPackage(String, IDTSEvents) method.

LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.

(Inherited from DtsContainer)
LoadUserCertificateByHash(Byte[]) LoadUserCertificateByHash(Byte[]) LoadUserCertificateByHash(Byte[])

Loads the certificate for the package according to the certificate hash.

LoadUserCertificateByName(String) LoadUserCertificateByName(String) LoadUserCertificateByName(String)

Loads the certificate for the package according to the certificate name.

ProcessConfiguration(String, Object) ProcessConfiguration(String, Object) ProcessConfiguration(String, Object)

Specifies the configuration information for a package and its objects.

RegenerateID() RegenerateID() RegenerateID()

Creates a new GUID for the package and updates the package ID property.

ResumeExecution() ResumeExecution() ResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

(Inherited from DtsContainer)
SaveToXML(String, IDTSEvents) SaveToXML(String, IDTSEvents) SaveToXML(String, IDTSEvents)

Saves the package to memory in an XML format. To save a package as .xml to the hard drive, use the SaveToXml(String, Package, IDTSEvents) method.

SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

(Inherited from DtsContainer)
SetExpression(String, String) SetExpression(String, String) SetExpression(String, String)

Assigns the specified expression to the property. Specify null to remove an existing expression from the property.

SetWrappedExecutable(IDTSExecutable100) SetWrappedExecutable(IDTSExecutable100) SetWrappedExecutable(IDTSExecutable100)

Returns the wrapped executable object.

(Inherited from EventsProvider)
SuspendExecution() SuspendExecution() SuspendExecution()

Called when the executable needs to suspend. This method is called by the runtime engine.

(Inherited from DtsContainer)
Validate(Connections, Variables, IDTSEvents, IDTSLogging) Validate(Connections, Variables, IDTSEvents, IDTSLogging) Validate(Connections, Variables, IDTSEvents, IDTSLogging)

Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.

(Inherited from DtsContainer)

Events

Disposed Disposed Disposed

Adds an event handler to listen to the Disposed event on the component.

(Inherited from DtsContainer)

Fields

m_executable m_executable m_executable

The executable.

(Inherited from Executable)

Applies to