Freigeben über

PipelineComponent-Klasse

  • Artikel

Defines the base class that is used when developing managed data flow components.

Vererbungshierarchie

System.Object
  Microsoft.SqlServer.Dts.Pipeline.PipelineComponent
    Microsoft.SqlServer.Dts.Pipeline.ScriptComponentHost

Namespace:  Microsoft.SqlServer.Dts.Pipeline
Assembly:  Microsoft.SqlServer.PipelineHost (in Microsoft.SqlServer.PipelineHost.dll)

Syntax

'Declaration
Public Class PipelineComponent
'Usage
Dim instance As PipelineComponent

public class PipelineComponent

public ref class PipelineComponent

type PipelineComponent =  class end

public class PipelineComponent

Der PipelineComponent-Typ macht folgende Elemente verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode PipelineComponent Initializes a new instance of the PipelineComponent class.

Zum Anfang

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft BufferManager Gets the IDTSBufferManager100 of the pipeline component.
Öffentliche Eigenschaft ComponentMetaData Gets the IDTSComponentMetaData100 for a component.
Öffentliche Eigenschaft 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.
Öffentliche Eigenschaft EventInfos Gets the IDTSEventInfos100 collection of the PipelineComponent object.
Öffentliche Eigenschaft LogEntryInfos Gets an IDTSLogEntryInfos100 collection of logging events that the component has registered.
Öffentliche Eigenschaft ReferenceTracker Gets the IDTSObjectReferenceTracker100 associated with the component.
Öffentliche Eigenschaft VariableDispenser Gets the IDTSVariableDispenser100 of the data flow component.

Zum Anfang

Methoden

  Name Beschreibung
Öffentliche Methode AcquireConnections Establishes a connection to a connection manager.
Öffentliche Methode AddErrorOutput Adds an IDTSOutput100 object and marks it as an error output by setting the IsErrorOut property to true.
Geschützte MethodeStatisches Element BufferTypeToDataRecordType Returns a managed data type based on an Integration Services data type.
Öffentliche Methode Cleanup Frees resources and finishes the execution of the component.
Geschützte MethodeStatisches Element ConvertBufferDataTypeToFitManaged Gets the appropriate Integration Services DataType from managed code.
Geschützte MethodeStatisches Element DataRecordTypeToBufferType Gets the Integration Services DataType that corresponds to a managed type.
Öffentliche Methode DeleteExternalMetadataColumn Deletes the external metadata column at the specified index from the collection of external metadata columns.
Öffentliche Methode DeleteInput Deletes an IDTSInput100 object from the IDTSInputCollection100 collection.
Öffentliche Methode DeleteOutput Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection.
Öffentliche Methode DeleteOutputColumn Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection.
Öffentliche Methode DescribeRedirectedErrorCode Provides error code information for a PipelineBuffer row added to an output buffer.
Öffentliche Methode Equals (Geerbt von Object.)
Geschützte Methode Finalize (Geerbt von Object.)
Öffentliche Methode GetDependentInputs Returns a collection of the input IDs of inputs that are waiting for more data, and thus are blocking the specified input.
Öffentliche Methode GetErrorOutputInfo Returns the index and ID of the error output of the component.
Öffentliche Methode GetHashCode (Geerbt von Object.)
Öffentliche Methode GetType (Geerbt von Object.)
Geschützte MethodeStatisches Element idxOfBufferType Infrastruktur Specifies the type of the buffer index.
Geschützte MethodeStatisches Element idxOfDataRecordType Infrastruktur Specifies the type of the data record index.
Öffentliche Methode Initialize When overridden in a derived class, initializes a new instance of a custom data flow component.
Öffentliche Methode InsertExternalMetadataColumnAt Inserts a new external metadata column into the collection of external metadata columns at the specified index.
Öffentliche Methode InsertInput Adds an IDTSInput100 object to the IDTSInputCollection100.
Öffentliche Methode InsertOutput Adds a new IDTSOutput100 object
Öffentliche Methode InsertOutputColumnAt Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100.
Geschützte MethodeStatisches Element IsCompatibleNumericTypes Determines whether two numeric data types are compatible to support a conversion from one type to the other.
Öffentliche Methode IsInputReady Determines which of the inputs attached to a component are waiting for more data, and which have enough data to process and are blocked.
Öffentliche Methode MapInputColumn Establishes a relationship between an input column and a corresponding external metadata column.
Öffentliche Methode MapOutputColumn Establishes a relationship between an output column and a corresponding external metadata column.
Geschützte Methode MemberwiseClone (Geerbt von Object.)
Öffentliche Methode OnDeletingInputColumn Deletes an IDTSInputColumn100 object from the IDTSInputColumnCollection100.
Öffentliche Methode OnInputPathAttached Called when an IDTSInput100 object is connected to the component through the IDTSPath100 interface.
Öffentliche Methode OnInputPathDetached Called when an IDTSInput100 object is disconnected from the component through the IDTSPath100 interface.
Öffentliche Methode OnOutputPathAttached Called when an IDTSOutput100 object of the component is attached to a downstream component.
Öffentliche Methode PerformUpgrade Upgrades the component metadata to the version of the component installed on the local computer.
Öffentliche Methode PostExecute Called at the end of component execution, but before Cleanup.
Öffentliche Methode PreExecute Called after PrepareForExecute, and before PrimeOutput and ProcessInput.
Öffentliche Methode PrepareForExecute Called before PreExecute.
Öffentliche Methode PrimeOutput Called at run time for source components and transformation components with asynchronous outputs to let these components add rows to the output buffers.
Öffentliche Methode ProcessInput Called at run time when a PipelineBuffer from an upstream component is available to the component to let the component process the incoming rows.
Öffentliche Methode ProvideComponentProperties Called when a component is first added to the data flow task, to initialize the ComponentMetaData of the component.
Öffentliche Methode RegisterEvents When you are developing a custom data flow component, you override this method to create custom events.
Öffentliche Methode RegisterLogEntries Registers the events that the component will log.
Öffentliche Methode ReinitializeMetaData Repairs any errors identified during validation that cause the component to return VS_NEEDSNEWMETADATA at design time.
Öffentliche Methode ReleaseConnections Frees the connections established during AcquireConnections. Called at design time and run time.
Öffentliche Methode RemoveAllInputsOutputsAndCustomProperties Deletes each IDTSInput100 and IDTSOutput100 object from the component.
Öffentliche Methode SetComponentProperty Assigns a value to a IDTSCustomProperty100 of the component.
Öffentliche Methode SetExternalMetadataColumnDataTypeProperties Sets the data type properties of the specified external metadata column.
Öffentliche Methode SetExternalMetadataColumnProperty Sets an individual property of an external metadata column.
Öffentliche Methode SetInputColumnProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object.
Öffentliche Methode SetInputProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object.
Öffentliche Methode SetOutputColumnDataTypeProperties Sets the data type properties of an IDTSOutputColumn100 object.
Öffentliche Methode SetOutputColumnProperty Sets the value of an IDTSCustomProperty100 for an IDTSOutputColumn100 object.
Öffentliche Methode SetOutputProperty Sets the value of an IDTSCustomProperty100 on an IDTSOutput100 object.
Öffentliche Methode SetUsageType Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column.
Öffentliche Methode ToString (Geerbt von Object.)
Öffentliche Methode Validate Verifies that the component is correctly configured.

Zum Anfang

Felder

  Name Beschreibung
Öffentliches FeldStatisches Element s_STOCKPROPNAME_COMPFLAGS Contains the name of the ComparisonFlags property of data flow components.
Öffentliches FeldStatisches Element s_STOCKPROPNAME_DELOUTPUTONPATHDETACHED Contains the name of the DeleteOutputOnPathDetached property of data flow components.
Öffentliches FeldStatisches Element s_STOCKPROPNAME_EXCLGROUP Contains the name of the ExclusionGroup property of data flow components.
Öffentliches FeldStatisches Element s_STOCKPROPNAME_HASSIDEEFFECTS Contains the name of the HasSideEffects property of data flow components.
Öffentliches FeldStatisches Element s_STOCKPROPNAME_ISDISTRIBUTABLE Contains the name of the IsDistributable property of data flow components.
Öffentliches FeldStatisches Element s_STOCKPROPNAME_ISERROROUT Contains the name of the IsErrorOut property of data flow components.
Öffentliches FeldStatisches Element s_STOCKPROPNAME_ISSORTED Contains the name of the IsSorted property of data flow components.
Öffentliches FeldStatisches Element s_STOCKPROPNAME_REFMETADATAID Contains the name of the ReferenceMetaDataID property of data flow components.
Öffentliches FeldStatisches Element s_STOCKPROPNAME_SORTKEYPOS Contains the name of the SortKeyPosition property of data flow components.
Öffentliches FeldStatisches Element s_STOCKPROPNAME_SYNCINPUTID Contains the name of the SynchronousInputID property of data flow components.

Zum Anfang

Hinweise

Inherit from this class to create your own data flow component. This class implements the required component interfaces, IDTSDesigntimeComponent100 and IDTSRuntimeComponent100. You override the base class implementation of these methods to provide the functionality of your component. PipelineComponent provides helper methods in addition to the methods of the component interfaces to help you in developing your component.

Beispiele

The following code example shows a component that implements the DtsPipelineComponentAttribute and inherits from the PipelineComponent class.

using System;
using Microsoft.SqlServer.Dts.Pipeline.Wrapper;
namespace Microsoft.Samples.SqlServer.Dts
{
    [DtsPipelineComponent(DisplayName="SampleComponent")]
    public class SampleComponent : PipelineComponent
    {
        public override ProvideComponentProperties()
        {
            // TODO: Implement component intialization.
        }
        public override DTSValidationStatus Validate()
        {
            // TODO: Implement component validation.
        }
        public override void ProcessInput( int inputID, PipelineBuffer buffer)
        {
            // TODO: For transformation and destination components,
            //  implement code to process incoming rows.
        }
    }
}

Imports System 
Imports Microsoft.SqlServer.Dts.Pipeline.Wrapper 
Namespace Microsoft.Samples.SqlServer.Dts 

 <DtsPipelineComponent(DisplayName="SampleComponent")> _ 
 Public Class SampleComponent 
 Inherits PipelineComponent 

   Public Overrides Sub ProvideComponentProperties() 
    ' TODO: Implement component intialization.
   End Sub 

   Public Overrides Function Validate() As DTSValidationStatus 
    ' TODO: Implement component validation.
   End Function 

   Public Overrides Sub ProcessInput(ByVal inputID As Integer, ByVal buffer As PipelineBuffer) 
    ' TODO: For transformation and destination components,
    '  implement code to process incoming rows.
   End Sub 
 End Class 
End Namespace

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.

Siehe auch

Verweis

Microsoft.SqlServer.Dts.Pipeline-Namespace