SqlBulkCopy.SqlRowsCopied Event

Definition

每次處理完 NotifyAfter 屬性指定的資料列數時就會發生。Occurs every time that the number of rows specified by the NotifyAfter property have been processed.

public:
 event System::Data::SqlClient::SqlRowsCopiedEventHandler ^ SqlRowsCopied;
public event System.Data.SqlClient.SqlRowsCopiedEventHandler SqlRowsCopied;
member this.SqlRowsCopied : System.Data.SqlClient.SqlRowsCopiedEventHandler 
Public Custom Event SqlRowsCopied As SqlRowsCopiedEventHandler 

Examples

下列主控台應用程式示範如何使用已開啟的連接來大量載入資料。The following console application demonstrates how to bulk load data using a connection that is already open. 已設定 NotifyAfter 屬性,以便在每50個數據列複製到資料表之後,呼叫事件處理常式。The NotifyAfter property is set so that the event handler is called after every 50 rows copied to the table.

在此範例中,會先使用連接從 SQL Server 資料表中,將資料讀取至 SqlDataReader 實例。In this example, the connection is first used to read data from a SQL Server table to a SqlDataReader instance. 請注意,來源資料不一定要位於 SQL Server 上;您可以使用任何可讀取至 IDataReader 或載入 DataTable的資料來源。Note that the source data does not have to be located on SQL Server; you can use any data source that can be read to an IDataReader or loaded to a DataTable.

Important

除非您已如大量複製範例設定中所述建立工作資料表,否則此範例不會執行。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 ... SELECT 語句來複製資料會更方便且快速。If 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("NotifyAfter Sample");
            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 up the event handler to notify after 50 rows.
                bulkCopy.SqlRowsCopied +=
                    new SqlRowsCopiedEventHandler(OnSqlRowsCopied);
                bulkCopy.NotifyAfter = 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 void OnSqlRowsCopied(
        object sender, SqlRowsCopiedEventArgs e)
    {
        Console.WriteLine("Copied {0} so far...", e.RowsCopied);
    }
    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("NotifyAfter Sample")
            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 up the event handler to notify after 50 rows.
                AddHandler bulkCopy.SqlRowsCopied, AddressOf OnSqlRowsCopied
                bulkCopy.DestinationTableName = _
                 "dbo.BulkCopyDemoMatchingColumns"
                bulkCopy.NotifyAfter = 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 Sub OnSqlRowsCopied(ByVal sender As Object, _
        ByVal args As SqlRowsCopiedEventArgs)
        Console.WriteLine("Copied {0} so far...", args.RowsCopied)
    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

Remarks

請注意,NotifyAfterBatchSize 的設定是獨立的。Note that the settings of NotifyAfter and BatchSize are independent. 接收 SqlRowsCopied 事件並不表示所有資料列都已傳送至伺服器或已認可。Receipt of a SqlRowsCopied event does not imply that any rows have been sent to the server or committed.

您無法從這個事件呼叫 SqlBulkCopy (Close)或 SqlConnection. Close (Close)。You cannot call SqlBulkCopy.Close (Close) or SqlConnection.Close (Close) from this event. 這麼做會導致擲回 InvalidOperationException,而 SqlBulkCopy 物件狀態則不會變更。Doing this will cause an InvalidOperationException being thrown, and the SqlBulkCopy object state will not change. 如果使用者想要從事件取消作業,則可以使用 SqlRowsCopiedEventArgsAbort 屬性。If the user wants to cancel the operation from the event, the Abort property of the SqlRowsCopiedEventArgs can be used. (如需使用 Abort 屬性的範例,請參閱交易和大量複製作業)。(See Transaction and Bulk Copy Operations for examples that use the Abort property.)

在執行大量複製作業期間,連接中不支援任何動作(例如交易活動),建議您不要使用 SqlRowsCopied 事件期間所使用的相同連接。No action, such as transaction activity, is supported in the connection during the execution of the bulk copy operation, and it is recommended that you not use the same connection used during the SqlRowsCopied event. 不過,您可以開啟不同的連接。However, you can open a different connection.

Applies to

See also