次の方法で共有


PipelineComponent クラス

マネージ データ フロー コンポーネントを開発する際に使用する基本クラスを定義します。

継承階層

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 PipelineComponent クラスの新しいインスタンスを初期化します。

先頭に戻る

プロパティ

  名前 説明
パブリック プロパティ BufferManager パイプライン コンポーネントの IDTSBufferManager100 を取得します。
パブリック プロパティ ComponentMetaData コンポーネントの IDTSComponentMetaData100 を取得します。
パブリック プロパティ ErrorSupport ネイティブ コードで記述された Integration Services コンポーネントにより返される HRESULT に基づいて、コンポーネントがエラー、警告、その他の情報イベントを発生させるための ErrorSupport オブジェクトを返します。
パブリック プロパティ EventInfos PipelineComponent オブジェクトの IDTSEventInfos100 コレクションを取得します。
パブリック プロパティ LogEntryInfos コンポーネントが登録したログ記録イベントの IDTSLogEntryInfos100 コレクションを取得します。
パブリック プロパティ ReferenceTracker コンポーネントに関連付けられた IDTSObjectReferenceTracker100 を取得します。
パブリック プロパティ VariableDispenser データ フロー コンポーネントの IDTSVariableDispenser100 を取得します。

先頭に戻る

メソッド

  名前 説明
パブリック メソッド AcquireConnections 接続マネージャーへの接続を確立します。
パブリック メソッド AddErrorOutput IDTSOutput100 オブジェクトを追加し、IsErrorOut プロパティを true に設定することにより、このオブジェクトをエラー出力としてマークします。
プロテクト メソッド静的メンバー BufferTypeToDataRecordType Integration Services データ型に基づいてマネージ データ型を返します。
パブリック メソッド Cleanup リソースを解放し、コンポーネントの実行を完了します。
プロテクト メソッド静的メンバー ConvertBufferDataTypeToFitManaged マネージ コードから適切な Integration Services DataType を取得します。
プロテクト メソッド静的メンバー DataRecordTypeToBufferType マネージ型に対応する Integration Services DataType を取得します。
パブリック メソッド DeleteExternalMetadataColumn 外部メタデータ列のコレクションから、指定したインデックス位置にある外部メタデータ列を削除します。
パブリック メソッド DeleteInput IDTSInput100 オブジェクトを IDTSInputCollection100 コレクションから削除します。
パブリック メソッド DeleteOutput IDTSOutput100 オブジェクトを IDTSOutputCollection100 コレクションから削除します。
パブリック メソッド DeleteOutputColumn IDTSOutputColumn100 オブジェクトを IDTSOutputColumnCollection100 コレクションから削除します。
パブリック メソッド DescribeRedirectedErrorCode 出力バッファーに追加された PipelineBuffer 行に対するエラー コード情報を提供します。
パブリック メソッド Equals (Object から継承されています。)
プロテクト メソッド Finalize (Object から継承されています。)
パブリック メソッド GetDependentInputs 追加のデータを待っているために特定の入力をブロックしている入力の入力 ID のコレクションを返します。
パブリック メソッド GetErrorOutputInfo コンポーネントのエラー出力のインデックスと ID を返します。
パブリック メソッド GetHashCode (Object から継承されています。)
パブリック メソッド GetType (Object から継承されています。)
プロテクト メソッド静的メンバー idxOfBufferType インフラストラクチャです。バッファー インデックスの種類を指定します。
プロテクト メソッド静的メンバー idxOfDataRecordType インフラストラクチャです。データ レコード インデックスの型を指定します。
パブリック メソッド Initialize 派生クラスでオーバーライドされた場合、カスタム データ フロー コンポーネントの新しいインスタンスを初期化します。
パブリック メソッド InsertExternalMetadataColumnAt 外部メタデータ列のコレクションの指定したインデックス位置に、新しい外部メタデータ列を挿入します。
パブリック メソッド InsertInput IDTSInputCollection100IDTSInput100 オブジェクトを追加します。
パブリック メソッド InsertOutput 新しい IDTSOutput100 オブジェクトを追加します。
パブリック メソッド InsertOutputColumnAt 新しい IDTSOutputColumn100 オブジェクトを作成して、IDTSOutputColumnCollection100 に挿入します。
プロテクト メソッド静的メンバー IsCompatibleNumericTypes 2 つの数値データ型に、一方の型からもう一方の型への変換をサポートするための互換性があるかどうかを判断します。
パブリック メソッド IsInputReady コンポーネントにアタッチされている入力のうち、どの入力がデータを待っているか、およびどの入力が十分な処理対象のデータを持ちながらブロックされているかを判定します。
パブリック メソッド MapInputColumn 入力列とそれに対応する外部メタデータ列との間にリレーションシップを確立します。
パブリック メソッド MapOutputColumn 出力列とそれに対応する外部メタデータ列との間にリレーションシップを確立します。
プロテクト メソッド MemberwiseClone (Object から継承されています。)
パブリック メソッド OnDeletingInputColumn IDTSInputColumnCollection100 から IDTSInputColumn100 オブジェクトを削除します。
パブリック メソッド OnInputPathAttached IDTSPath100 インターフェイスを介して IDTSInput100 オブジェクトがコンポーネントに接続される場合に呼び出されます。
パブリック メソッド OnInputPathDetached IDTSPath100 インターフェイスを介して IDTSInput100 オブジェクトがコンポーネントから切断される場合に呼び出されます。
パブリック メソッド OnOutputPathAttached コンポーネントの IDTSOutput100 オブジェクトが下流コンポーネントにアタッチされるときに呼び出されます。
パブリック メソッド PerformUpgrade コンポーネントのメタデータを、ローカル コンピューターにインストールされたコンポーネントのバージョンにアップグレードします。
パブリック メソッド PostExecute コンポーネントの実行の最後 (ただし Cleanup の前) で呼び出されます。
パブリック メソッド PreExecute PrepareForExecute の後で、かつ PrimeOutput および ProcessInput の前に呼び出されます。
パブリック メソッド PrepareForExecute PreExecute の前に呼び出されます。
パブリック メソッド PrimeOutput 非同期出力型の変換元コンポーネントおよび変換コンポーネントの実行時に呼び出され、これらのコンポーネントが出力バッファーに行を追加できるようにします。
パブリック メソッド ProcessInput 上流コンポーネントからの PipelineBuffer がコンポーネントで利用可能な場合、実行時に呼び出され、コンポーネントが受信行を処理できるようにします。
パブリック メソッド ProvideComponentProperties コンポーネントが最初にデータ フロー タスクに追加されるとき、コンポーネントの ComponentMetaData を初期化するために呼び出されます。
パブリック メソッド RegisterEvents カスタム データ フロー コンポーネントを開発する際、このメソッドをオーバーライドしてカスタム イベントを作成します。
パブリック メソッド RegisterLogEntries コンポーネントがログに記録するイベントを登録します。
パブリック メソッド ReinitializeMetaData コンポーネントが VS_NEEDSNEWMETADATA を返す原因である、デザイン時検証で識別されるエラーを修正します。
パブリック メソッド ReleaseConnections AcquireConnections の間に確立された接続を解放します。デザイン時および実行時に呼び出されます。
パブリック メソッド RemoveAllInputsOutputsAndCustomProperties コンポーネントから、各 IDTSInput100 および IDTSOutput100 オブジェクトを削除します。
パブリック メソッド SetComponentProperty コンポーネントの IDTSCustomProperty100 に値を割り当てます。
パブリック メソッド SetExternalMetadataColumnDataTypeProperties 指定した外部メタデータ列のデータ型プロパティを設定します。
パブリック メソッド SetExternalMetadataColumnProperty 外部メタデータ列の個別のプロパティを設定します。
パブリック メソッド SetInputColumnProperty IDTSInputColumn100 オブジェクトの IDTSCustomProperty100 に値を割り当てます。
パブリック メソッド SetInputProperty IDTSInput100 オブジェクトの IDTSCustomProperty100 に値を割り当てます。
パブリック メソッド SetOutputColumnDataTypeProperties IDTSOutputColumn100 オブジェクトのデータ型プロパティを設定します。
パブリック メソッド SetOutputColumnProperty IDTSOutputColumn100 オブジェクトの IDTSCustomProperty100 の値を設定します。
パブリック メソッド SetOutputProperty IDTSOutput100 オブジェクトに IDTSCustomProperty100 の値を設定します。
パブリック メソッド SetUsageType コンポーネントの IDTSInputColumnCollection100IDTSInputColumn100 オブジェクトを作成し、列の UsageType プロパティを設定します。
パブリック メソッド ToString (Object から継承されています。)
パブリック メソッド Validate コンポーネントが正しく構成されていることを確認します。

先頭に戻る

フィールド

  名前 説明
パブリック フィールド静的メンバー s_STOCKPROPNAME_COMPFLAGS データ フロー コンポーネントの ComparisonFlags プロパティの名前です。
パブリック フィールド静的メンバー s_STOCKPROPNAME_DELOUTPUTONPATHDETACHED データ フロー コンポーネントの DeleteOutputOnPathDetached プロパティの名前です。
パブリック フィールド静的メンバー s_STOCKPROPNAME_EXCLGROUP データ フロー コンポーネントの ExclusionGroup プロパティの名前です。
パブリック フィールド静的メンバー s_STOCKPROPNAME_HASSIDEEFFECTS データ フロー コンポーネントの HasSideEffects プロパティの名前です。
パブリック フィールド静的メンバー s_STOCKPROPNAME_ISDISTRIBUTABLE データ フロー コンポーネントの IsDistributable プロパティの名前です。
パブリック フィールド静的メンバー s_STOCKPROPNAME_ISERROROUT データ フロー コンポーネントの IsErrorOut プロパティの名前です。
パブリック フィールド静的メンバー s_STOCKPROPNAME_ISSORTED データ フロー コンポーネントの IsSorted プロパティの名前です。
パブリック フィールド静的メンバー s_STOCKPROPNAME_REFMETADATAID データ フロー コンポーネントの ReferenceMetaDataID プロパティの名前です。
パブリック フィールド静的メンバー s_STOCKPROPNAME_SORTKEYPOS データ フロー コンポーネントの SortKeyPosition プロパティの名前です。
パブリック フィールド静的メンバー s_STOCKPROPNAME_SYNCINPUTID データ フロー コンポーネントの SynchronousInputID プロパティの名前です。

先頭に戻る

説明

このクラスから継承し、独自のデータ フロー コンポーネントを作成します。 このクラスは、必要なコンポーネント インターフェイスである IDTSDesigntimeComponent100 および IDTSRuntimeComponent100 を実装します。 独自のコンポーネント機能を提供するには、これらのメソッドの基本クラス実装をオーバーライドしてください。 PipelineComponent には、コンポーネント インターフェイスのメソッドに加えてヘルパー メソッドが用意されており、独自のコンポーネントの開発に役立ちます。

使用例

次のコード例は、DtsPipelineComponentAttribute を実装し、PipelineComponent クラスから継承するコンポーネントを示します。

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

スレッド セーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

関連項目

参照

Microsoft.SqlServer.Dts.Pipeline 名前空間