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::IDTSSequencepublic 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.IDTSSequencetype Package = class
inherit EventsProvider
interface IDTSSequence
interface IDTSPropertiesProvider
interface IDTSPropertiesProviderEx
interface IDTSPackagePath
interface IDTSExecutionPath
interface IDTSConfigurationControlPublic NotInheritable Class Package
Inherits EventsProvider
Implements IDTSConfigurationControl, IDTSExecutionPath, IDTSPackagePath, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSSequence- Наследование
- Реализации
Комментарии
Пакет представляет собой набор других контейнеров, соединений, задач, преобразований, переменных, конфигураций и ограничений по приоритету. Пакеты можно создавать программно или с помощью графического инструмента SSIS Designer. Пакеты могут сохраняться в различных местах, включая Microsoft SQL Server или XML-файл.
Для получения дополнительной информации о пакетах см. раздел Пакеты интеграционных сервисов (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 |
Получает или задаёт , |
| ForcedExecutionValue |
Если свойство ForceExecutionValue установлено в True, получает или задаёт значение, указывающее необязательное значение выполнения, возвращаемое пакетом. (Унаследовано от DtsContainer) |
| ForceExecutionResult |
Получает или устанавливает DTSForcedExecResult значение перечисления, указывающее результат принудительного выполнения контейнера. (Унаследовано от DtsContainer) |
| ForceExecutionValue |
Получает или задаёт булевое значение, указывающее, должно ли значение исполнения контейнера содержать определённое значение. (Унаследовано от DtsContainer) |
| HasExpressions |
Получает значение, указывающее, есть ли в пакете выражения. |
| ID |
Возвращает идентификатор, который является GUID, для DtsContainer. Значение доступно только для чтения. (Унаследовано от DtsContainer) |
| IgnoreConfigurationsOnLoad |
Получает или устанавливает значение, указывающее, игнорирует ли пакет конфигурации при загрузке. |
| InteractiveMode |
Получает или устанавливает значение, указывающее, должны ли задачи отображать объекты пользовательского интерфейса во время выполнения. |
| IsDefaultLocaleID |
Булевое изображение, указывающее, использует ли контейнер стандартное местоназначение. Это свойство доступно только для чтения. (Унаследовано от DtsContainer) |
| IsolationLevel |
Получает или устанавливает уровень изоляции транзакции в объекте DtsContainer . (Унаследовано от DtsContainer) |
| LocaleID |
Получает или устанавливает целое число, указывающее локальный идентификатор Microsoft Win32® для использования при выполнении 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 . В зависимости от параметра |
| 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 для пакета и обновляет свойство идентификатора пакета. |
| 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) |