データ フロー コンポーネントの検証
基本クラス PipelineComponent の Validate メソッドを使用すると、正しく構成されていないコンポーネントが実行されることを防止できます。このメソッドを使用すると、コンポーネントが想定どおりの数の入出力オブジェクトを持ち、カスタム プロパティの値が許容範囲内で、接続が必要な場合はそれが指定されていることを検証できます。また、入出力コレクションの各列のデータ型が正しいこと、各列の DTSUsageType がコンポーネント用に正しく設定されていることも検証できます。この基本クラスを実装すると、コンポーネントの入力列コレクションをチェックし、コレクションの各列が上流コンポーネントの IDTSOutputCollection100 にある列を参照していることを確認できるため、検証プロセスの作業に役立ちます。
Validate メソッド
Validate メソッドは、SSIS デザイナでコンポーネントが編集されるたびに、繰り返し呼び出されます。コンポーネントのデザイナやユーザーに対するフィードバックは、列挙型 DTSValidationStatus の戻り値や、警告、エラーの発生によって通知できます。DTSValidationStatus 列挙に含まれる値のうち 3 つはさまざまな段階での検証失敗を示します。4 番目の VS_ISVALID という値は、コンポーネントが正しく構成されていて、いつでも実行可能であることを示します。
値 VS_NEEDSNEWMETADATA は、ComponentMetaData にエラーがあるが、コンポーネントはエラーを修復できることを示します。コンポーネントがメタデータのエラーを修復できる場合でも、Validate メソッドのエラーは修復せず、また、検証中に ComponentMetaData を変更することも避けてください。代わりに、Validate メソッドが VS_NEEDSNEWMETADATA のみを返し、コンポーネントは ReinitializeMetaData メソッドの呼び出し中にエラーを修復するようにします。詳細についてはこのセクションの後半で説明します。
値 VS_ISBROKEN は、コンポーネントにエラーがあるが、デザイナで編集することにより修復できることを示します。このエラーが発生するのは、通常、カスタム プロパティまたは必要な接続が指定されていない、または正しく設定されていないためです。
値 VS_ISCORRUPT は、パッケージ XML の編集、またはオブジェクト モデルの使用により、ComponentMetaData プロパティが直接修正された場合にのみ発生するエラーがコンポーネントで見つかったことを示します。たとえば、コンポーネントに入力が 1 つしか追加されていないのに、ComponentMetaData に複数の入力が存在することが検証で確認された場合、この種のエラーが発生します。この戻り値を生成するエラーを修正するには、[詳細エディタ] ダイアログ ボックスで [リセット] をクリックして、コンポーネントをリセットするしか方法がありません。
戻り値としてエラーを返す以外に、検証中に警告やエラーを通知し、コンポーネントにフィードバックを送信する方法もあります。このメカニズムは、FireWarning メソッドおよび FireError メソッドによって提供されます。これらのメソッドが呼び出されると、Business Intelligence Development Studio の [エラー一覧] ウィンドウにイベントが表示されます。コンポーネント開発者は、発生したエラーに関するフィードバックや、必要に応じて、修正方法を直接ユーザーに通知することもできます。
次のコード例は、Validate メソッドをオーバーライドして実装する方法を示しています。
public override DTSValidationStatus Validate()
{
bool pbCancel = false;
// Validate that there is one input.
if (ComponentMetaData.InputCollection.Count != 1)
{
ComponentMetaData.FireError(0, ComponentMetaData.Name, "Incorrect number of inputs.", "", 0, out pbCancel);
return DTSValidationStatus.VS_ISCORRUPT;
}
// Validate that the UserName custom property is set.
if (ComponentMetaData.CustomPropertyCollection["UserName"].Value == null || ((string)ComponentMetaData.CustomPropertyCollection["UserName"].Value).Length == 0)
{
ComponentMetaData.FireError(0, ComponentMetaData.Name, "The UserName property must be set.", "", 0, out pbCancel);
return DTSValidationStatus.VS_ISBROKEN;
}
// Validate that there is one output.
if (ComponentMetaData.OutputCollection.Count != 1)
{
ComponentMetaData.FireError(0, ComponentMetaData.Name, "Incorrect number of outputs.", "", 0, out pbCancel);
return DTSValidationStatus.VS_ISCORRUPT;
}
// Let the base class verify that the input column reflects the output
// of the upstream component.
return base.Validate();
}
Public Overrides Function Validate() As DTSValidationStatus
Dim pbCancel As Boolean = False
' Validate that there is one input.
If Not (ComponentMetaData.InputCollection.Count = 1) Then
ComponentMetaData.FireError(0, ComponentMetaData.Name, "Incorrect number of inputs.", "", 0, pbCancel)
Return DTSValidationStatus.VS_ISCORRUPT
End If
' Validate that the UserName custom property is set.
If ComponentMetaData.CustomPropertyCollection("UserName").Value Is Nothing OrElse CType(ComponentMetaData.CustomPropertyCollection("UserName").Value, String).Length = 0 Then
ComponentMetaData.FireError(0, ComponentMetaData.Name, "The UserName property must be set.", "", 0, pbCancel)
Return DTSValidationStatus.VS_ISBROKEN
End If
' Validate that there is one output.
If Not (ComponentMetaData.OutputCollection.Count = 1) Then
ComponentMetaData.FireError(0, ComponentMetaData.Name, "Incorrect number of outputs.", "", 0, pbCancel)
Return DTSValidationStatus.VS_ISCORRUPT
End If
' Let the base class verify that the input column reflects the output
' of the upstream component.
Return MyBase.Validate
End Function
ReinitializeMetaData メソッド
ReinitializeMetaData メソッドは、コンポーネントで Validate メソッドの戻り値が VS_NEEDSNEWMETADATA であった場合に、常に SSIS デザイナによって呼び出されます。コンポーネントには、検証中に見つかったエラーを検出、修正するコードを含める必要があります。
次の例は、ReinitializeMetaData メソッドで、検証中にエラーを検出、修正するコンポーネントを示しています。
private bool areInputColumnsValid = true;
public override DTSValidationStatus Validate()
{
IDTSInput100 input = ComponentMetaData.InputCollection[0];
IDTSVirtualInput100 vInput = input.GetVirtualInput();
bool Cancel = false;
foreach (IDTSInputColumn100 column in input.InputColumnCollection)
{
try
{
IDTSVirtualInputColumn100 vColumn = vInput.VirtualInputColumnCollection.GetVirtualInputColumnByLineageID(column.LineageID);
}
catch
{
ComponentMetaData.FireError(0, ComponentMetaData.Name, "The input column " + column.IdentificationString + " does not match a column in the upstream component.", "", 0, out Cancel);
areInputColumnsValid = false;
return DTSValidationStatus.VS_NEEDSNEWMETADATA;
}
}
return DTSValidationStatus.VS_ISVALID;
}
public override void ReinitializeMetaData()
{
if (!areInputColumnsValid)
{
IDTSInput100 input = ComponentMetaData.InputCollection[0];
IDTSVirtualInput100 vInput = input.GetVirtualInput();
foreach (IDTSInputColumn100 column in input.InputColumnCollection)
{
IDTSVirtualInputColumn100 vColumn = vInput.VirtualInputColumnCollection.GetVirtualInputColumnByLineageID(column.LineageID);
if (vColumn == null)
input.InputColumnCollection.RemoveObjectByID(column.ID);
}
areInputColumnsValid = true;
}
}
Private areInputColumnsValid As Boolean = True
Public Overrides Function Validate() As DTSValidationStatus
Dim input As IDTSInput100 = ComponentMetaData.InputCollection(0)
Dim vInput As IDTSVirtualInput100 = input.GetVirtualInput
Dim Cancel As Boolean = False
For Each column As IDTSInputColumn100 In input.InputColumnCollection
Try
Dim vColumn As IDTSVirtualInputColumn100 = vInput.VirtualInputColumnCollection.GetVirtualInputColumnByLineageID(column.LineageID)
Catch
ComponentMetaData.FireError(0, ComponentMetaData.Name, "The input column " + column.IdentificationString + " does not match a column in the upstream component.", "", 0, Cancel)
areInputColumnsValid = False
Return DTSValidationStatus.VS_NEEDSNEWMETADATA
End Try
Next
Return DTSValidationStatus.VS_ISVALID
End Function
Public Overrides Sub ReinitializeMetaData()
If Not areInputColumnsValid Then
Dim input As IDTSInput100 = ComponentMetaData.InputCollection(0)
Dim vInput As IDTSVirtualInput100 = input.GetVirtualInput
For Each column As IDTSInputColumn100 In input.InputColumnCollection
Dim vColumn As IDTSVirtualInputColumn100 = vInput.VirtualInputColumnCollection.GetVirtualInputColumnByLineageID(column.LineageID)
If vColumn Is Nothing Then
input.InputColumnCollection.RemoveObjectByID(column.ID)
End If
Next
areInputColumnsValid = True
End If
End Sub
|
.gif "Integration Services のアイコン (小)")
最新の Integration Services の入手