SqlBulkCopy クラス

定義

別のソースからのデータを SQL Server テーブルに効率的に一括読み込みすることができます。Lets you efficiently bulk load a SQL Server table with data from another source.

public ref class SqlBulkCopy sealed : IDisposable
public sealed class SqlBulkCopy : IDisposable
type SqlBulkCopy = class
    interface IDisposable
Public NotInheritable Class SqlBulkCopy
Implements IDisposable
継承
SqlBulkCopy
実装

次のコンソール アプリケーションでは、SqlBulkCopy クラスを使用してデータを読み込む方法について示しています。The following console application demonstrates how to load data using the SqlBulkCopy class. この例では、SqlDataReader を使用し、SQL Server の AdventureWorks データベースに格納された Production.Product テーブルのデータを、同じデータベース内の同等のテーブルにコピーします。In this example, a SqlDataReader is used to copy data from the Production.Product table in the SQL Server AdventureWorks database to a similar table in the same database.

重要

このサンプルは、「一括コピーのセットアップ例」で説明しているように作業テーブルを作成して取得してからでないと動作しません。This sample will not run unless you have created the work tables as described in Bulk Copy Example Setup. このコードでは、SqlBulkCopy だけを使用した構文について説明します。This code is provided to demonstrate the syntax for using SqlBulkCopy only. コピー元とコピー先のテーブルが同じ SQL Server インスタンス内にある場合は、Transact-sql ステートメントを使用してデータをコピーする方が簡単で高速です INSERT ... SELECTIf the source and destination tables are in the same SQL Server instance, it is easier and faster to use a Transact-SQL INSERT ... SELECT statement to copy the data.

using System.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();

            // Open the destination connection. In the real world you would
            // not use SqlBulkCopy to move data from one table to the other
            // in the same database. This is for demonstration purposes only.
            using (SqlConnection destinationConnection =
                       new SqlConnection(connectionString))
            {
                destinationConnection.Open();

                // Set up the bulk copy object.
                // Note that the column positions in the source
                // data reader match the column positions in
                // the destination table so there is no need to
                // map columns.
                using (SqlBulkCopy bulkCopy =
                           new SqlBulkCopy(destinationConnection))
                {
                    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;";
    }
}
Imports System.Data.SqlClient

Module Module1
    Sub Main()
        Dim connectionString As String = GetConnectionString()

        ' Open a connection to the AdventureWorks database.
        Using sourceConnection As SqlConnection = _
           New SqlConnection(connectionString)
            sourceConnection.Open()

            ' Perform an initial count on the destination table.
            Dim commandRowCount As New SqlCommand( _
            "SELECT COUNT(*) FROM dbo.BulkCopyDemoMatchingColumns;", _
                sourceConnection)
            Dim countStart As Long = _
               System.Convert.ToInt32(commandRowCount.ExecuteScalar())
            Console.WriteLine("Starting row count = {0}", countStart)

            ' Get data from the source table as a SqlDataReader.
            Dim commandSourceData As New SqlCommand( _
               "SELECT ProductID, Name, ProductNumber " & _
               "FROM Production.Product;", sourceConnection)
            Dim reader As SqlDataReader = commandSourceData.ExecuteReader

            ' Open the destination connection. In the real world you would 
            ' not use SqlBulkCopy to move data from one table to the other   
            ' in the same database. This is for demonstration purposes only.
            Using destinationConnection As SqlConnection = _
                New SqlConnection(connectionString)
                destinationConnection.Open()

                ' Set up the bulk copy object. 
                ' The column positions in the source data reader 
                ' match the column positions in the destination table, 
                ' so there is no need to map columns.
                Using bulkCopy As SqlBulkCopy = _
                  New SqlBulkCopy(destinationConnection)
                    bulkCopy.DestinationTableName = _
                    "dbo.BulkCopyDemoMatchingColumns"

                    Try
                        ' Write from the source to the destination.
                        bulkCopy.WriteToServer(reader)

                    Catch ex As Exception
                        Console.WriteLine(ex.Message)

                    Finally
                        ' Close the SqlDataReader. The SqlBulkCopy
                        ' object is automatically closed at the end
                        ' of the Using block.
                        reader.Close()
                    End Try
                End Using

                ' Perform a final count on the destination table
                ' to see how many rows were added.
                Dim countEnd As Long = _
                    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()
            End Using
        End Using
    End Sub

    Private Function GetConnectionString() As String
        ' 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;"
    End Function
End Module

注釈

Microsoft SQL Server には、1台のサーバーでもサーバー間でも、あるテーブルから別のテーブルにデータを移動するためのbcpという一般的なコマンドプロンプトユーティリティが含まれています。Microsoft SQL Server includes a popular command-prompt utility named bcp for moving data from one table to another, whether on a single server or between servers. クラスを使用すると、 SqlBulkCopy 同様の機能を提供するマネージコードソリューションを作成できます。The SqlBulkCopy class lets you write managed code solutions that provide similar functionality. SQL Server テーブル (INSERT ステートメントなど) にデータを読み込む方法は他にもありますが、 SqlBulkCopy それに比べてパフォーマンスが非常に優れています。There are other ways to load data into a SQL Server table (INSERT statements, for example), but SqlBulkCopy offers a significant performance advantage over them.

SqlBulkCopy クラスを使用すると、SQL Server のテーブルにのみデータを書き込むことができます。The SqlBulkCopy class can be used to write data only to SQL Server tables. ただし、データソースは SQL Server に限定されません。データをインスタンスに読み込んだり、インスタンスで読み取ることができる限り、任意のデータソースを使用でき DataTable IDataReader ます。However, the data source is not limited to SQL Server; any data source can be used, as long as the data can be loaded to a DataTable instance or read with a IDataReader instance.

SqlBulkCopyDataTable SqlDateTime が SQL Server 2008 に追加された日付/時刻型の1つである SQL Server 列に型の列を一括で読み込むと、は失敗します。SqlBulkCopy will fail when bulk loading a DataTable column of type SqlDateTime into a SQL Server column whose type is one of the date/time types added in SQL Server 2008.

コンストラクター

SqlBulkCopy(SqlConnection)

SqlConnection の指定されたオープン インスタンスを使用して、SqlBulkCopy クラスの新しいインスタンスを初期化しますInitializes a new instance of the SqlBulkCopy class using the specified open instance of SqlConnection.

SqlBulkCopy(SqlConnection, SqlBulkCopyOptions, SqlTransaction)

既に接続の確立されている SqlBulkCopy のインスタンスを使用し、SqlConnection クラスの新しいインスタンスを初期化します。Initializes a new instance of the SqlBulkCopy class using the supplied existing open instance of SqlConnection. SqlBulkCopy のインスタンスは、copyOptions パラメーターに指定されたオプションに従って動作します。The SqlBulkCopy instance behaves according to options supplied in the copyOptions parameter. null 以外の SqlTransaction が指定された場合、コピー操作はトランザクション内で実行されます。If a non-null SqlTransaction is supplied, the copy operations will be performed within that transaction.

SqlBulkCopy(String)

指定した connectionString に基づいて、SqlConnection の新しいインスタンスを初期化して開きます。Initializes and opens a new instance of SqlConnection based on the supplied connectionString. コンストラクターは、SqlConnection を使用して、SqlBulkCopy クラスの新しいインスタンスを初期化します。The constructor uses the SqlConnection to initialize a new instance of the SqlBulkCopy class.

SqlBulkCopy(String, SqlBulkCopyOptions)

指定された connectionString に基づいて、SqlConnection の新しいインスタンスを初期化し、接続を確立します。Initializes and opens a new instance of SqlConnection based on the supplied connectionString. このコンストラクターは、SqlConnection を使用して、SqlBulkCopy クラスの新しいインスタンスを初期化します。The constructor uses that SqlConnection to initialize a new instance of the SqlBulkCopy class. SqlConnection インスタンスは、copyOptions パラメーターで指定したオプションに従って動作します。The SqlConnection instance behaves according to options supplied in the copyOptions parameter.

プロパティ

BatchSize

バッチごとに処理される行数。Number of rows in each batch. 各バッチ処理の最後に、そこで処理された行がサーバーに送信されます。At the end of each batch, the rows in the batch are sent to the server.

BulkCopyTimeout

操作がタイムアウトするまでの秒数。Number of seconds for the operation to complete before it times out.

ColumnMappings

SqlBulkCopyColumnMapping は項目のコレクションを返します。Returns a collection of SqlBulkCopyColumnMapping items. 列マッピングは、データ ソース中の列とターゲット中の列の間の関係を定義します。Column mappings define the relationships between columns in the data source and columns in the destination.

DestinationTableName

サーバー上のコピー先テーブルの名前。Name of the destination table on the server.

EnableStreaming

IDataReader オブジェクトからデータをストリーミングする SqlBulkCopy オブジェクトを有効または無効にします。Enables or disables a SqlBulkCopy object to stream data from an IDataReader object.

NotifyAfter

通知イベントを生成する前に処理する行の数を定義します。Defines the number of rows to be processed before generating a notification event.

メソッド

Close()

SqlBulkCopy インスタンスを閉じます。Closes the SqlBulkCopy instance.

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。Determines whether the specified object is equal to the current object.

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す文字列を返します。Returns a string that represents the current object.

(継承元 Object)
WriteToServer(DataRow[])

示された DataRow 配列から、SqlBulkCopy オブジェクトの DestinationTableName のプロパティで指定された宛先のテーブルにすべての行をコピーします。Copies all rows from the supplied DataRow array to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServer(DataTable)

指定された DataTable のすべての行を、SqlBulkCopy オブジェクトの DestinationTableName プロパティで指定される宛先テーブルにコピーします。Copies all rows in the supplied DataTable to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServer(DataTable, DataRowState)

提供された DataTable 内の提供された行の状態と一致する行のみを、SqlBulkCopy オブジェクトの DestinationTableName のプロパティで指定されたコピー先のテーブルにコピーします。Copies only rows that match the supplied row state in the supplied DataTable to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServer(DbDataReader)

示された DbDataReader 配列から、SqlBulkCopy オブジェクトの DestinationTableName のプロパティで指定された宛先のテーブルにすべての行をコピーします。Copies all rows from the supplied DbDataReader array to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServer(IDataReader)

指定された IDataReader のすべての行を、SqlBulkCopy オブジェクトの DestinationTableName プロパティで指定される宛先テーブルにコピーします。Copies all rows in the supplied IDataReader to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServerAsync(DataRow[])

非同期バージョンの WriteToServer(DataRow[])。指定された DataRow 配列から、SqlBulkCopy オブジェクトの DestinationTableName プロパティで指定されたコピー先テーブルにすべての行をコピーします。The asynchronous version of WriteToServer(DataRow[]), which copies all rows from the supplied DataRow array to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServerAsync(DataRow[], CancellationToken)

非同期バージョンの WriteToServer(DataRow[])。指定された DataRow 配列から、SqlBulkCopy オブジェクトの DestinationTableName プロパティで指定されたコピー先テーブルにすべての行をコピーします。The asynchronous version of WriteToServer(DataRow[]), which copies all rows from the supplied DataRow array to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

キャンセル トークンを使用すると、コマンド タイムアウトが経過する前に操作を破棄するように要求できます。The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. 例外は、返されたタスク オブジェクトによって報告されます。Exceptions will be reported via the returned Task object.

WriteToServerAsync(DataTable)

非同期バージョンの WriteToServer(DataTable)。示された DataTable のすべての行を、SqlBulkCopy オブジェクトの DestinationTableName プロパティで指定された宛先のテーブルにコピーします。The asynchronous version of WriteToServer(DataTable), which copies all rows in the supplied DataTable to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServerAsync(DataTable, CancellationToken)

WriteToServer(DataTable) の非同期バージョン。指定した DataTable のすべての行を、DestinationTableName オブジェクトの SqlBulkCopy プロパティで指定された対象テーブルにコピーします。The asynchronous version of WriteToServer(DataTable), which copies all rows in the supplied DataTable to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

キャンセル トークンを使用すると、コマンド タイムアウトが経過する前に操作を破棄するように要求できます。The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. 例外は、返されたタスク オブジェクトによって報告されます。Exceptions will be reported via the returned Task object.

WriteToServerAsync(DataTable, DataRowState)

WriteToServer(DataTable, DataRowState) の非同期バージョン。指定された DataTable から、特定の状態に一致する行だけを、DestinationTableName オブジェクトの SqlBulkCopy プロパティで指定された対象テーブルにコピーします。The asynchronous version of WriteToServer(DataTable, DataRowState), which copies only rows that match the supplied row state in the supplied DataTable to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServerAsync(DataTable, DataRowState, CancellationToken)

非同期バージョンの WriteToServer(DataTable, DataRowState)。提供された DataTable 内の提供された行の状態と一致する行のみを、SqlBulkCopy オブジェクトの DestinationTableName のプロパティで指定されたコピー先のテーブルにコピーします。The asynchronous version of WriteToServer(DataTable, DataRowState), which copies only rows that match the supplied row state in the supplied DataTable to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

キャンセル トークンを使用すると、コマンド タイムアウトが経過する前に操作を破棄するように要求できます。The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. 例外は、返されたタスク オブジェクトによって報告されます。Exceptions will be reported via the returned Task object.

WriteToServerAsync(DbDataReader)

WriteToServer(DbDataReader) の非同期バージョン。指定した DbDataReader 配列のすべての行を、DestinationTableName オブジェクトの SqlBulkCopy プロパティで指定された対象テーブルにコピーします。The asynchronous version of WriteToServer(DbDataReader), which copies all rows from the supplied DbDataReader array to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServerAsync(DbDataReader, CancellationToken)

非同期バージョンの WriteToServer(DbDataReader)。指定された DbDataReader 配列から、SqlBulkCopy オブジェクトの DestinationTableName プロパティで指定されたコピー先テーブルにすべての行をコピーします。The asynchronous version of WriteToServer(DbDataReader), which copies all rows from the supplied DbDataReader array to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServerAsync(IDataReader)

非同期バージョンの WriteToServer(IDataReader)。示された IDataReader のすべての行を、SqlBulkCopy オブジェクトの DestinationTableName プロパティで指定された宛先のテーブルにコピーします。The asynchronous version of WriteToServer(IDataReader), which copies all rows in the supplied IDataReader to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServerAsync(IDataReader, CancellationToken)

WriteToServer(IDataReader) の非同期バージョン。指定した IDataReader のすべての行を、DestinationTableName オブジェクトの SqlBulkCopy プロパティで指定された対象テーブルにコピーします。The asynchronous version of WriteToServer(IDataReader), which copies all rows in the supplied IDataReader to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

キャンセル トークンを使用すると、コマンド タイムアウトが経過する前に操作を破棄するように要求できます。The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. 例外は、返されたタスク オブジェクトによって報告されます。Exceptions will be reported via the returned Task object.

イベント

SqlRowsCopied

NotifyAfter プロパティによって指定された行数が処理されるたびに発生します。Occurs every time that the number of rows specified by the NotifyAfter property have been processed.

明示的なインターフェイスの実装

IDisposable.Dispose()

SqlBulkCopy クラスの現在のインスタンスによって使用されているすべてのリソースを解放します。Releases all resources used by the current instance of the SqlBulkCopy class.

適用対象

こちらもご覧ください