Package Class

Article
04/26/2013

Represents the package container. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Executable
      Microsoft.SqlServer.Dts.Runtime.DtsContainer
        Microsoft.SqlServer.Dts.Runtime.EventsProvider
          Microsoft.SqlServer.Dts.Runtime.Package

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public NotInheritable Class Package _
    Inherits EventsProvider _
    Implements IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath,  _
    IDTSExecutionPath, IDTSConfigurationControl
'Usage
Dim instance As Package

public sealed class Package : EventsProvider, 
    IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath, 
    IDTSConfigurationControl

public ref class Package sealed : public EventsProvider, 
    IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath, 
    IDTSConfigurationControl

[<SealedAttribute>]
type Package =  
    class 
        inherit EventsProvider 
        interface IDTSSequence 
        interface IDTSPropertiesProvider 
        interface IDTSPropertiesProviderEx 
        interface IDTSPackagePath 
        interface IDTSExecutionPath 
        interface IDTSConfigurationControl 
    end

public final class Package extends EventsProvider implements IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath, IDTSConfigurationControl

The Package type exposes the following members.

Constructors

	Name	Description
	Package	Initializes a new instance of the Package class.

Top

Properties

	Name	Description
	CertificateContext	Gets or sets the certificate context.
	CertificateObject	Gets or sets the X.509 certificate object for the package.
	CheckpointFileName	Gets or sets the name of the file that captures the checkpoint information, which enables a package to restart.
	CheckpointUsage	Gets or sets a value that specifies if or when a package is restarted.
	CheckSignatureOnLoad	Gets or sets a value indicating whether the digital signature is checked when a package is loaded.
	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	Gets the collection of connection managers for the package.
	CreationDate	Gets or sets the date and time that the package was created.
	CreationName	Returns the string that is used to create an instance of the DtsContainer object. This property is read-only. (Inherited from DtsContainer.)
	CreatorComputerName	Gets or sets the name of the computer on which the package was created.
	CreatorName	Gets or sets the name of the individual who created the package.
	DebugMode	Gets or sets a Boolean that indicates whether the DtsContainer object is in debug mode and whether it should fire the OnBreakpointHit event while running. (Inherited from DtsContainer.)
	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	Gets or sets the description of the DtsContainer object. (Inherited from DtsContainer.)
	DesignEvents	Gets or sets an IDTSEvents that indicates if the designer or other third-party client is to receive events during design time.
	DesignTimeProperties	Infrastructure. Gets or sets the design time properties of a package such as layout information.
	Disable	A Boolean that indicates if the DtsContainer object is disabled. (Inherited from DtsContainer.)
	DisableEventHandlers	Gets or sets a Boolean that indicates whether the event handlers on task are disabled. (Inherited from EventsProvider.)
	DumpDescriptor	Infrastructure. Specify when a dump file should be generated.
	DumpOnAnyError	Infrastructure. Specify if a dump file should be generated when any error occurs during package execution.
	EnableConfigurations	Gets or sets a value that indicates whether the package loads configurations.
	EnableDump	Infrastructure. Specify if the dump file generation is enabled.
	EncryptCheckpoints	Gets or sets a value that indicates whether the checkpoint files are encrypted.
	Errors	Gets the collection of errors associated with the package. This field is read-only.
	EventHandlers	Returns a collection of event handler objects. This field is read-only. (Inherited from EventsProvider.)
	EventInfos	Returns a collection of EventInfo objects. This field is read-only. (Inherited from EventsProvider.)
	Executables	Gets the collection of executable objects contained within the package that are a part of the package workflow.
	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	Returns a value that indicates the success or failure of the execution of the DtsContainer object. (Inherited from DtsContainer.)
	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	Gets the ExtendedProperties collection for the package.
	FailPackageOnFailure	Gets or sets a value that indicates whether the package fails when a task or component in the package fails.
	FailParentOnFailure	Gets or sets a Boolean that defines whether the parent container fails when a child container fails. (Inherited from DtsContainer.)
	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	Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (Inherited from DtsContainer.)
	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	Gets a value that indicates whether the package has expressions.
	ID	Returns the ID, which is a GUID, of the DtsContainer. The value is read-only. (Inherited from DtsContainer.)
	IgnoreConfigurationsOnLoad	Infrastructure. Gets or sets a value that indicates whether the package ignores configurations when the package is loaded.
	InteractiveMode	Gets or sets a value that indicates whether the tasks should show user interface objects while executing.
	IsDefaultLocaleID	A Boolean that indicates whether the container uses the default locale. This property is read-only. (Inherited from DtsContainer.)
	IsolationLevel	Gets or sets the isolation level of the transaction in the DtsContainer object. (Inherited from DtsContainer.)
	LocaleID	Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (Inherited from DtsContainer.)
	LogEntryInfos	Returns a LogEntryInfos object. This property is read-only. (Inherited from DtsContainer.)
	LoggingMode	Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. (Inherited from DtsContainer.)
	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	Gets the collection of log providers associated with the package.
	MaxConcurrentExecutables	Gets or sets the number of threads that a package can create.
	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	Gets or sets the name of the DtsContainer. (Inherited from DtsContainer.)
	OfflineMode	Gets or sets a value that indicates whether the package is working in offline mode.
	PackagePassword	Sets the value of the password for the package. This property is write-only.
	PackagePriorityClass	Specifies the Win32 thread priority class of the package thread.
	PackageType	Specifies a value that identifies the tool that created the package.
	PackageUpgradeOptions	Gets or sets the upgrade options for the package.
	Parameters	Gets the parameters collection for the package.
	Parent	Returns the parent container. The value is read-only. (Inherited from DtsContainer.)
	PrecedenceConstraints	Gets the collection of the PrecedenceConstraint objects. This field is read-only.
	Project	Gets or sets the specified project associated with the package.
	Properties	Gets the collection of the DtsProperties object for the package.
	ProtectionLevel	Gets the level of protection on the package.
	SafeRecursiveProjectPackageExecution	Gets or sets a value that indicates whether recursive execution of the package is safe.
	SaveCheckpoints	Gets or sets a value that indicates whether the package will use checkpoints during package execution.
	Site	Infrastructure. Gets or sets the site for the container. (Inherited from DtsContainer.)
	StartTime	Returns the time that the container began execution. This property is read-only. (Inherited from DtsContainer.)
	StopTime	Returns the time that the container ended execution. This property is read-only. (Inherited from DtsContainer.)
	SuppressConfigurationWarnings	Gets or sets a value that indicates whether the warnings generated by configurations are suppressed.
	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	Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. (Inherited from DtsContainer.)
	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	Returns a VariableDispenser object so variables associated with the container can be locked. (Inherited from DtsContainer.)
	Variables	Returns a collection that contains the variables associated with this container. This property is read-only. (Inherited from DtsContainer.)
	VersionBuild	Gets the build version of the package.
	VersionComments	Gets the version comments associated with the package.
	VersionGUID	Gets the version GUID generated when the package is first created. This field is read-only.
	VersionMajor	Gets the major build version of the package.
	VersionMinor	Gets the minor build version of the package.
	Warnings	Gets the collection of warnings set on the package. This field is read-only.

Top

Methods

	Name	Description
	AcceptBreakpointManager	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	Add a data tap point on a given data flow path of the given data flow task.
	CheckSignature	Checks the status of the digital signature of the package.
	ComputeExpressions	Infrastructure. Compute expressions of the package object.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DtsContainer.)
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	Execute()	Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution.
	Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object)	Runs the application, container, or package as part of a package workflow. (Inherited from DtsContainer.)
	ExportConfigurationFile	Creates an XML file that contains all deployable variables in the package.
	FindReferencedObjects	Returns a reference object enumeration.
	GetBreakpointTargets	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	Returns the execution path of the current package.
	GetExpression	Returns a value that contains the expression for the specified property. Null means no expression is assigned.
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetObjectFromPackagePath	Returns a package property and the object from the specified package path.
	GetPackagePath	Returns a value that contains the relative path to the package location.
	GetType	(Inherited from Object.)
	ImportConfigurationFile	Loads a configuration file associated with the package.
	LoadFromXML(XmlNode, IDTSEvents)	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method. (Inherited from DtsContainer.)
	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 Application.LoadPackage method.
	LoadUserCertificateByHash	Loads the certificate for the package according to the certificate hash.
	LoadUserCertificateByName	Loads the certificate for the package according to the certificate name.
	ProcessConfiguration	Specifies the configuration information for a package and its objects.
	RegenerateID	Creates a new GUID for the package and updates the package ID property.
	ResumeExecution	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Inherited from DtsContainer.)
	SaveToXML(String%, IDTSEvents)	Saves the package to memory in an XML format. To save a package as .xml to the hard drive, use the Application.SaveToXml method.
	SaveToXML(XmlDocument%, XmlNode, IDTSEvents)	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method. (Inherited from DtsContainer.)
	SetExpression	Assigns the specified expression to the property. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property.
	SuspendExecution	Called when the executable needs to suspend. This method is called by the runtime engine. (Inherited from DtsContainer.)
	ToString	(Inherited from Object.)
	Validate	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Inherited from DtsContainer.)

Top

Events

	Name	Description
	Disposed	Adds an event handler to listen to the Disposed event on the component. (Inherited from DtsContainer.)

Top

Fields

	Name	Description
	m_executable	Infrastructure. The executable. (Inherited from Executable.)

Top

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.

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.

Share via