Package 类
Represents the package container. This class cannot be inherited.
继承层次结构
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
命名空间: Microsoft.SqlServer.Dts.Runtime
程序集: Microsoft.SqlServer.ManagedDTS(在 Microsoft.SqlServer.ManagedDTS.dll 中)
语法
声明
Public NotInheritable Class Package _
Inherits EventsProvider _
Implements IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath
用法
Dim instance As Package
public sealed class Package : EventsProvider,
IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath
public ref class Package sealed : public EventsProvider,
IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath
[<SealedAttribute>]
type Package =
class
inherit EventsProvider
interface IDTSSequence
interface IDTSPropertiesProvider
interface IDTSPackagePath
end
public final class Package extends EventsProvider implements IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath
Package 类型公开以下成员。
属性
名称 | 说明 | |
---|---|---|
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 | Returns the collection of configurations for the package. A package can have more than one configuration associated with it. This property is read-only. | |
Connections | Returns 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. (从 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. (从 DtsContainer 继承。) | |
DelayValidation | Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. (从 DtsContainer 继承。) | |
Description | Gets or sets the description of the DtsContainer object. (从 DtsContainer 继承。) | |
DesignEvents | Gets or sets an IDTSEvents that indicates if the designer or other third-party client is to receive events during design time. | |
Disable | A Boolean that indicates if the DtsContainer object is disabled. (从 DtsContainer 继承。) | |
DisableEventHandlers | Gets or sets a Boolean that indicates whether the event handlers on task are disabled. (从 EventsProvider 继承。) | |
EnableConfigurations | Indicates whether the package loads configurations. | |
EncryptCheckpoints | Indicates if checkpoint files are encrypted. | |
Errors | Returns 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. (从 EventsProvider 继承。) | |
EventInfos | Returns a collection of EventInfo objects. This field is read-only. (从 EventsProvider 继承。) | |
Executables | Returns 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. (从 DtsContainer 继承。) | |
ExecutionResult | Returns a value that indicates the success or failure of the execution of the DtsContainer object. (从 DtsContainer 继承。) | |
ExecutionStatus | Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call. (从 DtsContainer 继承。) | |
ExtendedProperties | Returns the ExtendedProperties collection for the package. | |
FailPackageOnFailure | ||
FailParentOnFailure | Gets or sets a Boolean that defines whether the parent container fails when a child container fails. (从 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. (从 DtsContainer 继承。) | |
ForceExecutionResult | Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (从 DtsContainer 继承。) | |
ForceExecutionValue | Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. (从 DtsContainer 继承。) | |
ID | Returns the ID, which is a GUID, of the DtsContainer. The value is read-only. (从 DtsContainer 继承。) | |
InteractiveMode | Indicates if 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. (从 DtsContainer 继承。) | |
IsolationLevel | Gets or sets the isolation level of the transaction in the DtsContainer object. (从 DtsContainer 继承。) | |
LocaleID | Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (从 DtsContainer 继承。) | |
LogEntryInfos | Returns a LogEntryInfos object. This property is read-only. (从 DtsContainer 继承。) | |
LoggingMode | Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. (从 DtsContainer 继承。) | |
LoggingOptions | Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. (从 DtsContainer 继承。) | |
LogProviders | Returns 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. (从 DtsContainer 继承。) | |
Name | Gets or sets the name of the DtsContainer. (从 DtsContainer 继承。) | |
OfflineMode | Gets or sets a Boolean that indicates if 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 | Sets or returns a value that identifies the tool that created the package. | |
PackageUpgradeOptions | ||
Parent | Returns the parent container. The value is read-only. (从 DtsContainer 继承。) | |
PrecedenceConstraints | Returns the collection of PrecedenceConstraint objects. This field is read-only. | |
Properties | Returns a collection of DtsProperties for the package. | |
ProtectionLevel | Gets or sets the level of protection on the package. | |
SaveCheckpoints | Gets or sets a value that determines if the package will use checkpoints during package execution. | |
Site | 基础结构。 (从 DtsContainer 继承。) | |
StartTime | Returns the time that the container began execution. This property is read-only. (从 DtsContainer 继承。) | |
StopTime | Returns the time that the container ended execution. This property is read-only. (从 DtsContainer 继承。) | |
SuppressConfigurationWarnings | Indicates if 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. (从 DtsContainer 继承。) | |
TransactionOption | Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. (从 DtsContainer 继承。) | |
UpdateObjects | *** Member deprecated; see Remarks. *** Gets or sets a Boolean that indicates whether 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. (从 DtsContainer 继承。) | |
Variables | Returns a collection that contains the variables associated with this container. This property is read-only. (从 DtsContainer 继承。) | |
VersionBuild | Gets or sets the build version of the package. | |
VersionComments | Gets or sets the comments associated with the package. | |
VersionGUID | Returns a unique GUID generated when the package is first created. This field is read-only. | |
VersionMajor | Gets or sets the major build version of the package. | |
VersionMinor | Gets or sets the minor build version of the package. | |
Warnings | Returns a collection of warnings set on the package. This field is read-only. |
页首
方法
名称 | 说明 | |
---|---|---|
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. (从 DtsContainer 继承。) | |
CheckSignature | Checks the status of the digital signature of the package. | |
Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (从 DtsContainer 继承。) | |
Equals | Determines whether two object instances are equal. (从 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. (从 DtsContainer 继承。) | |
ExportConfigurationFile | Creates an XML file that contains all deployable variables in the package. | |
Finalize | (从 Object 继承。) | |
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. | |
GetExpression | Returns a String that contains the expression for the specified property. Null means no expression is assigned. | |
GetHashCode | Returns the hash code for this instance. (从 DtsObject 继承。) | |
GetObjectFromPackagePath | Returns a package property and the object from the specified package path. | |
GetPackagePath | Returns a String that contains the relative path to the package location. | |
GetType | (从 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. (从 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. | |
MemberwiseClone | (从 Object 继承。) | |
ProcessConfiguration | Sets 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. (从 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. (从 DtsContainer 继承。) | |
SetExpression | Assigns the specified expression to the property. Specify nullNothingnullptrunitnull 引用(在 Visual Basic 中为 Nothing) to remove an existing expression from the property. | |
SetWrappedExecutable | 基础结构。 (从 EventsProvider 继承。) | |
SuspendExecution | Called when the executable needs to suspend. This method is called by the runtime engine. (从 DtsContainer 继承。) | |
ToString | (从 Object 继承。) | |
Validate | Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (从 DtsContainer 继承。) |
页首
事件
名称 | 说明 | |
---|---|---|
Disposed | Adds an event handler to listen to the Disposed event on the component. (从 DtsContainer 继承。) |
页首
注释
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 包.
线程安全
此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。