Freigeben über


Package-Klasse

Represents the package container. This class cannot be inherited.

Vererbungshierarchie

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

Der Package-Typ macht folgende Elemente verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode Package Initializes a new instance of the Package class.

Zum Anfang

Eigenschaften

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

Zum Anfang

Methoden

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

Zum Anfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis Disposed Adds an event handler to listen to the Disposed event on the component. (Geerbt von DtsContainer.)

Zum Anfang

Felder

  Name Beschreibung
Geschütztes Feld m_executable Infrastruktur The executable. (Geerbt von Executable.)

Zum Anfang

Hinweise

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-Pakete (SSIS).

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.

Siehe auch

Verweis

Microsoft.SqlServer.Dts.Runtime-Namespace