Common Properties

 

Applies To: SQL Server 2016

The data flow objects in the Microsoft SQL Server Integration Services object model have common properties and custom properties at the component, input and output, and input column and output column levels. Many properties have read-only values that are assigned at run time by the data flow engine.

This topic lists and describes the common properties of data flow objects.

For information about customer properties, see the following topics

In the Integration Services object model, a component in the data flow implements the IDTSComponentMetaData100 interface.

The following table describes the properties of the components in a data flow. Some properties have read-only values that are assigned at run time by the data flow engine.

PropertyData TypeDescription
ComponentClassIDStringThe CLSID of the component.
ContactInfoStringContact information for the developer of a component.
DescriptionStringThe description of the data flow component. The default value of this property is the name of the data flow component.
IDIntegerA value that uniquely identifies this instance of the component.
IdentificationStringStringIdentifies the component.
IsDefaultLocaleBooleanIndicates whether the component uses the locale of the Data Flow task to which it belongs.
LocaleIDIntegerThe locale that the data flow component uses when the package runs. All Windows locales are available for use in data flow components.
NameStringThe name of the data flow component.
PipelineVersionIntegerThe version of the data flow task within which a component is designed to execute.
UsesDispositionsBooleanIndicates whether a component has an error output.
ValidateExternalMetadataBooleanIndicates whether the metadata of external columns is validated. The default value of this property is True.
VersionIntegerThe version of a component.

In the Integration Services object model, transformations and destinations have inputs. An input of a component in the data flow implements the IDTSInput100 interface.

The following table describes the properties of the inputs of components in a data flow. Some properties have read-only values that are assigned at run time by the data flow engine.

PropertyData TypeDescription
DescriptionStringThe description of the input.
ErrorOrTruncationOperationStringAn optional string that specifies the types of errors or truncations that can occur when processing a row.
ErrorRowDispositionDTSRowDispositionA value that specifies the handling of errors. The values are Fail component, Ignore failure, and Redirect row.
HasSideEffectsBooleanIndicates whether a component can be removed from the execution plan of the data flow when it is not attached to a downstream component and when RunInOptimizedMode is true.
IDIntegerA value that uniquely identifies the input.
IdentificationStringStringA string that identifies the input.
IsSortedBooleanIndicates whether the data in the input is sorted.
NameStringThe name of the input.
SourceLocaleIntegerThe locale ID (LCID) of the input data.
TruncationRowDispositionDTSRowDispositionA value that determines how the component handles truncations that occur when processing rows. . The values are Fail component, Ignore failure, and Redirect row.

Destinations and some transformations do not support error outputs, and the ErrorRowDisposition and TruncationRowDisposition properties of these components are read-only.

Input Column Properties

In the Integration Services object model, an input contains a collection of input columns. An input column of a component in the data flow implements the IDTSInputColumn100 interface.

The following table describes the properties of the input columns of components in a data flow. Some properties have read-only values that are assigned at run time by the data flow engine.

PropertyData TypeDescription
ComparisonFlagsIntegerA set of flags that specify the comparison of columns that have a character data type. For more information, see Comparing String Data.
DescriptionStringDescribes the input column.
ErrorOrTruncationOperationStringAn optional string that specifies the types of errors or truncations that can occur when processing a row.
ErrorRowDispositionDTSRowDispositionA value that specifies the handling of errors. The values are Fail component, Ignore failure, and Redirect row.
ExternalMetadataColumnIDIDTSExternalMetadataColumn100The ID of the external metadata column assigned to an input column.
IDIntegerA value that uniquely identifies the input column.
IdentificationStringStringA string that identifies the input column.
LineageIDIntegerThe ID of the upstream column.
LineageIdentificationStringStringThe identification string which includes the name of the upstream column.
NameStringThe name of the input column.
SortKeyPositionIntegerA value that indicates whether a column is sorted, its sort order, and the sequence in which multiple columns are sorted. The value 0 indicates the column is not sorted. For more information, see Sort Data for the Merge and Merge Join Transformations.
TruncationRowDispositionDTSRowDispositionA value that determines how the component handles truncations that occur when processing rows. The values are Fail component, Ignore failure, and Redirect row.
UpstreamComponentNameStringThe name of the upstream component.
UsageTypeDTSUsageTypeA value that determines how an input column is used by the component.

Input columns also have the data type properties described under "Data Type Properties."

In the Integration Services object model, sources and transformations have outputs. An output of a component in the data flow implements the IDTSOutput100 interface.

The following table describes the properties of the outputs of components in a data flow. Some properties have read-only values that are assigned at run time by the data flow engine.

PropertyData TypeDescription
DeleteOutputOnPathDetachedBooleanA value that determines whether the data flow engine deletes the output when it is detached from a path.
DescriptionStringDescribes the output.
ErrorOrTruncationOperationStringAn optional string that specifies the types of errors or truncations that can occur when processing a row.
ErrorRowDispositionDTSRowDispositionA value that specifies the handling of errors. The values are Fail component, Ignore failure, and Redirect row.
ExclusionGroupIntegerA value that identifies a group of mutually exclusive outputs.
HasSideEffectsBooleanA value that indicates whether a component can be removed from the execution plan of the data flow when it is not attached to an upstream component and when RunInOptimizedMode is true.
IDIntegerA value that uniquely identifies the output.
IdentificationStringStringA string that identifies the output.
IsErrorOutBooleanIndicates whether the output is an error output.
IsSortedBooleanIndicates whether the output is sorted. The default value is False.

 ** Important ** Setting the value of the IsSorted property to True does not sort the data. This property only provides a hint to downstream components that the data has been previously sorted. For more information, see Sort Data for the Merge and Merge Join Transformations.
NameStringThe name of the output.
SynchronousInputIDIntegerThe ID of an input that is synchronous to the output.
TruncationRowDispositionDTSRowDispositionA value that determines how the component handles truncations that occur when processing rows. The values are Fail component, Ignore failure, and Redirect row.

Output Column Properties

In the Integration Services object model, an output contains a collection of output columns. An output column of a component in the data flow implements the IDTSOutputColumn100 interface.

The following table describes the properties of the output columns of components in a data flow. Some properties have read-only values that are assigned at run time by the data flow engine.

PropertyData TypeDescription
ComparisonFlagsIntegerA set of flags that specify the comparison of columns that have a character data type. For more information, see Comparing String Data.
DescriptionStringDescribes the output column.
ErrorOrTruncationOperationStringAn optional string that specifies the types of errors or truncations that can occur when processing a row.
ErrorRowDispositionDTSRowDispositionA value that specifies the handling of errors. The values are Fail component, Ignore failure, and Redirect row. The default value is Fail component.
ExternalMetadataColumnIDIntegerThe ID of the external metadata column assigned to an input column.
IDIntegerA value that uniquely identifies the output column.
IdentificationStringStringA string that identifies the output column.
LineageIDIntegerThe ID of the output column. Downstream components refer to the column by using this value.
LineageIdentificationStringStringThe identification string which includes the name of the column.
NameStringThe name of the output column.
SortKeyPositionIntegerA value that indicates whether a column is sorted, its sort order, and the sequence in which multiple columns are sorted. The value 0 indicates the column is not sorted. For more information, see Sort Data for the Merge and Merge Join Transformations.
SpecialFlagsIntegerA value that contains the special flags of the output column.
TruncationRowDispositionDTSRowDispositionA value that determines how the component handles truncations that occur when processing rows. The values are Fail component, Ignore failure, and Redirect row. The default value is Fail component.

Output columns also include a set of data type properties.

In the Integration Services object model, inputs and outputs can contain a collection of external metadata columns. An external metadata column of a component in the data flow implements the IDTSExternalMetadataColumn100 interface.

The following table describes the properties of the external metadata columns of components in a data flow. Some properties have read-only values that are assigned at run time by the data flow engine.

PropertyData TypeDescription
DescriptionStringDescribes the external column.
IDIntegerA value that uniquely identifies the column.
IdentificationStringStringA string that identifies the column.
NameStringThe name of the external column.

External metadata columns also include a set of data type properties.

Output columns and external metadata columns include a set of data type properties. Depending on the data type of the column, properties can be read/write or read-only.

The following table describes the data type properties of output columns and external metadata columns.

PropertyData TypeDescription
CodePageIntegerSpecifies the code page for string data that is not Unicode.
DataTypeInteger (enumeration)The Integration Services data type of the column. For more information, see Integration Services Data Types.
LengthIntegerThe length, measured in characters, of a column.
PrecisionIntegerThe precision of a numeric column.
ScaleIntegerThe scale of a numeric column.

Data Flow
Transformation Custom Properties
Path Properties
Data Flow Properties that Can Be Set by Using Expressions

Community Additions

ADD
Show: