Package 类

定义

表示包容器。 此类不能被继承。

public ref class Package sealed : Microsoft::SqlServer::Dts::Runtime::EventsProvider, Microsoft::SqlServer::Dts::Runtime::IDTSConfigurationControl, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProviderEx, Microsoft::SqlServer::Dts::Runtime::IDTSSequence
public sealed class Package : Microsoft.SqlServer.Dts.Runtime.EventsProvider, Microsoft.SqlServer.Dts.Runtime.IDTSConfigurationControl, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProviderEx, Microsoft.SqlServer.Dts.Runtime.IDTSSequence
type Package = class
    inherit EventsProvider
    interface IDTSSequence
    interface IDTSPropertiesProvider
    interface IDTSPropertiesProviderEx
    interface IDTSPackagePath
    interface IDTSExecutionPath
    interface IDTSConfigurationControl
Public NotInheritable Class Package
Inherits EventsProvider
Implements IDTSConfigurationControl, IDTSExecutionPath, IDTSPackagePath, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSSequence
继承
实现

注解

包是其他容器、连接、任务、转换、变量、配置和优先约束的集合。 可以通过编程方式或使用 SSIS 设计器图形工具创建包。 可以将包保存到不同的位置,包括 Microsoft SQL Server 或 XML 文件。

有关包的详细信息,请参阅 Integration Services (SSIS) 包

构造函数

Package()

初始化 Package 类的新实例。

字段

m_executable

可执行文件。

(继承自 Executable)

属性

CertificateContext

获取或设置包的 X.509 证书对象。

CertificateObject

获取或设置包的 X.509 证书对象。

CheckpointFileName

获取或设置用于捕获使包可以重新启动的检查点信息的文件的名称。

CheckpointUsage

获取或设置一个值,该值指定是否重新启动包或重新启动的时间。

CheckSignatureOnLoad

获取或设置一个值,该值指示在加载包时是否检查数字签名。

Configurations

获取包的配置集合。 一个包可以有与之关联的多个配置。 此属性是只读的。

Connections

获取包的连接管理器集合。

CreationDate

获取或设置创建包的日期和时间。

CreationName

返回用于创建 DtsContainer 对象实例的字符串。 此属性是只读的。

(继承自 DtsContainer)
CreatorComputerName

获取或设置创建包的计算机的名称。

CreatorName

获取或设置创建包的用户的名称。

DebugMode

获取或设置一个布尔值,该值指示 DtsContainer 对象是否处于调试模式,以及在运行时是否应激发 OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) 事件。

(继承自 DtsContainer)
DelayValidation

获取或设置一个布尔值,该值指示是否将任务的验证推迟到运行时。 默认值是 False。

(继承自 DtsContainer)
Description

获取或设置 DtsContainer 对象的说明。

(继承自 DtsContainer)
DesignEvents

获取或设置一个 IDTSEvents,该值指示在设计时设计器或其他第三方客户端是否要接收事件。

DesignTimeProperties

获取或设置包的设计时属性,例如布局信息。

Disable

指示是否禁用对象的布尔值 DtsContainer

(继承自 DtsContainer)
DisableEventHandlers

获取或设置一个布尔值,该值指示是否禁用任务的事件处理程序。

(继承自 EventsProvider)
DumpDescriptor

指定何时应生成转储文件。

DumpOnAnyError

指定在包执行过程中发生任何错误时是否应生成一个转储文件。

EnableConfigurations

获取或设置一个值,该值指示包是否加载配置。

EnableDump

指定是否启用转储文件生成。

EncryptCheckpoints

获取或设置一个值,该值指示是否对检查点文件加密。

Errors

获取与包关联的错误的集合。 此字段为只读。

EventHandlers

返回事件处理程序对象的集合。 此字段为只读。

(继承自 EventsProvider)
EventInfos

返回 EventInfo 对象的集合。 此字段为只读。

(继承自 EventsProvider)
Executables

获取包内包含的作为包工作流一部分的可执行对象的集合。

ExecutionDuration

返回一个值,该值指示在容器中执行所需的时间(毫秒)。 此属性是只读的。

(继承自 DtsContainer)
ExecutionResult

返回指示 DtsContainer 对象执行是成功还是失败的值。

(继承自 DtsContainer)
ExecutionStatus

返回指示在调用时 DtsContainer 对象执行的当前状态的值。

(继承自 DtsContainer)
ExtendedProperties

获取包的 ExtendedProperties 集合。

FailPackageOnFailure

获取或设置一个值,该值指示在包中的任务或组件失败时包是否失败。

FailParentOnFailure

获取或设置一个Boolean,该值定义在子容器失败时父容器是否失败。

(继承自 DtsContainer)
ForcedExecutionValue

如果将 ForceExecutionValue 属性设置为 True,则获取或设置一个值,该值指定包返回的可选执行值。

(继承自 DtsContainer)
ForceExecutionResult

获取或设置一个 DTSForcedExecResult 枚举值,该值指定容器的强制执行结果。

(继承自 DtsContainer)
ForceExecutionValue

获取或设置一个布尔值,该值指示容器的执行值是否应强制包含特定值。

(继承自 DtsContainer)
HasExpressions

获取一个值,该值指示包是否具有表达式。

ID

返回 ID,它是 DtsContainer 的 GUID。 该值为只读的。

(继承自 DtsContainer)
IgnoreConfigurationsOnLoad

获取或设置一个值,该值指示在加载包时该包是否忽略配置。

InteractiveMode

获取或设置一个值,该值指示任务在执行时是否应显示用户界面对象。

IsDefaultLocaleID

一个布尔值,该值指示容器是否使用默认区域设置。 此属性是只读的。

(继承自 DtsContainer)
IsolationLevel

获取或设置 DtsContainer 对象中事务的隔离级别。

(继承自 DtsContainer)
LocaleID

获取或设置一个整数,该整数指示在执行对象时要使用的 Microsoft Win32® localeID DtsContainer

(继承自 DtsContainer)
LogEntryInfos

返回一个 LogEntryInfos 对象。 此属性为只读。

(继承自 DtsContainer)
LoggingMode

获取或设置 DTSLoggingMode 枚举中的一个有效值,该值指示容器的日志记录模式。

(继承自 DtsContainer)
LoggingOptions

返回一个对象,该对象包含指示容器的筛选和日志记录资源的属性。 此属性是只读的。

(继承自 DtsContainer)
LogProviders

获取与包关联的日志提供程序的集合。

MaxConcurrentExecutables

获取或设置包可以创建的线程数。

MaximumErrorCount

获取或设置一个整数值,该值指示在对象停止运行之前可以发生的最大错误数 DtsContainer

(继承自 DtsContainer)
Name

获取或设置 DtsContainer 的名称。

(继承自 DtsContainer)
OfflineMode

获取或设置一个值,该值指示包是否在脱机模式下工作。

PackagePassword

设置包的密码值。 此属性是只写的。

PackagePriorityClass

指定包线程的 Win32 线程优先级类。

PackageType

指定一个值,该值标识创建包的工具。

PackageUpgradeOptions

获取或设置包的更新选项。

Parameters

获取包的参数集合。

Parent

返回父容器。 该值为只读的。

(继承自 DtsContainer)
PrecedenceConstraints

获取 PrecedenceConstraint 对象的集合。 此字段为只读。

Project

获取或设置与包关联的指定项目。

Properties

获取包的 DtsProperties 对象的集合。

ProtectionLevel

获取包的保护级别。

SafeRecursiveProjectPackageExecution

获取或设置一个值,该值指示包的递归执行是否安全。

SaveCheckpoints

获取或设置一个值,该值指示在包执行期间包是否使用检查点。

Site

获取或设置容器的站点。

(继承自 DtsContainer)
StartTime

返回容器开始执行的时间。 此属性是只读的。

(继承自 DtsContainer)
StopTime

返回容器结束执行的时间。 此属性是只读的。

(继承自 DtsContainer)
SuppressConfigurationWarnings

获取或设置一个值,该值指示是否取消配置生成的警告。

SuspendRequired

获取或设置一个布尔值,该值指示在遇到断点时任务是否应挂起。 遇到断点时,将由任务和容器的运行时引擎设置此值。

(继承自 DtsContainer)
TransactionOption

获取或设置一个 DTSTransactionOption 枚举值,该值指示容器是否参与事务。

(继承自 DtsContainer)
UpdateObjects

*_  成员已弃用; 请参阅 "备注"。 _ _ 获取或设置一个值,该值指示在找到更新的版本时,是否可以在加载包时更新可扩展对象。

VariableDispenser

返回一个 VariableDispenser 对象,以便可以锁定与容器关联的变量。

(继承自 DtsContainer)
Variables

返回一个集合,其中包含与此容器关联的变量。 此属性是只读的。

(继承自 DtsContainer)
VersionBuild

获取包的内部版本号。

VersionComments

获取与包关联的版本注释。

VersionGUID

获取第一次创建包时生成的版本 GUID。 此字段为只读。

VersionMajor

获取包的主内部版本号。

VersionMinor

获取包的次内部版本号。

Warnings

获取为包设置的警告集合。 此字段为只读。

方法

AcceptBreakpointManager(BreakpointManager)

在创建任务或容器时由运行时引擎调用此方法,并且为其传递 BreakpointManager 管理器,以便使任务能够创建、删除和检查断点的状态。 此方法由运行时调用,在代码中未使用。

(继承自 DtsContainer)
AddDataTapPoint(String, String, Int32, String)

为给定数据流和给定数据流路径添加数据分流点。

CheckSignature()

检查包的数字签名的状态。

ComputeExpressions(Boolean)

包对象的计算表达式。

Dispose()

执行与释放或重置非托管资源关联的应用程序定义的任务。

(继承自 DtsContainer)
Equals(Object)

确定两个对象实例是否相等。

(继承自 DtsObject)
Execute()

返回一个 DTSExecResult 枚举,其中包含有关包执行成功与否的信息。

Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object)

将应用程序、容器或包作为包工作流的一部分运行。

(继承自 DtsContainer)
ExportConfigurationFile(String)

创建包含包中所有可部署的变量的 XML 文件。

FindReferencedObjects(Object)

返回引用对象枚举。

GetBreakpointTargets(IDTSBreakpointSite, Boolean)

返回 BreakpointTargets 集合。 根据 onlyEnabled 参数的设置,该集合包含包中的所有断点目标或仅包含启用的断点目标。

GetExecutionPath()

返回当前包的执行路径。

GetExpression(String)

返回一个值,该值包含指定的属性的表达式。 Null 表示不分配表达式。

GetHashCode()

返回此实例的哈希代码。

(继承自 DtsObject)
GetObjectFromPackagePath(String, DtsProperty)

从指定的包路径返回包属性和对象。

GetPackagePath()

返回一个值,该值包含包位置的相对路径。

ImportConfigurationFile(String)

加载与包关联的配置文件。

LoadFromXML(String, IDTSEvents)

加载包及其已在内存中以 XML 格式保存的所有对象。 若要将保存的包加载到硬盘,请使用 LoadPackage(String, IDTSEvents) 方法。

LoadFromXML(XmlNode, IDTSEvents)

此方法不能由应用程序代码调用。 若要加载保存为 .xml 的包,请使用 LoadPackage(String, IDTSEvents) 方法。

(继承自 DtsContainer)
LoadUserCertificateByHash(Byte[])

根据证书哈希加载包的证书。

LoadUserCertificateByName(String)

根据证书名称加载包的证书。

ProcessConfiguration(String, Object)

为包及其对象指定配置信息。

RegenerateID()

为包创建新的 GUID 并更新包 ID 属性。

ResumeExecution()

暂停后恢复执行任务。 由运行时引擎恢复任务或容器。

(继承自 DtsContainer)
SaveToXML(String, IDTSEvents)

以 XML 格式将包保存到内存中。 若要将包以 .xml 保存到硬盘,请使用 SaveToXml(String, Package, IDTSEvents) 方法。

SaveToXML(XmlDocument, XmlNode, IDTSEvents)

此方法不能由应用程序代码调用。 若将包保存为 .xml,请使用 SaveToXml(String, Package, IDTSEvents) 方法。

(继承自 DtsContainer)
SetExpression(String, String)

将指定的表达式分配给属性。 指定 null 将从属性中删除现有表达式。

SetWrappedExecutable(IDTSExecutable100)

返回包装的可执行对象。

(继承自 EventsProvider)
SuspendExecution()

可执行文件需要挂起时调用。 运行时引擎调用此方法。

(继承自 DtsContainer)
Validate(Connections, Variables, IDTSEvents, IDTSLogging)

允许容器确定它是否包含阻止其成功执行的无效设置。

(继承自 DtsContainer)

事件

Disposed

添加用于侦听组件的 Disposed 事件的事件处理程序。

(继承自 DtsContainer)

适用于