Поделиться через

Класс PipelineComponent

  • Статья

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

Иерархия наследования

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

Пространство имен:  Microsoft.SqlServer.Dts.Pipeline
Сборка:  Microsoft.SqlServer.PipelineHost (в Microsoft.SqlServer.PipelineHost.dll)

Синтаксис

'Декларация
Public Class PipelineComponent
'Применение
Dim instance As PipelineComponent

public class PipelineComponent

public ref class PipelineComponent

type PipelineComponent =  class end

public class PipelineComponent

Тип PipelineComponent обеспечивает доступ к следующим элементам.

Конструкторы

  Имя Описание
Открытый метод PipelineComponent Initializes a new instance of the PipelineComponent class.

В начало

Свойства

  Имя Описание
Открытое свойство BufferManager Gets the IDTSBufferManager100 of the pipeline component.
Открытое свойство ComponentMetaData Gets the IDTSComponentMetaData100 for a component.
Открытое свойство 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.
Открытое свойство EventInfos Gets the IDTSEventInfos100 collection of the PipelineComponent object.
Открытое свойство LogEntryInfos Gets an IDTSLogEntryInfos100 collection of logging events that the component has registered.
Открытое свойство ReferenceTracker Gets the IDTSObjectReferenceTracker100 associated with the component.
Открытое свойство VariableDispenser Gets the IDTSVariableDispenser100 of the data flow component.

В начало

Методы

  Имя Описание
Открытый метод AcquireConnections Establishes a connection to a connection manager.
Открытый метод AddErrorOutput Adds an IDTSOutput100 object and marks it as an error output by setting the IsErrorOut property to true.
Защищенный методСтатический элемент BufferTypeToDataRecordType Returns a managed data type based on an Службы Integration Services data type.
Открытый метод Cleanup Frees resources and finishes the execution of the component.
Защищенный методСтатический элемент ConvertBufferDataTypeToFitManaged Gets the appropriate Службы Integration Services DataType from managed code.
Защищенный методСтатический элемент DataRecordTypeToBufferType Gets the Службы Integration Services DataType that corresponds to a managed type.
Открытый метод DeleteExternalMetadataColumn Deletes the external metadata column at the specified index from the collection of external metadata columns.
Открытый метод DeleteInput Deletes an IDTSInput100 object from the IDTSInputCollection100 collection.
Открытый метод DeleteOutput Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection.
Открытый метод DeleteOutputColumn Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection.
Открытый метод DescribeRedirectedErrorCode Provides error code information for a PipelineBuffer row added to an output buffer.
Открытый метод Equals (Производный от Object.)
Защищенный метод Finalize (Производный от Object.)
Открытый метод GetDependentInputs Returns a collection of the input IDs of inputs that are waiting for more data, and thus are blocking the specified input.
Открытый метод GetErrorOutputInfo Returns the index and ID of the error output of the component.
Открытый метод GetHashCode (Производный от Object.)
Открытый метод GetType (Производный от Object.)
Защищенный методСтатический элемент idxOfBufferType Инфраструктура. Specifies the type of the buffer index.
Защищенный методСтатический элемент idxOfDataRecordType Инфраструктура. Specifies the type of the data record index.
Открытый метод Initialize When overridden in a derived class, initializes a new instance of a custom data flow component.
Открытый метод InsertExternalMetadataColumnAt Inserts a new external metadata column into the collection of external metadata columns at the specified index.
Открытый метод InsertInput Adds an IDTSInput100 object to the IDTSInputCollection100.
Открытый метод InsertOutput Adds a new IDTSOutput100 object
Открытый метод InsertOutputColumnAt Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100.
Защищенный методСтатический элемент IsCompatibleNumericTypes Determines whether two numeric data types are compatible to support a conversion from one type to the other.
Открытый метод 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.
Открытый метод MapInputColumn Establishes a relationship between an input column and a corresponding external metadata column.
Открытый метод MapOutputColumn Establishes a relationship between an output column and a corresponding external metadata column.
Защищенный метод MemberwiseClone (Производный от Object.)
Открытый метод OnDeletingInputColumn Deletes an IDTSInputColumn100 object from the IDTSInputColumnCollection100.
Открытый метод OnInputPathAttached Called when an IDTSInput100 object is connected to the component through the IDTSPath100 interface.
Открытый метод OnInputPathDetached Called when an IDTSInput100 object is disconnected from the component through the IDTSPath100 interface.
Открытый метод OnOutputPathAttached Called when an IDTSOutput100 object of the component is attached to a downstream component.
Открытый метод PerformUpgrade Upgrades the component metadata to the version of the component installed on the local computer.
Открытый метод PostExecute Called at the end of component execution, but before Cleanup.
Открытый метод PreExecute Called after PrepareForExecute, and before PrimeOutput and ProcessInput.
Открытый метод PrepareForExecute Called before PreExecute.
Открытый метод PrimeOutput Called at run time for source components and transformation components with asynchronous outputs to let these components add rows to the output buffers.
Открытый метод 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.
Открытый метод ProvideComponentProperties Called when a component is first added to the data flow task, to initialize the ComponentMetaData of the component.
Открытый метод RegisterEvents When you are developing a custom data flow component, you override this method to create custom events.
Открытый метод RegisterLogEntries Registers the events that the component will log.
Открытый метод ReinitializeMetaData Repairs any errors identified during validation that cause the component to return VS_NEEDSNEWMETADATA at design time.
Открытый метод ReleaseConnections Frees the connections established during AcquireConnections. Called at design time and run time.
Открытый метод RemoveAllInputsOutputsAndCustomProperties Deletes each IDTSInput100 and IDTSOutput100 object from the component.
Открытый метод SetComponentProperty Assigns a value to a IDTSCustomProperty100 of the component.
Открытый метод SetExternalMetadataColumnDataTypeProperties Sets the data type properties of the specified external metadata column.
Открытый метод SetExternalMetadataColumnProperty Sets an individual property of an external metadata column.
Открытый метод SetInputColumnProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object.
Открытый метод SetInputProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object.
Открытый метод SetOutputColumnDataTypeProperties Sets the data type properties of an IDTSOutputColumn100 object.
Открытый метод SetOutputColumnProperty Sets the value of an IDTSCustomProperty100 for an IDTSOutputColumn100 object.
Открытый метод SetOutputProperty Sets the value of an IDTSCustomProperty100 on an IDTSOutput100 object.
Открытый метод SetUsageType Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column.
Открытый метод ToString (Производный от Object.)
Открытый метод Validate Verifies that the component is correctly configured.

В начало

Поля

  Имя Описание
Открытое полеСтатический элемент s_STOCKPROPNAME_COMPFLAGS Contains the name of the ComparisonFlags property of data flow components.
Открытое полеСтатический элемент s_STOCKPROPNAME_DELOUTPUTONPATHDETACHED Contains the name of the DeleteOutputOnPathDetached property of data flow components.
Открытое полеСтатический элемент s_STOCKPROPNAME_EXCLGROUP Contains the name of the ExclusionGroup property of data flow components.
Открытое полеСтатический элемент s_STOCKPROPNAME_HASSIDEEFFECTS Contains the name of the HasSideEffects property of data flow components.
Открытое полеСтатический элемент s_STOCKPROPNAME_ISDISTRIBUTABLE Contains the name of the IsDistributable property of data flow components.
Открытое полеСтатический элемент s_STOCKPROPNAME_ISERROROUT Contains the name of the IsErrorOut property of data flow components.
Открытое полеСтатический элемент s_STOCKPROPNAME_ISSORTED Contains the name of the IsSorted property of data flow components.
Открытое полеСтатический элемент s_STOCKPROPNAME_REFMETADATAID Contains the name of the ReferenceMetaDataID property of data flow components.
Открытое полеСтатический элемент s_STOCKPROPNAME_SORTKEYPOS Contains the name of the SortKeyPosition property of data flow components.
Открытое полеСтатический элемент s_STOCKPROPNAME_SYNCINPUTID Contains the name of the SynchronousInputID property of data flow components.

В начало

Замечания

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.

Примеры

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

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.

См. также

Справочник

Пространство имен Microsoft.SqlServer.Dts.Pipeline