Export (0) Print
Expand All

Package Class

Represents the package container. This class cannot be inherited.

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

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

The Package type exposes the following members.

  NameDescription
Public methodPackageInitializes a new instance of the Package class.
Top

  NameDescription
Public propertyCertificateContextGets or sets the certificate context.
Public propertyCertificateObjectGets or sets the X.509 certificate object for the package.
Public propertyCheckpointFileNameGets or sets the name of the file that captures the checkpoint information, which enables a package to restart.
Public propertyCheckpointUsageGets or sets a value that specifies if or when a package is restarted.
Public propertyCheckSignatureOnLoadGets or sets a value indicating whether the digital signature is checked when a package is loaded.
Public propertyConfigurationsGets the collection of configurations for the package. A package can have more than one configuration associated with it. This property is read-only.
Public propertyConnectionsGets the collection of connection managers for the package.
Public propertyCreationDateGets or sets the date and time that the package was created.
Public propertyCreationNameReturns the string that is used to create an instance of the DtsContainer object. This property is read-only. (Inherited from DtsContainer.)
Public propertyCreatorComputerNameGets or sets the name of the computer on which the package was created.
Public propertyCreatorNameGets or sets the name of the individual who created the package.
Public propertyDebugModeGets 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.)
Public propertyDelayValidationGets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. (Inherited from DtsContainer.)
Public propertyDescriptionGets or sets the description of the DtsContainer object. (Inherited from DtsContainer.)
Public propertyDesignEventsGets or sets an IDTSEvents that indicates if the designer or other third-party client is to receive events during design time.
Public propertyDesignTimePropertiesInfrastructure. Gets or sets the design time properties of a package such as layout information.
Public propertyDisableA Boolean that indicates if the DtsContainer object is disabled. (Inherited from DtsContainer.)
Public propertyDisableEventHandlersGets or sets a Boolean that indicates whether the event handlers on task are disabled. (Inherited from EventsProvider.)
Public propertyDumpDescriptorInfrastructure. Specify when a dump file should be generated.
Public propertyDumpOnAnyErrorInfrastructure. Specify if a dump file should be generated when any error occurs during package execution.
Public propertyEnableConfigurationsGets or sets a value that indicates whether the package loads configurations.
Public propertyEnableDumpInfrastructure. Specify if the dump file generation is enabled.
Public propertyEncryptCheckpointsGets or sets a value that indicates whether the checkpoint files are encrypted.
Public propertyErrorsGets the collection of errors associated with the package. This field is read-only.
Public propertyEventHandlersReturns a collection of event handler objects. This field is read-only. (Inherited from EventsProvider.)
Public propertyEventInfosReturns a collection of EventInfo objects. This field is read-only. (Inherited from EventsProvider.)
Public propertyExecutablesGets the collection of executable objects contained within the package that are a part of the package workflow.
Public propertyExecutionDurationReturns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. (Inherited from DtsContainer.)
Public propertyExecutionResultReturns a value that indicates the success or failure of the execution of the DtsContainer object. (Inherited from DtsContainer.)
Public propertyExecutionStatusReturns a value that indicates the current status of the execution of the DtsContainer object at the time of the call. (Inherited from DtsContainer.)
Public propertyExtendedPropertiesGets the ExtendedProperties collection for the package.
Public propertyFailPackageOnFailureGets or sets a value that indicates whether the package fails when a task or component in the package fails.
Public propertyFailParentOnFailureGets or sets a Boolean that defines whether the parent container fails when a child container fails. (Inherited from DtsContainer.)
Public propertyForcedExecutionValueIf 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.)
Public propertyForceExecutionResultGets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (Inherited from DtsContainer.)
Public propertyForceExecutionValueGets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. (Inherited from DtsContainer.)
Public propertyHasExpressionsGets a value that indicates whether the package has expressions.
Public propertyIDReturns the ID, which is a GUID, of the DtsContainer. The value is read-only. (Inherited from DtsContainer.)
Public propertyIgnoreConfigurationsOnLoadInfrastructure. Gets or sets a value that indicates whether the package ignores configurations when the package is loaded.
Public propertyInteractiveModeGets or sets a value that indicates whether the tasks should show user interface objects while executing.
Public propertyIsDefaultLocaleIDA Boolean that indicates whether the container uses the default locale. This property is read-only. (Inherited from DtsContainer.)
Public propertyIsolationLevelGets or sets the isolation level of the transaction in the DtsContainer object. (Inherited from DtsContainer.)
Public propertyLocaleIDGets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (Inherited from DtsContainer.)
Public propertyLogEntryInfosReturns a LogEntryInfos object. This property is read-only. (Inherited from DtsContainer.)
Public propertyLoggingModeGets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. (Inherited from DtsContainer.)
Public propertyLoggingOptionsReturns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. (Inherited from DtsContainer.)
Public propertyLogProvidersGets the collection of log providers associated with the package.
Public propertyMaxConcurrentExecutablesGets or sets the number of threads that a package can create.
Public propertyMaximumErrorCountGets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running. (Inherited from DtsContainer.)
Public propertyNameGets or sets the name of the DtsContainer. (Inherited from DtsContainer.)
Public propertyOfflineModeGets or sets a value that indicates whether the package is working in offline mode.
Public propertyPackagePasswordSets the value of the password for the package. This property is write-only.
Public propertyPackagePriorityClassSpecifies the Win32 thread priority class of the package thread.
Public propertyPackageTypeSpecifies a value that identifies the tool that created the package.
Public propertyPackageUpgradeOptionsGets or sets the upgrade options for the package.
Public propertyParametersGets the parameters collection for the package.
Public propertyParentReturns the parent container. The value is read-only. (Inherited from DtsContainer.)
Public propertyPrecedenceConstraintsGets the collection of the PrecedenceConstraint objects. This field is read-only.
Public propertyProjectGets or sets the specified project associated with the package.
Public propertyPropertiesGets the collection of the DtsProperties object for the package.
Public propertyProtectionLevelGets the level of protection on the package.
Public propertySafeRecursiveProjectPackageExecutionGets or sets a value that indicates whether recursive execution of the package is safe.
Public propertySaveCheckpointsGets or sets a value that indicates whether the package will use checkpoints during package execution.
Public propertySiteInfrastructure. Gets or sets the site for the container. (Inherited from DtsContainer.)
Public propertyStartTimeReturns the time that the container began execution. This property is read-only. (Inherited from DtsContainer.)
Public propertyStopTimeReturns the time that the container ended execution. This property is read-only. (Inherited from DtsContainer.)
Public propertySuppressConfigurationWarningsGets or sets a value that indicates whether the warnings generated by configurations are suppressed.
Public propertySuspendRequiredGets 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.)
Public propertyTransactionOptionGets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. (Inherited from DtsContainer.)
Public propertyUpdateObjects*** 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.
Public propertyVariableDispenserReturns a VariableDispenser object so variables associated with the container can be locked. (Inherited from DtsContainer.)
Public propertyVariablesReturns a collection that contains the variables associated with this container. This property is read-only. (Inherited from DtsContainer.)
Public propertyVersionBuildGets the build version of the package.
Public propertyVersionCommentsGets the version comments associated with the package.
Public propertyVersionGUIDGets the version GUID generated when the package is first created. This field is read-only.
Public propertyVersionMajorGets the major build version of the package.
Public propertyVersionMinorGets the minor build version of the package.
Public propertyWarningsGets the collection of warnings set on the package. This field is read-only.
Top

  NameDescription
Public methodAcceptBreakpointManagerThis 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.)
Public methodAddDataTapPointAdd a data tap point on a given data flow path of the given data flow task.
Public methodCheckSignatureChecks the status of the digital signature of the package.
Public methodComputeExpressionsInfrastructure. Compute expressions of the package object.
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DtsContainer.)
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecute()Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution.
Public methodExecute(Connections, Variables, IDTSEvents, IDTSLogging, Object)Runs the application, container, or package as part of a package workflow. (Inherited from DtsContainer.)
Public methodExportConfigurationFileCreates an XML file that contains all deployable variables in the package.
Public methodFindReferencedObjectsReturns a reference object enumeration.
Public methodGetBreakpointTargetsReturns 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.
Public methodGetExecutionPathReturns the execution path of the current package.
Public methodGetExpressionReturns a value that contains the expression for the specified property. Null means no expression is assigned.
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetObjectFromPackagePathReturns a package property and the object from the specified package path.
Public methodGetPackagePathReturns a value that contains the relative path to the package location.
Public methodGetType (Inherited from Object.)
Public methodImportConfigurationFileLoads a configuration file associated with the package.
Public methodLoadFromXML(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.)
Public methodLoadFromXML(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.
Public methodLoadUserCertificateByHashLoads the certificate for the package according to the certificate hash.
Public methodLoadUserCertificateByNameLoads the certificate for the package according to the certificate name.
Public methodProcessConfigurationSpecifies the configuration information for a package and its objects.
Public methodRegenerateIDCreates a new GUID for the package and updates the package ID property.
Public methodResumeExecutionResumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Inherited from DtsContainer.)
Public methodSaveToXML(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.
Public methodSaveToXML(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.)
Public methodSetExpressionAssigns the specified expression to the property. Specify a null reference (Nothing in Visual Basic) to remove an existing expression from the property.
Public methodSuspendExecutionCalled when the executable needs to suspend. This method is called by the runtime engine. (Inherited from DtsContainer.)
Public methodToString (Inherited from Object.)
Public methodValidateAllows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Inherited from DtsContainer.)
Top

  NameDescription
Public eventDisposedAdds an event handler to listen to the Disposed event on the component. (Inherited from DtsContainer.)
Top

  NameDescription
Protected fieldm_executableInfrastructure. The executable. (Inherited from Executable.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft