共通プロパティ
MicrosoftSQL ServerIntegration Services のオブジェクト モデルでは、データ フロー オブジェクトのコンポーネント、入力、出力、入力列、および出力列の各レベルに、共通プロパティとカスタム プロパティがあります。多くのプロパティの値は読み取り専用で、実行時にデータ フロー エンジンによって割り当てられます。
ここでは、データ フロー オブジェクトの共通プロパティを一覧で示し、それぞれについて説明します。
コンポーネント
入力
入力列
出力
出力列
コンポーネント プロパティ
Integration Services のオブジェクト モデルでは、データ フロー内のコンポーネントに IDTSComponentMetaData100 インターフェイスを実装します。
次の表は、データ フロー内のコンポーネントのプロパティを示しています。一部のプロパティの値は読み取り専用で、実行時にデータ フロー エンジンによって割り当てられます。
プロパティ |
データ型 |
説明 |
---|---|---|
ComponentClassID |
String |
コンポーネントの CLSID。 |
ContactInfo |
String |
コンポーネント開発者の連絡先情報。 |
Description |
String |
データ フロー コンポーネントの説明。このプロパティの既定値は、データ フロー コンポーネントの名前です。 |
ID |
Integer |
コンポーネントのこのインスタンスを一意に識別する値。 |
IdentificationString |
String |
コンポーネントを識別します。 |
IsDefaultLocale |
Boolean |
コンポーネントが、それ自体が属するデータ フロー タスクのロケールを使用するかどうかを示します。 |
LocaleID |
Integer |
パッケージを実行する際、データ フロー コンポーネントが使用するロケール。データ フロー コンポーネントでは、すべての Windows ロケールが使用できます。 |
Name |
String |
データ フロー コンポーネントの名前。 |
PipelineVersion |
Integer |
コンポーネントを実行するように設計されたデータ フロー タスクのバージョン。 |
UsesDispositions |
Boolean |
コンポーネントにエラー出力があるかどうかを示します。 |
ValidateExternalMetadata |
Boolean |
外部列のメタデータを検証するかどうかを示します。このプロパティの既定値は True です。 |
Version |
Integer |
コンポーネントのバージョン。 |
入力プロパティ
Integration Services のオブジェクト モデルでは、変換および変換先には入力があります。データ フロー内のコンポーネントの入力は、IDTSInput100 インターフェイスを実装します。
次の表は、データ フロー内のコンポーネントの入力のプロパティを示しています。一部のプロパティの値は読み取り専用で、実行時にデータ フロー エンジンによって割り当てられます。
プロパティ |
データ型 |
説明 |
---|---|---|
Description |
String |
入力の説明。 |
ErrorOrTruncationOperation |
String |
行の処理中にエラーや切り捨てが発生する可能性がある場合、その種類を指定するオプションの文字列。 |
ErrorRowDisposition |
エラーの処理方法を指定する値。値は、Fail component、Ignore failure、および Redirect row です。 |
|
HasSideEffects |
Boolean |
コンポーネントが下流コンポーネントにアタッチされていない場合や、RunInOptimizedMode が true の場合に、データ フローの実行プランからコンポーネントを削除できるかどうかを示します。 |
ID |
Integer |
入力を一意に識別する値。 |
IdentificationString |
String |
入力を識別する文字列。 |
IsSorted |
Boolean |
入力のデータを並べ替えるかどうかを示します。 |
Name |
文字列型 |
入力の名前。 |
SourceLocale |
Integer |
入力データのロケール ID (LCID)。 |
TruncationRowDisposition |
行の処理中に発生した切り捨てを処理する方法を指定する値。値は、Fail component、Ignore failure、および Redirect row です。 |
変換先および一部の変換では、エラー出力がサポートされず、これらのコンポーネントの ErrorRowDisposition プロパティおよび TruncationRowDisposition プロパティは読み取り専用です。
入力列プロパティ
Integration Services のオブジェクト モデルでは、入力には入力列のコレクションが含まれています。データ フロー内のコンポーネントの入力列は、IDTSInputColumn100 インターフェイスを実装します。
次の表は、データ フロー内のコンポーネントの入力列のプロパティを示しています。一部のプロパティの値は読み取り専用で、実行時にデータ フロー エンジンによって割り当てられます。
プロパティ |
データ型 |
説明 |
---|---|---|
ComparisonFlags |
Integer |
文字データ型を持つ列の比較を示すフラグの組。詳細については、「文字列データの比較」を参照してください。 |
Description |
String |
入力列を説明します。 |
ErrorOrTruncationOperation |
String |
行の処理中にエラーや切り捨てが発生する可能性がある場合、その種類を指定するオプションの文字列。 |
ErrorRowDisposition |
エラーの処理方法を指定する値。値は、Fail component、Ignore failure、および Redirect row です。 |
|
ExternalMetadataColumnID |
入力列に割り当てられた外部メタデータ列の ID。 |
|
ID |
Integer |
入力列を一意に識別する値。 |
IdentificationString |
String |
入力列を識別する文字列。 |
LineageID |
Integer |
上流列の ID。 |
Name |
String |
入力列の名前。 |
SortKeyPosition |
Integer |
列を並べ替えるかどうか、並べ替える場合はその並べ替え順、および複数の列の並べ替えの順序を示す値。値 0 は、その列が並べ替えられないことを示します。詳細については、「マージ変換およびマージ結合変換用にデータを並べ替える方法」を参照してください。 |
TruncationRowDisposition |
行の処理中に発生した切り捨てを処理する方法を指定する値。値は、Fail component、Ignore failure、および Redirect row です。 |
|
UpstreamComponentName |
String |
上流コンポーネントの名前。 |
UsageType |
コンポーネントが入力列を使用する方法を指定する値。 |
入力列には、後の「データ型プロパティ」で説明するデータ型プロパティもあります。
出力プロパティ
Integration Services のオブジェクト モデルでは、変換元および変換には出力があります。データ フロー内のコンポーネントの出力は、IDTSOutput100 インターフェイスを実装します。
次の表は、データ フロー内のコンポーネントの出力のプロパティを示しています。一部のプロパティの値は読み取り専用で、実行時にデータ フロー エンジンによって割り当てられます。
プロパティ |
データ型 |
説明 |
---|---|---|
DeleteOutputOnPathDetached |
Boolean |
出力がパスに接続されていない場合に、データ フロー エンジンが出力を削除するかどうかを指定する値。 |
Description |
String |
出力を説明します。 |
ErrorOrTruncationOperation |
String |
行の処理中にエラーや切り捨てが発生する可能性がある場合、その種類を指定するオプションの文字列。 |
ErrorRowDisposition |
エラーの処理方法を指定する値。値は、Fail component、Ignore failure、および Redirect row です。 |
|
ExclusionGroup |
Integer |
相互排他的な出力のグループを識別する値。 |
HasSideEffects |
Boolean |
コンポーネントが上流コンポーネントにアタッチされていない場合や、RunInOptimizedMode が true の場合に、データ フローの実行プランからコンポーネントを削除できるかどうかを示します。 |
ID |
Integer |
出力を一意に識別する値。 |
IdentificationString |
String |
出力を識別する文字列。 |
IsErrorOut |
Boolean |
出力がエラー出力かどうかを示します。 |
IsSorted |
Boolean |
出力を並べ替えるかどうかを示します。既定値は False です。
重要
IsSorted プロパティの値を True に設定しても、データは並べ替えられません。このプロパティでは、データが既に並べ替えられている下流コンポーネントにヒントのみを提供します。詳細については、「マージ変換およびマージ結合変換用にデータを並べ替える方法」を参照してください。
|
Name |
String |
出力の名前。 |
SynchronousInputID |
Integer |
出力に同期する入力の ID。 |
TruncationRowDisposition |
行の処理中に発生した切り捨てを処理する方法を指定する値。値は、Fail component、Ignore failure、および Redirect row です。 |
出力列プロパティ
Integration Services のオブジェクト モデルでは、出力に出力列のコレクションが含まれています。データ フロー内のコンポーネントの出力列は、IDTSOutputColumn100 インターフェイスを実装します。
次の表は、データ フロー内のコンポーネントの出力列のプロパティを示しています。一部のプロパティの値は読み取り専用で、実行時にデータ フロー エンジンによって割り当てられます。
プロパティ |
データ型 |
説明 |
---|---|---|
ComparisonFlags |
Integer |
文字データ型を持つ列の比較を示すフラグの組。詳細については、「文字列データの比較」を参照してください。 |
Description |
String |
出力列を説明します。 |
ErrorOrTruncationOperation |
String |
行の処理中にエラーや切り捨てが発生する可能性がある場合、その種類を指定するオプションの文字列。 |
ErrorRowDisposition |
エラーの処理方法を指定する値。値は、Fail component、Ignore failure、および Redirect row です。既定値は Fail component です。 |
|
ExternalMetadataColumnID |
Integer |
出力列に割り当てられた外部メタデータ列の ID。 |
ID |
Integer |
出力列を一意に識別する値。 |
IdentificationString |
String |
出力列を識別する文字列。 |
LineageID |
Integer |
出力列の ID。下流コンポーネントは、この値を使用して列を参照します。 |
Name |
String |
出力列の名前。 |
SortKeyPosition |
Integer |
列を並べ替えるかどうか、並べ替える場合はその並べ替え順、および複数の列の並べ替えの順序を示す値。値 0 は、列の並べ替えを行わないことを示します。詳細については、「マージ変換およびマージ結合変換用にデータを並べ替える方法」を参照してください。 |
SpecialFlags |
Integer |
出力列の特殊なフラグを含む値。 |
TruncationRowDisposition |
行の処理中に発生した切り捨てを処理する方法を指定する値。値は、Fail component、Ignore failure、および Redirect row です。既定値は Fail component です。 |
出力列には、データ型プロパティの組も含まれています。
外部メタデータ列のプロパティ
Integration Services のオブジェクト モデルでは、入力および出力に外部メタデータ列のコレクションを含めることができます。データ フロー内のコンポーネントの外部メタデータ列は、IDTSExternalMetadataColumn100 インターフェイスを実装します。
次の表は、データ フロー内のコンポーネントの外部メタデータ列のプロパティを示しています。一部のプロパティの値は読み取り専用で、実行時にデータ フロー エンジンによって割り当てられます。
プロパティ |
データ型 |
説明 |
---|---|---|
Description |
String |
外部列を説明します。 |
ID |
Integer |
列を一意に識別する値。 |
IdentificationString |
String |
列を識別する文字列。 |
Name |
String |
外部列の名前。 |
外部メタデータ列には、データ型プロパティの組も含まれています。
データ型プロパティ
出力列および外部メタデータ列には、データ型プロパティの組が含まれています。列のデータ型に応じて、プロパティは読み取り/書き込み可能または読み取り専用の場合があります。
次の表は、出力列および外部メタデータ列のデータ型プロパティを示しています。
プロパティ |
データ型 |
説明 |
---|---|---|
CodePage |
Integer |
Unicode でない文字列データのコード ページを指定します。 |
DataType |
Integer (列挙型) |
列の Integration Services データ型。詳細については、「Integration Services のデータ型」を参照してください。 |
Length |
Integer |
列の長さ (文字数単位)。 |
Precision |
Integer |
数値列の有効桁数。 |
Scale |
Integer |
数値列の小数点以下桁数。 |