• [アーティクル]

変換先のカスタム プロパティ

Microsoft SQL Server Integration Services のオブジェクト モデルでは、データ フロー オブジェクトのコンポーネント、入力、出力、入力列、および出力列の各レベルに、共通プロパティとカスタム プロパティがあります。カスタム プロパティにアクセスできるのは実行時のみで、このプロパティに関する説明は、『Integration Services マネージ プログラミング リファレンス マニュアル』には記載されていません。

ここでは、データ フローの変換先のカスタム プロパティを一覧で示し、それぞれについて説明します。

  • ADO NET 変換先

  • データ マイニング モデル トレーニング変換先

  • DataReader 変換先

  • ディメンション処理変換先

  • Excel 変換先

  • フラット ファイル変換先

  • OLE DB 変換先

  • パーティション処理変換先

  • 生ファイル変換先

  • レコードセット変換先

  • SQL Server Compact Edition 変換先

  • SQL Server 変換先

データ フロー オブジェクトの大部分との共通プロパティについては、「共通プロパティ」を参照してください。

変換先のプロパティの一部は、このトピックで示すとおり、プロパティ式を使用して設定できます。詳細については、「式を使って設定できるデータ フロー プロパティ」を参照してください。

ADO NET 変換先

ADO.NET 変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントに共通するプロパティの両方があります。

次の表は、ADO.NET 変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。これらのプロパティは、[ADO.NET 変換先エディター] ではアクセスできませんが、[詳細エディター] を使用して設定できます。

プロパティ

データ型

説明

BatchSize

Integer

サーバーに送信されるバッチ内の行数です。値 0 は、バッチ サイズが内部バッファーのサイズに一致することを示します。このプロパティの既定値は 0 です。

CommandTimeOut

Integer

SQL コマンドがタイムアウトになるまでの最大秒数。この値に 0 を指定すると、時間は無制限になります。このプロパティの既定値は 0 です。

TableOrViewName

String

変換先のテーブルまたはビューの名前。

UseBulkInsertWhenAvailable

Boolean

一括挿入操作のパフォーマンスを向上させるために System.Data.SqlClient..::..SqlBulkCopy インターフェイスを使用するかどうかを指定する値。特定の ADO.NET プロバイダーのみがこのインターフェイスをサポートしています。

既定値は True です。

詳細については、「ADO NET 変換先」を参照してください。

データ マイニング モデル トレーニング変換先のカスタム プロパティ

データ マイニング モデル トレーニング変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、データ マイニング モデル トレーニング変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

プロパティ

データ型

説明

ASConnectionId

String

接続マネージャーの一意識別子。

ASConnectionString

String

Analysis Services のインスタンスまたは Analysis Services プロジェクトへの接続文字列。

ObjectRef

String

この変換が使用するデータ マイニング構造を指定する XML タグ。

データ マイニング モデル トレーニング変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「データ マイニング モデル トレーニング変換先」を参照してください。

DataReader 変換先のカスタム プロパティ

DataReader 変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、DataReader 変換先のカスタム プロパティを示しています。DataReader を除き、すべてのプロパティは読み取り/書き込み可能です。

プロパティ名

データ型

説明

DataReader

String

DataReader 変換先のクラス名。

FailOnTimeout

Boolean

ReadTimeout が発生したときに失敗するかどうかを示します。このプロパティの既定値は False です。

ReadTimeout

Integer

タイムアウトが発生するまでの時間 (ミリ秒単位)。このプロパティの既定値は 30000 (30 秒) です。

DataReader 変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「DataReader 変換先」を参照してください。

ディメンション処理変換先のカスタム プロパティ

ディメンション処理変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、ディメンション処理変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

プロパティ

データ型

説明

ASConnectionString

String

Analysis Services のインスタンスまたは Analysis Services プロジェクトへの接続文字列。

KeyDuplicate

Integer (列挙)

UseDefaultConfiguration が False の場合、重複キー エラーの処理方法を示す値。有効な値は、IgnoreError (0)、ReportAndContinue (1)、および ReportAndStop (2) です。このプロパティの既定値は IgnoreError (0) です。

KeyErrorAction

Integer (列挙)

UseDefaultConfiguration が False の場合、キー エラーの処理方法を示す値。有効な値は、ConvertToUnknown (0) および DiscardRecord (1) です。このプロパティの既定値は ConvertToUnknown (0) です。

KeyErrorLimit

Integer

UseDefaultConfiguration が False の場合、許可されるキー エラーの上限。

KeyErrorLimitAction

Integer (列挙)

UseDefaultConfiguration が False の場合、KeyErrorLimit に達したときに行われるアクションを示す値。有効な値は、StopLogging (1) および StopProcessing (0) です。このプロパティの既定値は StopProcessing (0) です。

KeyErrorLogFile

String

UseDefaultConfiguration が False の場合の、エラー ログ ファイルのパスおよびファイル名。

KeyNotFound

Integer (列挙)

UseDefaultConfiguration が False の場合、存在しないキーのエラーの処理方法を示す値。有効な値は、IgnoreError (0)、ReportAndContinue (1)、および ReportAndStop (2) です。このプロパティの既定値は IgnoreError (0) です。

NullKeyConvertedToUnknown

Integer (列挙)

UseDefaultConfiguration が False の場合、不明な値に変換された NULL キーの処理方法を示す値。有効な値は、IgnoreError (0)、ReportAndContinue (1)、および ReportAndStop (2) です。このプロパティの既定値は IgnoreError (0) です。

NullKeyNotAllowed

Integer (列挙)

UseDefaultConfiguration が False の場合、許容されない NULL の処理方法を示す値。有効な値は、IgnoreError (0)、ReportAndContinue (1)、および ReportAndStop (2) です。このプロパティの既定値は IgnoreError (0) です。

ProcessType

Integer (列挙)

変換が使用するディメンション処理の種類。有効な値は、ProcessAdd (1) (インクリメンタル)、ProcessFull (0)、および ProcessUpdate (2) です。

UseDefaultConfiguration

Boolean

変換が既定のエラー構成を使用するかどうかを指定する値。このプロパティが False の場合、変換にはエラー処理に関する情報が含まれます。

ディメンション処理変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「ディメンション処理変換先」を参照してください。

Excel 変換先のカスタム プロパティ

Excel 変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、Excel 変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

プロパティ名

データ型

説明

AccessMode

Integer (列挙)

変換先が変換先となるデータベースにアクセスする方法を指定する値。

このプロパティの値は、次のいずれか 1 つです。

  • OpenRowset (0): テーブルまたはビューの名前を指定します。

  • OpenRowset from Variable (1): テーブルまたはビューの名前が含まれる変数の名前を指定します。

  • OpenRowset Using Fastload (3): テーブルまたはビューの名前を指定します。

  • OpenRowset Using Fastload from Variable (4): テーブルまたはビューの名前が含まれる変数の名前を指定します。

  • SQL Command (2): SQL ステートメントを指定します。

CommandTimeout

Integer

SQL コマンドがタイムアウトになるまでの最大秒数。この値に 0 を指定すると、時間は無制限になります。このプロパティの既定値は 0 です。

注意注
このプロパティは、[Excel 変換先エディター] では使用できませんが、[詳細エディター] を使用して設定できます。

FastLoadKeepIdentity

Boolean

データが読み込まれるときに ID 値をコピーするかどうかを指定する値。このプロパティは、高速読み取りオプションのいずれかを使用した場合のみ使用できます。このプロパティの既定値は False です。

FastLoadKeepNulls

Boolean

データが読み込まれるときに NULL 値をコピーするかどうかを指定する値。このプロパティは、高速読み取りオプションのいずれかを使用した場合のみ使用できます。このプロパティの既定値は False です。

FastLoadMaxInsertCommitSize

Integer

高速読み込み操作の実行中に、Excel 変換先でコミットを試行するバッチ サイズを指定する値。既定値の 0 は、すべての行が処理された後で、コミット操作が 1 回行われることを示します。

FastLoadOptions

String

高速読み込みオプションのコレクション。高速読み込みオプションには、テーブルのロックおよび制約のチェックが含まれています。どちらか 1 つまたは両方を指定することも、どちらも指定しないこともできます。

注意注
このプロパティの一部のオプションは、[Excel 変換先エディター] では使用できませんが、[詳細エディター] を使用して設定できます。

OpenRowset

String

AccessMode が OpenRowset の場合、Excel 変換先がアクセスするテーブルまたはビューの名前。

OpenRowsetVariable

String

AccessMode が OpenRowset from Variable の場合、Excel 変換先がアクセスするテーブルまたはビューの名前が含まれる変数名。

SqlCommand

String

AccessMode が SQL Command の場合、Excel 変換先がデータの変換先列を指定するときに使用する、Transact-SQL ステートメント。

Excel 変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「Excel 変換先」を参照してください。

フラット ファイル変換先のカスタム プロパティ

フラット ファイル変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、フラット ファイル変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

プロパティ名

データ型

説明

Header

String

データが書き込まれる前にファイルに挿入される、テキストのブロック。

このプロパティの値は、プロパティ式を使用して指定できます。

Overwrite

Boolean

同じ名前の既存の変換先ファイルに対して、上書きまたは追加のどちらを実行するかを指定する値。このプロパティの既定値は True です。

フラット ファイル変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「フラット ファイル変換先」を参照してください。

OLE DB 変換先のカスタム プロパティ

OLE DB 変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、OLE DB 変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

注意注

ここに一覧で示されている FastLoad オプション (FastLoadKeepIdentity、FastLoadKeepNulls、および FastLoadOptions) は、Microsoft OLE DB Provider for SQL Server (SQLOLEDB) が実装する IRowsetFastLoad インターフェイスによって公開され、同様の名前が付けられたプロパティに対応します。詳細については、MSDN ライブラリで、IRowsetFastLoad を検索してください。

プロパティ名

データ型

説明

AccessMode

Integer (列挙)

変換先が変換先となるデータベースにアクセスする方法を指定する値。

このプロパティの値は、次のいずれか 1 つです。

  • OpenRowset (0): テーブルまたはビューの名前を指定します。

  • OpenRowset from Variable (1): テーブルまたはビューの名前が含まれる変数の名前を指定します。

  • OpenRowset Using Fastload (3): テーブルまたはビューの名前を指定します。

  • OpenRowset Using Fastload from Variable (4): テーブルまたはビューの名前が含まれる変数の名前を指定します。

  • SQL Command (2): SQL ステートメントを指定します。

AlwaysUseDefaultCodePage

Boolean

DefaultCodePage プロパティの値を各列に使用するか、または各列のロケールからコードページを派生するかを示す値。このプロパティの既定値は False です。

CommandTimeout

Integer

SQL コマンドがタイムアウトになるまでの最大秒数。この値に 0 を指定すると、時間は無制限になります。このプロパティの既定値は 0 です。

注意注
このプロパティは、[OLE DB 変換先エディター] では使用できませんが、[詳細エディター] を使用して設定できます。

DefaultCodePage

Integer

OLE DB 変換先に関連付けられた既定のコード ページ。

FastLoadKeepIdentity

Boolean

データが読み込まれるときに ID 値をコピーするかどうかを指定する値。このプロパティは、高速読み取りオプションのいずれかを使用した場合のみ使用できます。このプロパティの既定値は False です。このプロパティは、OLE DB IRowsetFastLoad (OLE DB) のプロパティ、SSPROP_FASTLOADKEEPIDENTITY に対応しています。

FastLoadKeepNulls

Boolean

データが読み込まれるときに NULL 値をコピーするかどうかを指定する値。このプロパティは、高速読み取りオプションのいずれかを使用した場合のみ使用できます。このプロパティの既定値は False です。このプロパティは、OLE DB IRowsetFastLoad (OLE DB) のプロパティ、SSPROP_FASTLOADKEEPNULLS に対応しています。

FastLoadMaxInsertCommitSize

Integer

高速読み込み操作の実行中に OLE DB 変換先でコミットを試行するバッチ サイズを指定する値。既定値の 2147483647 は、すべての行が処理された後で、コミット操作が 1 回行われることを示します。

FastLoadOptions

String

高速読み込みオプションのコレクション。高速読み込みオプションには、テーブルのロックおよび制約のチェックが含まれています。どちらか 1 つまたは両方を指定することも、どちらも指定しないこともできます。このプロパティは、OLE DB IRowsetFastLoad のプロパティ、SSPROP_FASTLOADOPTIONS に対応し、CHECK_CONSTRAINTS や TABLOCK などの文字列オプションを指定します。

注意注
このプロパティの一部のオプションは、[Excel 変換先エディター] では使用できませんが、[詳細エディター] を使用して設定できます。

OpenRowset

String

AccessMode が OpenRowset の場合、OLE DB 変換先がアクセスするテーブルまたはビューの名前。

OpenRowsetVariable

String

AccessMode が OpenRowset from Variable の場合、OLE DB 変換先がアクセスするテーブルまたはビューの名前が含まれる変数名。

SqlCommand

String

AccessMode が SQL Command の場合、OLE DB 変換先がデータの変換先列を指定するときに使用する、Transact-SQL ステートメント。

OLE DB 変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「OLE DB 変換先」を参照してください。

パーティション処理変換先のカスタム プロパティ

パーティション処理変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、パーティション処理変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

プロパティ

データ型

説明

ASConnectionString

String

Analysis Services プロジェクトまたは Analysis Services インスタンスへの接続文字列

KeyDuplicate

Integer (列挙)

UseDefaultConfiguration が False の場合、重複キー エラーの処理方法を示す値。有効な値は、IgnoreError (0)、ReportAndContinue (1)、および ReportAndStop (2) です。このプロパティの既定値は IgnoreError (0) です。

KeyErrorAction

Integer (列挙)

UseDefaultConfiguration が False の場合、キー エラーの処理方法を示す値。有効な値は、ConvertToUnknown (0) および DiscardRecord (1) です。このプロパティの既定値は ConvertToUnknown (0) です。

KeyErrorLimit

Integer

UseDefaultConfiguration が False の場合、許可されるキー エラーの上限。

KeyErrorLimitAction

Integer (列挙)

UseDefaultConfiguration が False の場合、KeyErrorLimit に達したときに行われるアクションを示す値。有効な値は、StopLogging (1) および StopProcessing (0) です。このプロパティの既定値は StopProcessing (0) です。

KeyErrorLogFile

String

UseDefaultConfiguration が False の場合の、エラー ログ ファイルのパスおよびファイル名。

KeyNotFound

Integer (列挙)

UseDefaultConfiguration が False の場合、存在しないキーのエラーの処理方法を示す値。有効な値は、IgnoreError (0)、ReportAndContinue (1)、および ReportAndStop (2) です。このプロパティの既定値は ReportAndContinue (1) です。

NullKeyConvertedToUnknown

Integer (列挙)

UseDefaultConfiguration が False の場合、不明な値に変換された NULL キーの処理方法を示す値。有効な値は、IgnoreError (0)、ReportAndContinue (1)、および ReportAndStop (2) です。このプロパティの既定値は IgnoreError (0) です。

NullKeyNotAllowed

Integer (列挙)

UseDefaultConfiguration が False の場合、許容されない NULL の処理方法を示す値。有効な値は、IgnoreError (0)、ReportAndContinue (1)、および ReportAndStop (2) です。このプロパティの既定値は ReportAndContinue (1) です。

ProcessType

Integer (列挙)

変換が使用するパーティション処理の種類。有効な値は、ProcessAdd (1) (インクリメンタル)、ProcessFull (0)、および ProcessUpdate (2) です。

UseDefaultConfiguration

Boolean

変換が既定のエラー構成を使用するかどうかを指定する値。このプロパティが False の場合、変換は、この表の一覧で示されている、KeyDuplicate や KeyErrorAction などのエラー処理のカスタム プロパティの値を使用します。

パーティション処理変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「パーティション処理変換先」を参照してください。

生ファイル変換先のカスタム プロパティ

生ファイル変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、生ファイル変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

プロパティ名

データ型

説明

AccessMode

Integer (列挙)

FileName プロパティにファイル名を含めるか、またはファイル名が含まれる変数名を含めるかを指定する値。使用できるオプションは、File name (0) および File name from variable (1) です。

FileName

String

生ファイル変換先が書き込むファイルの名前。

WriteOption

Integer (列挙)

生ファイル変換先が、同じ名前の既存のファイルを削除するかどうかを指定する値。使用できるオプションは、Create Always (0)、Create Once (1)、Truncate and Append (3)、および Append (2) です。このプロパティの既定値は Create Always (0) です。
注意注

追加操作では、追加するデータのメタデータが、ファイル内の既存データのメタデータと一致している必要があります。

生ファイル変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「生ファイル変換先」を参照してください。

レコードセット変換先のカスタム プロパティ

レコードセット変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、レコードセット変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

プロパティ名

データ型

説明

VariableName

String

ADO レコードセットが保持する変数の名前。

レコードセット変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「レコードセット変換先」を参照してください。

SQL Server Compact Edition 変換先のカスタム プロパティ

SQL Server Compact 変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントに共通するプロパティの両方があります。

次の表は、SQL Server Compact 変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

プロパティ名

データ型

説明

TableName

String

SQL Server Compact データベース内の変換先テーブルの名前。

このプロパティの値は、プロパティ式を使用して指定できます。

SQL Server Compact 変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「SQL Server Compact Edition 変換先」を参照してください。

SQL Server 変換先のカスタム プロパティ

SQL Server 変換先には、カスタム プロパティと、すべてのデータ フロー コンポーネントとの共通プロパティの両方があります。

次の表は、SQL Server 変換先のカスタム プロパティを示しています。すべてのプロパティは読み取り/書き込み可能です。

プロパティ名

データ型

説明

AlwaysUseDefaultCodePage

Boolean

DefaultCodePage プロパティ値を強制的に使用します。このプロパティの既定値は False です。

BulkInsertCheckConstraints

Boolean

一括挿入で制約をチェックするかどうかを指定する値。このプロパティの既定値は True です。

BulkInsertFireTriggers

Boolean

一括挿入でテーブル上のトリガーを起動するかどうかを指定する値。このプロパティの既定値は False です。

BulkInsertFirstRow

Integer

挿入する最初の行を指定する値。このプロパティの既定値は、-1 です。これは、割り当てられた値がないことを示します。

BulkInsertKeepIdentity

Boolean

ID 列に値を挿入できるかどうかを指定する値。このプロパティの既定値は False です。

BulkInsertKeepNulls

Boolean

一括挿入で NULL 値を保持するかどうかを指定する値。このプロパティの既定値は False です。

BulkInsertLastRow

Integer

挿入する最後の行を指定する値。このプロパティの既定値は、-1 です。これは、割り当てられた値がないことを示します。

BulkInsertMaxErrors

Integer

一括挿入を停止する前に許容するエラー数を指定する値。このプロパティの既定値は、-1 です。これは、割り当てられた値がないことを示します。

BulkInsertOrder

String

並べ替え列の名前。各列は、昇順または降順で並べ替えることができます。並べ替え列を複数使用する場合、列の名前はコンマで区切ります。

BulkInsertTableName

String

データのコピー先となる、データベース内の SQL Server テーブルまたはビュー。

BulkInsertTablock

Boolean

一括挿入中にテーブルをロックするかどうかを指定する値。このプロパティの既定値は True です。

DefaultCodePage

Integer

コード ページに関する情報をデータ ソースから取得できない場合に使用するコード ページ。

MaxInsertCommitSize

Integer

バッチに挿入する行の最大数を示す値。値がゼロのときは、単一のバッチにすべての行が挿入されます。

Timeout

Integer

挿入できるデータがない場合、終了前に SQL Server 変換先が待機する秒数を指定する値。値を 0 に設定すると、SQL Server 変換先はタイムアウトしません。このプロパティの既定値は 30 です。

SQL Server 変換先の入力および入力列には、カスタム プロパティはありません。

詳細については、「SQL Server 変換先」を参照してください。