SqlBulkCopyOptions 列挙型

定義

SqlBulkCopyのインスタンスで使用する 1 つ以上のオプションを指定するビットごとのフラグ。

この列挙体は、メンバー値のビットごとの組み合わせをサポートしています。

public enum class SqlBulkCopyOptions
[System.Flags]
public enum SqlBulkCopyOptions
[<System.Flags>]
type SqlBulkCopyOptions = 
Public Enum SqlBulkCopyOptions
継承
SqlBulkCopyOptions
属性

フィールド

名前 説明
Default 0

すべてのオプションに既定値を使用します。

KeepIdentity 1

ソースの ID 値が保持されます。 指定しない場合、ID 値は宛先によって割り当てられます。

CheckConstraints 2

データが挿入される際の制約をチェックします。 既定では、制約はチェックされません。

TableLock 4

一括コピー操作の実行中、一括更新のロックを取得します。 指定しない場合は、行ロックが使用されます。

KeepNulls 8

既定値の設定に関係なく、コピー先のテーブル内の null 値が保持されます。 指定しない場合、null 値は既定値に置き換えられます (該当する場合)。

FireTriggers 16

指定すると、データベースに挿入される行の挿入トリガーがサーバーによって起動されます。

UseInternalTransaction 32

指定すると、一括コピー操作の各バッチがトランザクション内で発生します。 このオプションを指定し、コンストラクターに SqlTransaction オブジェクトを指定すると、 ArgumentException が発生します。

AllowEncryptedValueModifications 64

AllowEncryptedValueModifications を指定すると、データの暗号化を解除せずに、テーブルまたはデータベース間で暗号化されたデータを一括コピーできます。 一般的に、アプリケーションはデータを復号せずに 1 つのテーブルの暗号化された列からデータを選択し (アプリは、列の暗号化設定キーワードを無効に設定しているデータベースに接続します)、それからこのオプションを使用し、依然として暗号化されたままのデータを一括挿入します。

AllowEncryptedValueModifications を指定すると、データが実際に暗号化されているかどうか、またはターゲット列と同じ暗号化の種類、アルゴリズム、キーを使用して正しく暗号化されているかどうかがドライバーによってチェックされないため、データベースが破損する可能性があるため、注意が必要です。

CacheMetadata 128

指定すると、 CacheMetadata は最初の一括コピー操作の後にコピー先テーブルのメタデータをキャッシュし、同じテーブルに対する後続の操作でメタデータ検出クエリをスキップできるようにします。 これにより、同じコピー先テーブルに対して複数の一括コピー操作を実行する場合のパフォーマンスが向上します。

警告: このオプションは、コピー先のテーブル スキーマが一括コピー操作間で変更されないことが確実な場合にのみ使用します。 テーブル スキーマが変更された場合 (列の追加、削除、または変更)、キャッシュされたメタデータを使用すると、データの破損、操作の失敗、または予期しない動作が発生する可能性があります。 スキーマが変更された場合は、 ClearCachedMetadata() を呼び出してキャッシュをクリアします。

DestinationTableNameが別のテーブルに変更されると、キャッシュは自動的に無効になります。 操作間で ColumnMappings を変更する場合、キャッシュされたメタデータはソースと宛先の列のマッピングではなく、変換先テーブル スキーマのみを記述するため、キャッシュの無効化は必要ありません。

接続コンテキストが変更された場合、キャッシュは自動的に無効になりません。 基になる SqlConnection が (たとえば、 ChangeDatabase(String)経由で) データベースを変更したり、フェールオーバーのために別のサーバーに再接続したりした場合、呼び出し元は ClearCachedMetadata() を呼び出してメタデータが更新されるようにする必要があります。

次のコンソール アプリケーションは、各行の ID 列に新しい値を生成するのではなく、ソース テーブルの ID 列の値をコピー先テーブルの対応する列にコピーする一括読み込みを実行する方法を示しています。

一括読み込みの動作方法をオプションで変更する方法を確認するには、dbo を使用してサンプルを実行します 。BulkCopyDemoMatchingColumns テーブルが空です。 すべての行がソースから読み込まれます。 次に、テーブルを空にせずにサンプルをもう一度実行します。 例外がスローされ、主キー違反のために行が追加されなかったことを通知するメッセージがコンソール ウィンドウに書き込まれます。

Important

このサンプルは、「バルク コピー サンプルのセットアップ」で説明されているように作業テーブルを作成してからでないと動作しません。 このコードでは、SqlBulkCopy だけを使用した構文について説明します。 ソース テーブルと変換先テーブルが同じ SQL Server インスタンス内にある場合は、Transact-SQL INSERT … SELECT ステートメントを使用してデータをコピーする方が簡単かつ迅速です。

namespace SqlBulkCopy_KeepIdentity;

using System;
using System.Data;
// <Snippet1>
using Microsoft.Data.SqlClient;

class Program
{
    static void Main()
    {
        string connectionString = GetConnectionString();
        // Open a sourceConnection to the AdventureWorks database.
        using (SqlConnection sourceConnection =
                   new SqlConnection(connectionString))
        {
            sourceConnection.Open();

            // Perform an initial count on the destination table.
            SqlCommand commandRowCount = new SqlCommand(
                "SELECT COUNT(*) FROM " +
                "dbo.BulkCopyDemoMatchingColumns;",
                sourceConnection);
            long countStart = System.Convert.ToInt32(
                commandRowCount.ExecuteScalar());
            Console.WriteLine("Starting row count = {0}", countStart);

            // Get data from the source table as a SqlDataReader.
            SqlCommand commandSourceData = new SqlCommand(
                "SELECT ProductID, Name, " +
                "ProductNumber " +
                "FROM Production.Product;", sourceConnection);
            SqlDataReader reader =
                commandSourceData.ExecuteReader();

            // Create the SqlBulkCopy object using a connection string 
            // and the KeepIdentity option. 
            // In the real world you would not use SqlBulkCopy to move
            // data from one table to the other in the same database.
            using (SqlBulkCopy bulkCopy =
                new SqlBulkCopy(connectionString, SqlBulkCopyOptions.KeepIdentity))
            {
                bulkCopy.DestinationTableName =
                    "dbo.BulkCopyDemoMatchingColumns";

                try
                {
                    // Write from the source to the destination.
                    bulkCopy.WriteToServer(reader);
                }
                catch (Exception ex)
                {
                    Console.WriteLine(ex.Message);
                }
                finally
                {
                    // Close the SqlDataReader. The SqlBulkCopy
                    // object is automatically closed at the end
                    // of the using block.
                    reader.Close();
                }
            }

            // Perform a final count on the destination 
            // table to see how many rows were added.
            long countEnd = System.Convert.ToInt32(
                commandRowCount.ExecuteScalar());
            Console.WriteLine("Ending row count = {0}", countEnd);
            Console.WriteLine("{0} rows were added.", countEnd - countStart);
            Console.WriteLine("Press Enter to finish.");
            Console.ReadLine();
        }
    }

    private static string GetConnectionString()
    // To avoid storing the sourceConnection string in your code, 
    // you can retrieve it from a configuration file. 
    {
        return "Data Source=(local); " +
            " Integrated Security=true;" +
            "Initial Catalog=AdventureWorks;";
    }
}
// </Snippet1>

注釈

SqlBulkCopy インスタンスを構築するときに、SqlBulkCopyOptions列挙型を使用して、そのインスタンスのWriteToServer(DbDataReader) メソッドの動作を変更できます。

適用対象