Partager via


Classe Package

Represents the package container. This class cannot be inherited.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Dts.Runtime
Assembly :  Microsoft.SqlServer.ManagedDTS (en Microsoft.SqlServer.ManagedDTS.dll)

Syntaxe

'Déclaration
Public NotInheritable Class Package _
    Inherits EventsProvider _
    Implements IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath,  _
    IDTSExecutionPath, IDTSConfigurationControl
'Utilisation
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

Le type Package expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique Package Initializes a new instance of the Package class.

Haut de la page

Propriétés

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

Haut de la page

Méthodes

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

Haut de la page

Événements

  Nom Description
Événement public Disposed Adds an event handler to listen to the Disposed event on the component. (hérité de DtsContainer.)

Haut de la page

Champs

  Nom Description
Champ protégé m_executable Infrastructure. The executable. (hérité de Executable.)

Haut de la page

Notes

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 Packages Integration Services (SSIS).

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Dts.Runtime