SqlBulkCopy.BatchSize プロパティ

.NET Framework クラス ライブラリ リファレンス

SqlBulkCopy.BatchSize プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

バッチごとに処理される行数。各バッチ処理の最後に、そこで処理された行がサーバーに送信されます。

名前空間: System.Data.SqlClient
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Property BatchSize As
 Integer

Visual Basic (使用法)

Dim instance As SqlBulkCopy
Dim value As Integer

value = instance.BatchSize

instance.BatchSize = value

C#

public int BatchSize { get;
 set; }

C++

public:
property int BatchSize {
    int get ();
    void set (int value);
}

J#

/** @property */
public int get_BatchSize ()

/** @property */
public void set_BatchSize (int
 value)

JScript

public function get BatchSize
 () : int

public function set BatchSize
 (value : int)

プロパティ値
BatchSize プロパティの整数値。値が設定されなかった場合はゼロ。

解説

1 回のバッチ処理は、BatchSize に指定された行数が処理されるか、対象のデータ ソースに送信する行がなくなった時点で完了します。

ゼロ (既定値) は、各 WriteToServer 操作が単一のバッチ処理で行われることを示します。

UseExternalTransactions オプションを有効にして SqlBulkCopy のインスタンスを宣言した場合、BatchSize に指定された行数が一度にサーバーに送信されますが、トランザクション関連の処理は実行されません。UseExternalTransaction が無効にされている場合、バッチごとの行が別個のトランザクションとして挿入されます。

BatchSize プロパティは、どの時点でも設定できます。一括コピーが進行中の場合、現在のバッチ サイズは、前回のバッチ サイズに基づいて設定されます。それ以降のバッチ処理では、新たに設定されたサイズが使用されます。最初は BatchSize をゼロに設定しておき、その後、この値を WriteToServer 操作の進行中に変更した場合、その操作については、データが単一のバッチとして読み込まれます。同じ SqlBulkCopy のインスタンスに対するそれ以降の WriteToServer 操作では、新しい BatchSize が使用されます。

使用例

次のコンソール アプリケーションでは、バッチ サイズを 50 行に設定して、データの一括読み込みを実行します。BatchSize のトランザクションに与える影響の例については、「トランザクションでのバルク コピー操作の実行」を参照してください。

この例では、ソース データは最初に SQL Server テーブルから SqlDataReader インスタンスに読み込まれます。なお、ソース データについては、SQL Server に格納されている必要はありません。IDataReader での読み取りと、DataTable への読み込みが可能であれば、どのようなデータ ソースでも使用できます。

重要 :
このサンプルを実行するには、あらかじめ、「バルク コピーの例のためのテーブルの作成」の説明に従って作業テーブルを作成しておく必要があります。このコードは、SqlBulkCopy を使用する構文を示すためだけに提供されています。同じ SQL Server インスタンスにコピー元テーブルとコピー先テーブルが存在する場合、Transact-SQL の INSERT … SELECT ステートメントを使用した方が容易かつ迅速にデータをコピーできます。

Visual Basic

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 SqlCommand
 = New SqlCommand( _
               "SELECT ProductID, Name, ProductNumber "
 & _
               "FROM Production.Product;", sourceConnection)
            Dim reader As SqlDataReader = commandSourceData.ExecuteReader

            ' Create the SqlBulkCopy object using a connection string.
 
            ' In the real world you would not use SqlBulkCopy to move
            ' data from one table to the other in the same database.
            Using bulkCopy As SqlBulkCopy = _
              New SqlBulkCopy(connectionString)
                bulkCopy.DestinationTableName = "dbo.BulkCopyDemoMatchingColumns"

                ' Set the BatchSize.
                bulkCopy.BatchSize = 50

                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 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

C#

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();

            // Create the SqlBulkCopy object using a connection string.
 
            // 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))
            {
                bulkCopy.DestinationTableName =
                    "dbo.BulkCopyDemoMatchingColumns";

                // Set the BatchSize.
                bulkCopy.BatchSize = 50;

                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;";
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SqlBulkCopy クラス
SqlBulkCopy メンバ
System.Data.SqlClient 名前空間
その他の技術情報
バルク コピー操作の実行