PipelineComponentExt Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Important
This API is not CLS-compliant.
public ref class PipelineComponentExt abstract : Microsoft::SqlServer::Dts::Pipeline::PipelineComponent[System.CLSCompliant(false)]
public abstract class PipelineComponentExt : Microsoft.SqlServer.Dts.Pipeline.PipelineComponent[<System.CLSCompliant(false)>]
type PipelineComponentExt = class
inherit PipelineComponentPublic MustInherit Class PipelineComponentExt
Inherits PipelineComponent- Inheritance
- Derived
- Attributes
Constructors
| PipelineComponentExt() |
Properties
| BufferManager |
Gets the IDTSBufferManager100 of the pipeline component. (Inherited from PipelineComponent) |
| ComponentMetaData |
Gets the IDTSComponentMetaData100 for a component. (Inherited from PipelineComponent) |
| ErrorSupport |
Returns an ErrorSupport object that lets the component raise errors, warnings, or other information events based on HRESULTs returned by Integration Services components written in native code. (Inherited from PipelineComponent) |
| EventInfos |
Gets the IDTSEventInfos100 collection of the PipelineComponent object. (Inherited from PipelineComponent) |
| LogEntryInfos |
Gets an IDTSLogEntryInfos100 collection of logging events that the component has registered. (Inherited from PipelineComponent) |
| ReferenceTracker |
Gets the IDTSObjectReferenceTracker100 associated with the component. (Inherited from PipelineComponent) |
| VariableDispenser |
Gets the IDTSVariableDispenser100 of the data flow component. (Inherited from PipelineComponent) |
Methods
| AcquireConnections(Object) |
Establishes a connection to a connection manager. (Inherited from PipelineComponent) |
| AddErrorOutput(String, Int32, Int32) |
Adds an IDTSOutput100 object and marks it as an error output by setting the IsErrorOut property to true. (Inherited from PipelineComponent) |
| Cleanup() |
Frees resources and finishes the execution of the component. (Inherited from PipelineComponent) |
| ConvertDataRecordTypeToBufferType(Type) | |
| CreateColumnInfoFromDtsType(String, DataType, DataRow) | |
| CreateColumnsFromSchemaTable(DataTable, IDTSOutput100, IDTSOutput100) | |
| CreateComponentProperty(String, String, Object, Boolean) |
Adds a new property to the component |
| CreateExternalMetadataColumn(IDTSExternalMetadataColumnCollection100, ColumnInformation) | |
| CreateOutput(String) | |
| CreateOutputColumn(IDTSOutput100, ColumnInformation) | |
| CreateOutputColumns(IEnumerable<ColumnInformation>, IDTSOutput100) | |
| DeleteExternalMetadataColumn(Int32, Int32) |
Deletes the external metadata column at the specified index from the collection of external metadata columns. (Inherited from PipelineComponent) |
| DeleteInput(Int32) |
Deletes an IDTSInput100 object from the IDTSInputCollection100 collection. (Inherited from PipelineComponent) |
| DeleteOutput(Int32) |
Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection. (Inherited from PipelineComponent) |
| DeleteOutputColumn(Int32, Int32) |
Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection. (Inherited from PipelineComponent) |
| DescribeRedirectedErrorCode(Int32) |
Provides error code information for a PipelineBuffer row added to an output buffer. (Inherited from PipelineComponent) |
| GetComponentVersion() | |
| GetDependentInputs(Int32) |
Returns a collection of the input IDs of inputs that are waiting for more data, and thus are blocking the specified input. (Inherited from PipelineComponent) |
| GetErrorOutputInfo(Int32, Int32) |
Returns the index and ID of the error output of the component. (Inherited from PipelineComponent) |
| GetMetadataValuesFromRow(DataRow) | |
| GetPropertyValue<T>(String) | |
| Initialize() |
When overridden in a derived class, initializes a new instance of a custom data flow component. (Inherited from PipelineComponent) |
| InsertExternalMetadataColumnAt(Int32, Int32, String, String) |
Inserts a new external metadata column into the collection of external metadata columns at the specified index. (Inherited from PipelineComponent) |
| InsertInput(DTSInsertPlacement, Int32) |
Adds an IDTSInput100 object to the IDTSInputCollection100. (Inherited from PipelineComponent) |
| InsertOutput(DTSInsertPlacement, Int32) |
Adds a new IDTSOutput100 object (Inherited from PipelineComponent) |
| InsertOutputColumnAt(Int32, Int32, String, String) |
Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100. (Inherited from PipelineComponent) |
| IsInputReady(Int32[], Boolean[]) |
Determines which of the inputs attached to a component are waiting for more data, and which have enough data to process and are blocked. (Inherited from PipelineComponent) |
| MapInputColumn(Int32, Int32, Int32) |
Establishes a relationship between an input column and a corresponding external metadata column. (Inherited from PipelineComponent) |
| MapOutputColumn(Int32, Int32, Int32, Boolean) |
Establishes a relationship between an output column and a corresponding external metadata column. (Inherited from PipelineComponent) |
| OnDeletingInputColumn(Int32, Int32) |
Deletes an IDTSInputColumn100 object from the IDTSInputColumnCollection100. (Inherited from PipelineComponent) |
| OnInputPathAttached(Int32) |
Called when an IDTSInput100 object is connected to the component through the IDTSPath100 interface. (Inherited from PipelineComponent) |
| OnInputPathDetached(Int32) |
Called when an IDTSInput100 object is disconnected from the component through the IDTSPath100 interface. (Inherited from PipelineComponent) |
| OnOutputPathAttached(Int32) |
Called when an IDTSOutput100 object of the component is attached to a downstream component. (Inherited from PipelineComponent) |
| PerformDowngrade(Int32, DTSTargetServerVersion) |
By default PerformDowngrade should not throw ComponentDowngradeFailedException because runtime can only determine whether to call this method by targetServerVersion; it cannot check component version because it doesn't know whether the component version has been changed between two SSIS versions, while the method PerformUpgrade will check if the component version in package xml is smaller than current component version before being called. (Inherited from PipelineComponent) |
| PerformUpgrade(Int32) |
Upgrades the component metadata to the version of the component installed on the local computer. (Inherited from PipelineComponent) |
| PostDiagnostic(String) | |
| PostError(Exception) | |
| PostError(Int32, Object[]) | |
| PostError(String, Object[]) | |
| PostExecute() |
Called at the end of component execution, but before Cleanup(). (Inherited from PipelineComponent) |
| PostWarning(String, Object[]) | |
| PreExecute() |
Called after PrepareForExecute(), and before PrimeOutput(Int32, Int32[], PipelineBuffer[]) and ProcessInput(Int32, PipelineBuffer). (Inherited from PipelineComponent) |
| PrepareForExecute() |
Called before PreExecute(). (Inherited from PipelineComponent) |
| PrimeOutput(Int32, Int32[], PipelineBuffer[]) |
Called at run time for source components and transformation components with asynchronous outputs to let these components add rows to the output buffers. (Inherited from PipelineComponent) |
| ProcessInput(Int32, PipelineBuffer) |
Called at run time when a PipelineBuffer from an upstream component is available to the component to let the component process the incoming rows. (Inherited from PipelineComponent) |
| ProvideComponentProperties() |
Called when a component is first added to the data flow task, to initialize the ComponentMetaData of the component. (Inherited from PipelineComponent) |
| RegisterEvents() |
When you are developing a custom data flow component, you override this method to create custom events. (Inherited from PipelineComponent) |
| RegisterLogEntries() |
Registers the events that the component will log. (Inherited from PipelineComponent) |
| ReinitializeMetaData() |
Repairs any errors identified during validation that cause the component to return VS_NEEDSNEWMETADATA at design time. (Inherited from PipelineComponent) |
| ReleaseConnections() |
Frees the connections established during AcquireConnections(Object). Called at design time and run time. (Inherited from PipelineComponent) |
| RemoveAllInputsOutputsAndCustomProperties() |
Deletes each IDTSInput100 and IDTSOutput100 object from the component. (Inherited from PipelineComponent) |
| SetComponentProperty(String, Object) |
Assigns a value to a IDTSCustomProperty100 of the component. (Inherited from PipelineComponent) |
| SetExternalMetadataColumnDataTypeProperties(Int32, Int32, DataType, Int32, Int32, Int32, Int32) |
Sets the data type properties of the specified external metadata column. (Inherited from PipelineComponent) |
| SetExternalMetadataColumnProperty(Int32, Int32, String, Object) |
Sets an individual property of an external metadata column. (Inherited from PipelineComponent) |
| SetInputColumnProperty(Int32, Int32, String, Object) |
Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object. (Inherited from PipelineComponent) |
| SetInputProperty(Int32, String, Object) |
Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object. (Inherited from PipelineComponent) |
| SetOutputColumnDataTypeProperties(Int32, Int32, DataType, Int32, Int32, Int32, Int32) |
Sets the data type properties of an IDTSOutputColumn100 object. (Inherited from PipelineComponent) |
| SetOutputColumnProperty(Int32, Int32, String, Object) |
Sets the value of an IDTSCustomProperty100 for an IDTSOutputColumn100 object. (Inherited from PipelineComponent) |
| SetOutputProperty(Int32, String, Object) |
Sets the value of an IDTSCustomProperty100 on an IDTSOutput100 object. (Inherited from PipelineComponent) |
| SetUsageType(Int32, IDTSVirtualInput100, Int32, DTSUsageType) |
Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column. (Inherited from PipelineComponent) |
| Transfer(PipelineBuffer, IDataReader, Int32, MappedColumnInfo) | |
| Validate() |
Verifies that the component is correctly configured. (Inherited from PipelineComponent) |
| ValidateExternalMetadata(DataTable, IDTSOutput100) | |