Microsoft.SqlServer.Dts.Runtime Namespace

  • Article

The Microsoft.SqlServer.Dts.Runtime namespace contains the classes and interfaces to create packages, custom tasks, and other package control flow elements.

Classes

  Class Description
Public class Application Discovers and accesses Package objects. It can also access collections and properties that contain information about the system.
Public class BatchUpgradeOptions Specifies the options that the Upgrade method will apply to a list of Integration Services packages during the upgrade process.
Public class BreakpointManager Manages all the breakpoints that are set in on a task. This class cannot be inherited.
Public class BreakpointTarget Contains information on breakpoints that are set in the package. This class cannot be inherited.
Public class BreakpointTargetEnumerator Creates a BreakpointTargetEnumerator for the BreakpointTargets collection. This class cannot be inherited.
Public class BreakpointTargets Contains a collection of BreakpointTarget objects. This class cannot be inherited.
Public class Configuration Represents a configuration class that contains information about how a package is configured. This class cannot be inherited.
Public class ConfigurationEnumerator Supports iteration over the Configurations collection. This class cannot be inherited.
Public class Configurations Represents a collection of Configuration objects. This class cannot be inherited.
Public class ConnectionEnumerator Supports iteration over the Connections collection. This class cannot be inherited.
Public class ConnectionInfo Contains information about the connections available on the computer. This class cannot be inherited.
Public class ConnectionInfoEnumerator Supports iteration over the Connections collection. This class cannot be inherited.
Public class ConnectionInfos Contains information about all the connections on the computer. The collection contains ConnectionInfo objects that provide the details about each connection. The collection is available using the Application class. This class cannot be inherited.
Public class ConnectionManager Provides the information that you must have to connect to a data source. All classes that inherit from the ConnectionManager contain the same properties and methods. The ConnectionManager class isolates the implementation details of the different connection types from the runtime. This enables the runtime to interact with each connection manager in a consistent and predictable manner. Connection managers contain a set of stock properties that all connections have in common, such as the Name, ID, Description, and ConnectionString. However, each connection type has additional properties that are specific to that connection type. These can be accessed through the Properties collection.This class cannot be inherited.
Public class ConnectionManagerBase Represents the abstract base class for connection managers.
Public class ConnectionManagerItem Represents objects for the connection manager.
Public class ConnectionManagerItems Represents the connection manager objects.
Public class Connections Contains a collection of ConnectionManager objects that are accessed through the Package object. This class cannot be inherited.
Public class DataTypeInfo Contains members that return information regarding the data type of any SQL Server Integration Services (SSIS) object for an Application. This class cannot be inherited.
Public class DataTypeInfoEnumerator Supports iteration over the DataTypeInfos collection. This class cannot be inherited.
Public class DataTypeInfos Contains a collection of DataTypeInfo objects. This class cannot be inherited.
Public class DBProviderInfo Contains information about a database provider. This class cannot be inherited.
Public class DBProviderInfoEnumerator Supports iteration over the DBProviderInfos collection. This class cannot be inherited.
Public class DBProviderInfos Contains a collection of DBProviderInfo objects. This class cannot be inherited.
Public class DefaultEvents Defines the default events that are provided by the Integration Services run-time.
Public class DtsComException The exception that Integration Services raises when a COM error occurs.
Public class DtsComponentException The exception that is thrown when an error occurs in a component.
Public class DtsConnectionAttribute Supplies design time information about a ConnectionManager object.
Public class DtsConnectionException The exception that is thrown when there is an error in a connection.
Public class DtsContainer Defines an abstract base class that implements the properties and methods used by all containers and packages.
Public class DtsConvert Provides conversion methods to convert managed Integation Services run-time objects to their native implementations and from native to managed implementations. This class cannot be inherited.
Public class DtsCouldNotCreateManagedConnectionException The exception that specifies that a managed connection could not be created. This class cannot be inherited.
Public class DtsCouldNotCreateManagedForEachEnumeratorException The exception that specifies that a managed ForEach enumerator could not be created. This class cannot be inherited.
Public class DtsEnumerator Defines an abstract base class that implements the IEnumerator methods.
Public class DtsError Contains information about an error that occurred during execution. This class cannot be inherited.
Public class DtsErrors Represents a collection of DtsError objects. This class cannot be inherited.
Public class DtsEventHandler A container on a package or other containers that holds executables to run when specific events occur. This class cannot be inherited.
Public class DtsEventHandlerEnumerator Supports iteration over the DtsEventHandlers collection. This class cannot be inherited.
Public class DtsEventHandlers Represents a collection of DtsEventHandler objects. This class cannot be inherited.
Public class DtsException Defines a generic exception class that, depending on the error code returned, creates a class specific to the type of exception that occurred.
Public class DtsExponentTooLargeException An exception class that is thrown when the X.509 certification key on a package is invalid.
Public class DtsForEachEnumeratorAttribute Supplies design-time information about a ForEachEnumerator object. This class cannot be inherited.
Public class DtsGenericException The exception that is thrown when an error occurs and the error is not handled by any other exception class.
Public class DtsInvalidBreakpointSiteException The exception that is thrown to specify that there is an invalid breakpoint. This class cannot be inherited.
Public class DtsInvalidProjectPasswordOrDataException Represents the invalid project password or data exception that this class contains during runtime.
Public class DtsInvalidProjectUserKeyOrDataException Represents the invalid project user key or data exception that this class contains.
Public class DtsLogProviderAttribute Supplies design time information about a LogProvider object.
Public class DTSManagedXmlSerializationHelper Represents the helper for the DTS managed XML serialization.
Public class DtsNoConnectionAssignedException The exception that is thrown to specify that an internal error occurred when a managed wrapper is used for a native object that is not of the correct type.
Public class DtsNoForEachEnumAssignedException The exception that is thrown to specify that an internal error occurred when a managed wrapper is used for a native object that is not of the type ForEachEnumerator.
Public class DtsNoLogProviderAssignedException The exception that is thrown to specify that an internal error occurred when a managed wrapper is used for a native object that is not of the type LogProvider.
Public class DtsNoObjectAssignedException The exception that is thrown to specify that an internal error occurred when a managed wrapper is used for a native object that is not of the correct type.
Public class DtsNotAConnectionException The exception that is thrown to specify that an internal error occurred when a managed wrapper is used for a native object that is not of the correct type.
Public class DtsNotAForEachEnumException The exception that is thrown to specify that an internal error occurred when a managed wrapper is used for a native object that is not of the type ForEachEnumerator.
Public class DtsNotALogProviderException The exception that is thrown to specify that an internal error occurred when a managed wrapper is used for a native object that is not of the type LogProvider.
Public class DtsNotAManagedEnumeratorException The exception that is thrown to specify that the enumerator is not a managed enumerator. This class cannot be inherited.
Public class DtsNoTaskAssignedException The exception that is thrown to specify that an internal error occurred when a managed wrapper is used for a native object that is not of the correct type.
Public class DtsNotATaskException The exception that is thrown to specify that an internal error occurred when a managed wrapper is used for a native object that is not of the correct type.
Public class DtsObject Defines an abstract base class that contains the members that are common to all the objects in the Microsoft.SqlServer.Dts.Runtime namespace.
Public class DtsPipelineException The exception that is thrown when an error occurs in the pipeline.
Public class DtsProperties Contains a collection of DtsProperty objects. This class cannot be inherited.
Public class DtsProperty Contains properties and methods used by several containers on their properties. This class cannot be inherited.
Public class DtsPropertyAttribute Infrastructure. Represents the DTS property attribute.
Public class DTSReadOnlyCollectionBase Defines an abstract base class that implements the common members used by all Integration Services read-only collections. It provides the abstract (MustInherit in Visual Basic) base class for a strongly typed collection.
Public class DtsRuntimeException The exception that is thrown when there is an error in the control flow.
Public class DtsScriptingException The exception that is thrown when there is an error in a script task.
Public class DtsSqlException The exception that is thrown when there is an error in a SQL Task.
Public class DtsTaskAttribute Supplies design time information about a Task object.
Public class DtsTaskException The exception that is thrown when an error occurs in a task.
Public class DtsToolsException The exception that is thrown when an error occurs in one of the tools.
Public class DtsWarning Contains the properties used when a warning occurs. This class cannot be inherited.
Public class DtsWarnings Contains a collection of DtsWarning objects. This class cannot be inherited.
Public class EmptyEnumerator Provides an empty enumerator that is returned by the Integration Services runtime when there are no elements in the collection to enumerate over.
Public class EnumReferencedObjects Infrastructure. Enumerates the referenced objects.
Public class ErrorEnumerator Supports iteration over the DtsErrors collection. This class cannot be inherited.
Public class EventInfo Contains information about an event. This class cannot be inherited.
Public class EventInfoEnumerator Supports iteration over the EventInfos collection. This class cannot be inherited.
Public class EventInfos Contains a collection of EventInfo objects. The run-time engine exposes an EventInfos collection on all containers in the package hierarchy. The collection that a task receives is a reference to EventInfos collection on the TaskHost that is wrapping the task. Other containers' EventInfos collections contain aggregated contents of their children’s EventInfos collections. This class cannot be inherited.
Public class EventsProvider Defines an abstract class that contains a collection of event handler containers and the EventInfos collection. This class routes events to those event handlers when an event is received.
Public class Executable Defines an abstract class that provides the methods that all objects that are run by the run-time engine are required to inherit and implement.
Public class ExecutableEnumerator Supports iteration over the Executables collection. This class cannot be inherited.
Public class Executables Contains a collection of Executable objects. This class cannot be inherited.
Public class ExtendedProperties Contains a collection of ExtendedProperty objects. This class cannot be inherited.
Public class ExtendedProperty This class contains members that hold additional information about a package.
Public class ExtendedPropertyEnumerator Supports iteration over the ExtendedProperties collection. This class cannot be inherited.
Public class FlatFileColumn Contains information that defines the properties of columns in a flat file source or destination data adapter. The flat file adapter is used for accessing data in flat files. This class cannot be inherited.
Public class ForEachEnumerator Enumerates over the items that the ForEachLoop is assigned to iterate over.
Public class ForEachEnumeratorHost Defines the host class for the ForEachEnumerator. This class cannot be inherited.
Public class ForEachEnumeratorInfo Contains information about the ForEachEnumerator. This class cannot be inherited.
Public class ForEachEnumeratorInfos A collection of ForEachEnumeratorInfo objects. This class cannot be inherited.
Public class ForEachEnumeratorInfosEnumerator Supports iteration over the ForEachEnumeratorInfos collection. This class cannot be inherited.
Public class ForEachEnumeratorUI Provides information for controlling the graphical user interface of the ForEachEnumerator.
Public class ForEachLoop Provides a container that defines an iterative workflow in a package using the foreach iteration statement.
Public class ForEachVariableMapping Maps each variable to the value or expression that it holds. This class cannot be inherited.
Public class ForEachVariableMappingEnumerator Supports iteration over the ForEachVariableMappings collection. This class cannot be inherited.
Public class ForEachVariableMappings Contains a collection of ForEachVariableMapping objects. This class cannot be inherited.
Public class ForLoop Provides a container that defines an iterative workflow in a package, using the for iteration statement.
Public class FtpClientConnection Downloads and uploads data files and manages directories on servers. This class cannot be inherited.
Public class HResults Contains all event messages and HRESULTs for the Integration Services runtime, pipeline, stock tasks, and stock transforms.
Public class HttpClientConnection Contains properties and methods that enable a package to access a Web server using the HTTP protocol to send or receive files. This class cannot be inherited.
Public class LogEntryInfo Contains properties that describe a log entry. This class cannot be inherited.
Public class LogEntryInfoEnumerator Supports iteration over the LogEntryInfos collection. This class cannot be inherited.
Public class LogEntryInfos Contains a collection of LogEntryInfo objects. This class cannot be inherited.
Public class LoggingOptions Contains members that regulate what information is included or excluded from logging. This class cannot be inherited.
Public class LogProvider Contains information about a log provider associated with a package. All log providers associated with a package are located in the LogProviders collection. For log providers on the computer, use the Application class and view the LogProviderInfos collection. This class cannot be inherited.
Public class LogProviderBase Defines the abstract base class for managed log providers.
Public class LogProviderEnumerator Supports iteration over the LogProviders collection. This class cannot be inherited.
Public class LogProviderInfo Provides information about the log providers found on the computer. This class cannot be inherited.
Public class LogProviderInfoEnumerator Supports a simple iteration over the LogProviderInfos collection. This class cannot be inherited.
Public class LogProviderInfos Contains a collection of LogProviderInfo objects. This class cannot be inherited.
Public class LogProviders Contains a collection of LogProvider objects associated with the package. This class cannot be inherited.
Public class ManagedForEachEnumeratorWrapper Infrastructure. Represents the wrapper for the managed For Each enumerator. This class cannot be inherited.
Public class ManagedHelper Infrastructure. Represents the managed helper.
Public class ManagedHelper.ManagedPropertyHelper Infrastructure. Represents the managed property header.
Public class ManagedWrapper Infrastructure. Represents the managed wrapper.
Public class ManagerSerializer Infrastructure. Represents the manager serializer.
Public class NameChecker Represents the name checker.
Public class ObjectReferenceTracker Provides analysis regarding the impact and consequences of deleting variables and connections from a package. This class cannot be inherited.
Public class Package Represents the package container. This class cannot be inherited.
Public class PackageInfo Contains properties that return all the information relating to a package, such as the date it was created, version numbers, and package size. This class cannot be inherited.
Public class PackageInfoEnumerator Supports iteration over the PackageInfos collection. This class cannot be inherited.
Public class PackageInfos Contains a collection of packages found in Microsoft SQL Server or the Integration Services service. This class cannot be inherited.
Public class PackageItem Contains package related information including the package and state.
Public class PackageItems Contains a collection of PackageItem objects.
Public class PackageParameterEnumerator Represents the package parameter enumerator.
Public class PackageUpgradeOptions Specifies the options to be applied when an Integration Services package is upgraded.
Public class PackageUpgradeResult Specifies the upgrade results for a package.
Public class Parameter Represents an abstract base class used by both package parameter and project parameter.
Public class ParameterInfo Represents a read only copy of the parameter information so that applications can get parameter information without having to load the whole package object.
Public class ParameterInfos Represents a collection of parameter objects.
Public class Parameters Represents a class used by both the package parameters and project parameters collection.
Public class PipelineComponentInfo Contains properties that describe a pipeline component that is currently installed on the local computer and are ready to be used in a pipeline.
Public class PipelineComponentInfoEnumerator Supports iteration over the PipelineComponentInfos collection. This class cannot be inherited.
Public class PipelineComponentInfos Contains a collection of PipelineComponentInfo objects. This class cannot be inherited.
Public class PrecedenceConstraint Specifies the properties for configuring a precedence constraint between two containers. This class cannot be inherited.
Public class PrecedenceConstraintEnumerator Supports a simple iteration over the PrecedenceConstraints collection. This class cannot be inherited.
Public class PrecedenceConstraints Contains a collection of PrecedenceConstraint objects. This class cannot be inherited.
Public class Project Represents Integration Services project which contains packages and parameters.
Public class ProjectVariablesWrapper Contains a collection of project variables wrapper.
Public class PropertyEnumerator Supports iteration over the DtsProperties collection. This class cannot be inherited.
Public class RunningPackage Provides a reference to the run-time package to use from the Integration Services service. This class cannot be inherited.
Public class RunningPackages Contains a collection of RunningPackage objects. This collection contains the list of packages that were running when the GetRunningPackages method was called, and is not updated when a new package starts or a listed package terminates. If you need a new snapshot, you should call GetRunningPackages again. This class cannot be inherited.
Public class RunningPackagesEnumerator Supports iteration over the RunningPackages collection. This class cannot be inherited.
Public class SelectedLogProviders Contains a collection of selected LogProvider objects. This class cannot be inherited.
Public class Sequence Defines a control flow that is a subset of the package control flow. Use Sequence containers to group the package into multiple separate control flows that each contain one or more tasks and containers that run within the overall package control flow. This class cannot be inherited.
Public class SsisServerExecution Represents the SSIS server execution.
Public class StorageInfo Provides information about the storage location for either the original or the upgraded Integration Services packages.
Public class Task Defines an abstract class that implements the methods and properties common to all tasks in Integration Services. 
Public class TaskHost Provides a container that encapsulates a single task. In the SSIS Designer, the TaskHost is not configured separately; instead, it is configured when you set the properties of the task it encapsulates.
Public class TaskInfo Contains information about a task installed on the local computer.
Public class TaskInfoEnumerator Supports iteration over the TaskInfo collection. This class cannot be inherited.
Public class TaskInfos Contains a collection of TaskInfo objects. This class cannot be inherited.
Public class UpgradePackageInfo Stores information about an Integration Services package that is to be upgraded.
Public class UpgradeResult Determines the result of upgrading a collection of Integration Services packages.
Public class Variable Represents a variable on a package, task, or container. This class cannot be inherited.
Public class VariableDispenser Accesses the Variables collection during package execution. This class cannot be inherited.
Public class VariableEnumerator Supports iteration over the Variables collection. This class cannot be inherited.
Public class Variables Contains a collection of Variables objects, which are accessed through several objects. This class cannot be inherited.
Public class WarningEnumerator Supports iteration over the DtsWarnings collection. This class cannot be inherited.

Structures

  Structure Description
Public structure DTSEventColumnFilter Contains a field for every column that you can put into a log entry. To select columns for writing into the log, set the field's value to true. Set the value to false for every field you do not want added to the log entry.
Public structure StatusMessage Specifies the warning and error messages that result from upgrading an Integration Services package.

Interfaces

  Interface Description
Public interface IDTSBreakpointSite Defines the interaction between the Integration Services run-time engine and the task for exposing breakpoints and for creating and managing custom breakpoints.
Public interface IDTSComponentEvents Defines an interface that provides event firing.
Public interface IDTSComponentPersist Allows properties and settings for components and tasks to be saved and loaded from the package XML.
Public interface IDTSConfigurationControl Provides a property that controls how a package loads configurations.
Public interface IDTSDowngradableObject Infrastructure. Represents the interface for the DTS downgradable object.
Public interface IDTSDumpConfiguration Represents the configuration for the dumping of Data Transformation Service interface.
Public interface IDTSEvents Defines a set of events used by the TaskHost on behalf of a task.
Public interface IDTSExecutionMetrics Defines the metrics used to track the execution of a container.
Public interface IDTSExecutionPath Represents the DTS execution path.
Public interface IDTSForEachEnumerator Provides the methods and properties for the ForEachEnumerator.
Public interface IDTSForEachEnumeratorUI Contains the members implemented by the ForEachEnumeratorUI user interface class.
Public interface IDTSInfoEvents Defines an interface that is used to fire informational, warning, and error events.
Public interface IDTSLogging Defines the logging options for a container.
Public interface IDTSManagedTask Defines an interface implemented on task classes to identify the class as a managed task.
Public interface IDTSName Defines properties commonly used by many objects in the Integration Services runtime. The common properties of named objects include a name, a creation name, an ID (GUID), and a description.
Public interface IDTSObjectHost Defines an interface that allows components to be treated as generic host objects.
Public interface IDTSPackageInternal Infrastructure. Defines an interface implemented by containers that need to have the internal property.
Public interface IDTSPackagePath Defines an interface implemented by containers that need to have the package path returned into a property.
Public interface IDTSPersist Defines an interface that enables saving and loading data.
Public interface IDTSPropertiesProvider Defines an interface, inherited by containers, that enables properties to be set by an expression, and allows an enumerable collection of properties to be associated with the container.
Public interface IDTSPropertiesProviderEx Represents the DTS properties provider expressions.
Public interface IDTSSequence Contains two collections used by containers.
Public interface IDTSSuspend Provides methods and properties that are called by the run-time engine to notify tasks to suspend execution.

Enumerations

  Enumeration Description
Public enumeration ActionOnExistType Defines the behavior that occurs when an upgrade package has the same name as an existing Integration Services package.
Public enumeration ConnectionManagerItemState Specifies the state of the connection manager item.
Public enumeration DTSBreakpointHitTest Enumerates the values for the hit count types. This class works with the BreakpointTarget class.
Public enumeration DTSCheckpointUsage Specifies values that describe if, or when, a package is restarted.
Public enumeration DTSConfigurationType Specifies the ways that a configuration for a package can be saved.
Public enumeration DTSConnectionManagerScope Specifies the DTS connection manager scope.
Public enumeration DTSEventFilterKind Describes the kind of event filter that is set on logging.
Public enumeration DTSExecResult Provides values that describe the result of a task execution.
Public enumeration DTSExecStatus Contains values that indicate the current status of task execution or a container object at the time of the call.
Public enumeration DTSExecutionLocation Infrastructure. Specifies the DTS execution location.
Public enumeration DTSFileConnectionUsageType Provides information about how a connection is used by a component client.
Public enumeration DTSForcedExecResult Specifies the execution result of a container when the container's ForceExecutionValue is set to true.
Public enumeration DTSLogEntryFrequency Provides information to assist in log planning. You pick the hint that most closely corresponds to the frequency that you expect to generate a particular log entry in your task. This enumeration property then assists users of the package when they want to set up filtering of log entries. The user can view the property, and know in advance if there will be an overwhelming number of entries of a particular type, and plan accordingly.
Public enumeration DTSLoggingMode Specifies the logging behavior of the container. The container can turn on logging, disable logging, or specify that the setting to use is the setting found on the parent container.
Public enumeration DTSObjectHostType Describes the type of container that is hosting the other task or container.
Public enumeration DTSObjectReferenceType Specifies the types of objects that the ObjectReferenceTracker class will provide impact analysis for. This enumeration is used by the EnumReferencedObjects class, which in turn is used by the Package class in its FindReferencedObjects method.
Public enumeration DTSPackageInfoFlags Describes whether a package is a folder or package. It is used for setting a valid value in the Flags property.
Public enumeration DTSPackageType Identifies the tool that created the package.
Public enumeration DTSPipelineComponentType Classifies pipeline components by category.
Public enumeration DTSPrecedenceEvalOp Indicates the evaluation operations that the precedence constraint uses.
Public enumeration DTSPriorityClass Describes the priority of a thread in a class.
Public enumeration DTSProductLevel Specifies the SQL Server product edition. 
Public enumeration DTSPropertyKind Contains values that describe the type of property.
Public enumeration DTSProtectionLevel Controls the handling of sensitive information in the package.
Public enumeration DTSProviderSubType Identifies a specific OLE DB provider. The enumeration value also identifies the data type format used by that provider when the ProviderType is OLE DB.
Public enumeration DTSProviderType Describes the kind of provider that is stored.
Public enumeration DTSServerParameterType Specifies the DTS server parameter type.
Public enumeration DTSSignatureStatus Describes the status of the digital signature.
Public enumeration DTSTransactionOption Describes transaction supportability and specifies whether a container participates in transactions.
Public enumeration NameCheckResult Specifies the result of a name check.
Public enumeration PackageItemState Specifies the state of a package item.
Public enumeration Project.AccessMode Defines the constants for read-only or read/write access to a project.
Public enumeration ProjectStorageAttributes Specifies the attributes of project storage.
Public enumeration StorageType Defines the type of storage to which upgraded Integration Services packages will be saved.
Public enumeration UpgradeResultStatus Defines the results of upgrading an Integration Services package.