SQL Server XML 一括読み込みオブジェクト モデル (SQLXML 4.0)

  • [アーティクル]

適用対象:SQL ServerAzure SQL Database

Microsoft SQL Server XML 一括読み込みオブジェクト モデルは、SQLXMLBulkLoad オブジェクトで構成されます。 このオブジェクトでは、次のメソッドとプロパティがサポートされます。

メソッド

実行
パラメーターとして渡されるスキーマ ファイルとデータ ファイル (またはストリーム) を使用して、データの一括読み込みを行います。

プロパティ

BulkLoad
一括読み込みを実行するかどうかを指定します。 このプロパティは、スキーマのみを生成し (SchemaGen、SGDropTables、および次の SGUseID プロパティを参照)、一括読み込みを実行しない場合に便利です。 このプロパティはブール値をとります。 このプロパティを TRUE に設定すると、XML 一括読み込みが行われます。 FALSE に設定すると、XML 一括読み込みは行われません。

既定値は TRUE です。

CheckConstraints
一括読み込みで列にデータを挿入するときに、列に指定されている制約 (列間の主キー/外部キーのリレーションシップによる制約など) をチェックするかどうかを指定します。 このプロパティはブール値をとります。

このプロパティを TRUE に設定すると、XML 一括読み込みで挿入される値ごとに制約がチェックされ、制約違反があるとエラーが発生します。

注意

このプロパティを FALSE のままにするには、ターゲット テーブルに対する ALTER TABLE 権限が必要です。 詳細については、「ALTER TABLE (Transact-SQL)」を参照してください。

既定値は FALSE です。 FALSE に設定した場合、XML 一括読み込みでは挿入操作中、制約が無視されます。 現在の実装では、マッピング スキーマの主キーと外部キーのリレーションシップの順序でテーブルを定義する必要があります。 つまり、主キーが設定されているテーブルは、外部キーが設定されている対応テーブルよりも前に定義する必要があります。このように定義しない場合、XML 一括読み込みは失敗します。

ID 配布が実行されている場合は、このオプションは適用されず、制約チェックはオンのままになる点に注意してください。 これに該当するのは、親が ID フィールドで、その値が生成時に子に指定されるリレーションシップが定義されており、かつ KeepIdentity=False の場合です。

ConnectionCommand
XML 一括読み込みで使用する既存の接続オブジェクト (ADO または ICommand コマンド オブジェクトなど) を識別します。 ConnectionString プロパティで接続文字列を指定する代わりに、ConnectionCommand プロパティを使用できます。 ConnectionCommand を使用する場合は、Transaction プロパティを TRUE に設定する必要があります。

ConnectionString プロパティと ConnectionCommand プロパティの両方を使用する場合、XML 一括読み込みでは最後に指定したプロパティが使用されます。

既定値は NULL です。

ConnectionString
データベース インスタンスへの接続の確立に必要な情報を提供する OLE DB 接続文字列を指定します。 ConnectionString プロパティと ConnectionCommand プロパティの両方を使用する場合、XML 一括読み込みでは最後に指定したプロパティが使用されます。

既定値は NULL です。

ErrorLogFile
XML 一括読み込みでエラーとメッセージを記録するログ ファイル名を指定します。 既定値は空文字列で、この場合ログは記録されません。

FireTriggers
一括読み込み操作中に、対象テーブルに定義されているトリガーを起動するかどうかを指定します。 既定値は FALSE です。

TRUE に設定した場合は、挿入操作中、トリガーが通常どおり起動されます。

注意

このプロパティを FALSE のままにするには、ターゲット テーブルに対する ALTER TABLE 権限が必要です。 詳細については、「ALTER TABLE (Transact-SQL)」を参照してください。

ID 配布が実行されている場合は、このオプションは適用されず、トリガーはオンのままになる点に注意してください。 これに該当するのは、親が ID フィールドで、その値が生成時に子に指定されるリレーションシップが定義されており、かつ KeepIdentity=False の場合です。

ForceTableLock
XML 一括読み込みでデータをコピーするテーブルを、一括読み込み中にロックするかどうかを指定します。 このプロパティはブール値をとります。 このプロパティを TRUE に設定すると、XML 一括読み込み中、テーブルはロックされます。 FALSE に設定すると、XML 一括読み込みでテーブルにレコードが挿入されるときに、毎回テーブルがロックされます。

既定値は FALSE です。

IgnoreDuplicateKeys
キー列に挿入される値が重複している場合の動作を指定します。 このプロパティが TRUE に設定されていて、キー列に重複する値を持つレコードを挿入しようとすると、SQL Serverはそのレコードを挿入しません。 しかし、その後に続くレコードは挿入されるので、一括読み込み操作は失敗しません。 このプロパティを FALSE に設定すると、キー列に挿入される値が重複している場合、一括読み込みは失敗します。

IgnoreDuplicateKeys プロパティを TRUE に設定すると、テーブルに挿入されるすべてのレコードに対して COMMIT ステートメントが発行されます。 このため、パフォーマンスが低下します。 トランザクション動作はファイルを使用して実装されるため、Transaction プロパティが FALSE に設定されている場合にのみ、 プロパティを TRUE に設定できます。

既定値は FALSE です。

KeepIdentity
ソース ファイルにある ID 型列値の取り扱い方法を指定します。 このプロパティはブール値をとります。 このプロパティを TRUE に設定すると、XML 一括読み込みでは、ソース ファイルで指定されている値が ID 列に割り当てられます。 このプロパティを FALSE に設定すると、一括読み込み操作では、ソースで指定されている ID 列値は無視されます。 この場合、SQL Serverは ID 列に値を割り当てます。

一括読み込みには、SQL Server生成された値が格納されている ID 列を参照する外部キーである列が含まれている場合、一括読み込みでは、これらの ID 値が外部キー列に適切に伝達されます。

このプロパティの値は、一括読み込みの対象となるすべての列に適用されます。 既定値は TRUE です。

注意

このプロパティを TRUE のままにするには、ターゲット テーブルに対する ALTER TABLE 権限が必要です。 この権限がない場合は、値を FALSE に設定する必要があります。 詳細については、「ALTER TABLE (Transact-SQL)」を参照してください。

KeepNulls
列に対応する属性または子要素が XML ドキュメントに見つからない場合に、その列に使用する値を指定します。 このプロパティはブール値をとります。 このプロパティを TRUE に設定すると、XML 一括読み込みでは列に NULL 値が割り当てられます。 サーバーで列の既定値が設定されている場合でも、その既定値は割り当てられません。 このプロパティの値は、一括読み込みの対象となるすべての列に適用されます。

既定値は FALSE です。

SchemaGen
一括読み込み操作の前に、必要なテーブルを作成するかどうかを指定します。 このプロパティはブール値をとります。 このプロパティを TRUE に設定すると、マッピング スキーマで指定されているテーブルが作成されます (データベースは存在している必要があります)。 1 つ以上のテーブルがデータベースに既に存在する場合、SGDropTables プロパティは、これらの既存のテーブルを削除して再作成するかどうかを決定します。

SchemaGen プロパティの既定値は FALSE です。 SchemaGen では、新しく作成されたテーブルに PRIMARY KEY 制約は作成されません。 ただし、SchemaGen では、マッピング スキーマで一致する sql:relationship と sql:key-fields 注釈が見つかる場合、およびキー フィールドが 1 つの列で構成されている場合は、データベースに FOREIGN KEY 制約が作成されます。

SchemaGen プロパティを TRUE に設定すると、XML 一括読み込みでは次の処理が行われます。

  • 要素名と属性名から、必要なテーブルを作成します。 そのため、スキーマ内の要素名と属性名SQL Server予約語を使用しないことが重要です。

  • xml データ型形式で sql:overflow-field を使用して指定された列のオーバーフロー データを返します。

SGDropTables
既存のテーブルを削除し、再作成するかどうかを指定します。 このプロパティは、SchemaGen プロパティが TRUE に設定されている場合に使用します。 SGDropTables が FALSE の場合、既存のテーブルは保持されます。 このプロパティが TRUE の場合、既存のテーブルは削除され再作成されます。

既定値は FALSE です。

SGUseID
テーブルの作成時に、 ID 型として識別されるマッピング スキーマ内の属性を PRIMARY KEY 制約の作成時に使用できるかどうかを指定します。 SchemaGen プロパティが TRUE に設定されている場合は、このプロパティを使用します。 SGUseID が TRUE の場合、SchemaGen ユーティリティは dt :type="id" が 主キー列として指定される属性を使用し、テーブルの作成時に適切な PRIMARY KEY 制約を追加します。

既定値は FALSE です。

Tempfilepath
XML 一括読み込みで、読み込んだデータ用の一時ファイルを作成するファイル パスを指定します。 (このプロパティは、Transaction プロパティが TRUE に設定されている場合にのみ役立ちます)。XML 一括読み込みに使用されるSQL Server アカウントがこのパスにアクセスできることを確認する必要があります。 このプロパティを設定しない場合、XML 一括読み込みでは、TEMP 環境変数で指定された場所に一時ファイルが格納されます。

トランザクション
一括読み込みをトランザクションとして実行するよう指定します。この場合、一括読み込みが失敗するとロールバックが実行されます。 このプロパティはブール値をとります。 このプロパティを TRUE に設定すると、一括読み込みはトランザクション コンテキストで実行されます。 TempFilePath プロパティは、Transaction が TRUE に設定されている場合にのみ役立ちます。

注意

バイナリ データ (bin.hex、bin.base64 XML データ型など) をバイナリデータ型、画像データ型、SQL Serverデータ型に読み込む場合は、Transaction プロパティを FALSE に設定する必要があります。

既定値は FALSE です。

XMLFragment
ソース データが XML フラグメントであるかどうかを指定します。 XML フラグメントとは、最上位 (ルート) 要素のない、単一の XML ドキュメントです。 このプロパティはブール値をとります。 ソース ファイルに XML フラグメントが含まれている場合は、このプロパティを TRUE に設定する必要があります。

既定値は FALSE です。