Compartilhar via


Classe Package

Represents the package container. This class cannot be inherited.

Hierarquia de herança

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 (em Microsoft.SqlServer.ManagedDTS.dll)

Sintaxe

'Declaração
Public NotInheritable Class Package _
    Inherits EventsProvider _
    Implements IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath,  _
    IDTSExecutionPath, IDTSConfigurationControl
'Uso
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

O tipo Package expõe os membros a seguir.

Construtores

  Nome Descrição
Método público Package Initializes a new instance of the Package class.

Início

Propriedades

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

Início

Métodos

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

Início

Eventos

  Nome Descrição
Evento público Disposed Adds an event handler to listen to the Disposed event on the component. (Herdado de DtsContainer.)

Início

Campos

  Nome Descrição
Campo protegido m_executable Infraestrutura. The executable. (Herdado de Executable.)

Início

Comentários

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

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Dts.Runtime