SqlBulkCopy SqlBulkCopy SqlBulkCopy SqlBulkCopy Class

Определение

Позволяет эффективно выполнить массовую загрузку таблицы 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
Наследование
SqlBulkCopySqlBulkCopySqlBulkCopySqlBulkCopy
Реализации

Примеры

Следующее приложение командной строки демонстрирует, как загружать данные при помощи класса SqlBulkCopy.The following console application demonstrates how to load data using the SqlBulkCopy class. В этом примере SqlDataReader используется для копирования данных из таблицы Production. Product из базы данных SQL Server AdventureWorks в аналогичную таблицу в той же базе данных.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, то проще и быстрее использовать инструкцию INSERT … SELECT Transact-SQL для копирования данных.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("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 SqlCommand = 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 включает популярную программу командной строки с именем 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.

SqlBulkCopyзавершается ошибкой при выполнении многостраничной DataTable загрузки SqlDateTime столбца типа в SQL Server столбец, тип которого является одним из типов даты и времени, добавленных в SQL Server 2008.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) SqlBulkCopy(SqlConnection) SqlBulkCopy(SqlConnection) SqlBulkCopy(SqlConnection)

Инициализирует новый экземпляр класса SqlBulkCopy, используя открытый экземпляр SqlConnection.Initializes a new instance of the SqlBulkCopy class using the specified open instance of SqlConnection.

SqlBulkCopy(SqlConnection, SqlBulkCopyOptions, SqlTransaction) SqlBulkCopy(SqlConnection, SqlBulkCopyOptions, SqlTransaction) SqlBulkCopy(SqlConnection, SqlBulkCopyOptions, SqlTransaction) 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. Если задан объект SqlTransaction, не равный null, операция копирования выполняется в рамках транзакции.If a non-null SqlTransaction is supplied, the copy operations will be performed within that transaction.

SqlBulkCopy(String) SqlBulkCopy(String) SqlBulkCopy(String) SqlBulkCopy(String)

Инициализирует и открывает новый экземпляр классаSqlConnection с использованием заданной connectionString.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) SqlBulkCopy(String, SqlBulkCopyOptions) SqlBulkCopy(String, SqlBulkCopyOptions) SqlBulkCopy(String, SqlBulkCopyOptions)

Инициализирует и открывает новый экземпляр классаSqlConnection с использованием заданной connectionString.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 BatchSize BatchSize BatchSize

Количество строк в каждом пакете.Number of rows in each batch. В конце каждого пакета серверу отправляется количество содержащихся в нем строк.At the end of each batch, the rows in the batch are sent to the server.

BulkCopyTimeout BulkCopyTimeout BulkCopyTimeout BulkCopyTimeout

Таймаут завершения операции в миллисекундах.Number of seconds for the operation to complete before it times out.

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

Имя целевой таблицы на сервере.Name of the destination table on the server.

EnableStreaming EnableStreaming EnableStreaming EnableStreaming

Включение или отключение объекта SqlBulkCopy для потоковой передачи данных из объекта IDataReaderEnables or disables a SqlBulkCopy object to stream data from an IDataReader object

NotifyAfter NotifyAfter NotifyAfter NotifyAfter

Определяет количество строк, обрабатываемых перед генерированием уведомляющего события.Defines the number of rows to be processed before generating a notification event.

Методы

Close() Close() Close() Close()

Закрывает экземпляр SqlBulkCopy.Closes the SqlBulkCopy instance.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)
WriteToServer(DataRow[]) WriteToServer(DataRow[]) WriteToServer(DataRow[]) WriteToServer(DataRow[])

Копирует все строки из заданного массива DataRow в целевую таблицу, указанную в свойстве DestinationTableName объекта SqlBulkCopy.Copies all rows from the supplied DataRow array to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServer(DataTable) WriteToServer(DataTable) WriteToServer(DataTable) WriteToServer(DataTable)

Копирует все строки из заданного объекта DataTable в целевую таблицу, указанную в свойстве DestinationTableName объекта SqlBulkCopy.Copies all rows in the supplied DataTable to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServer(DataTable, DataRowState) WriteToServer(DataTable, DataRowState) WriteToServer(DataTable, DataRowState) WriteToServer(DataTable, DataRowState)

Копирует только строки, соответствующие заданному состоянию строки, из заданного объекта DataTable в целевую таблицу, указанную в свойстве DestinationTableName объекта SqlBulkCopy.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) WriteToServer(DbDataReader) WriteToServer(DbDataReader) WriteToServer(DbDataReader)

Копирует все строки из заданного массива DbDataReader в целевую таблицу, указанную в свойстве DestinationTableName объекта SqlBulkCopy.Copies all rows from the supplied DbDataReader array to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServer(IDataReader) WriteToServer(IDataReader) WriteToServer(IDataReader) WriteToServer(IDataReader)

Копирует все строки из заданного объекта IDataReader в целевую таблицу, указанную в свойстве DestinationTableName объекта SqlBulkCopy.Copies all rows in the supplied IDataReader to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.

WriteToServerAsync(DataRow[]) WriteToServerAsync(DataRow[]) WriteToServerAsync(DataRow[]) WriteToServerAsync(DataRow[])

Асинхронная версия метода WriteToServer(DataRow[]), который копирует все строки из предоставленного массива DataRow в целевую таблицу, заданную свойством DestinationTableName объекта SqlBulkCopy.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) WriteToServerAsync(DataRow[], CancellationToken) WriteToServerAsync(DataRow[], CancellationToken) WriteToServerAsync(DataRow[], CancellationToken)

Асинхронная версия метода WriteToServer(DataRow[]), который копирует все строки из предоставленного массива DataRow в целевую таблицу, заданную свойством DestinationTableName объекта SqlBulkCopy.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. Сведения об исключениях передаются в возвращенном объекте Task.Exceptions will be reported via the returned Task object.

WriteToServerAsync(DataTable) WriteToServerAsync(DataTable) WriteToServerAsync(DataTable) WriteToServerAsync(DataTable)

Асинхронная версия метода 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.

WriteToServerAsync(DataTable, CancellationToken) WriteToServerAsync(DataTable, CancellationToken) WriteToServerAsync(DataTable, CancellationToken) 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. Сведения об исключениях передаются в возвращенном объекте Task.Exceptions will be reported via the returned Task object.

WriteToServerAsync(DataTable, DataRowState) WriteToServerAsync(DataTable, DataRowState) WriteToServerAsync(DataTable, DataRowState) 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) WriteToServerAsync(DataTable, DataRowState, CancellationToken) WriteToServerAsync(DataTable, DataRowState, CancellationToken) WriteToServerAsync(DataTable, DataRowState, CancellationToken)

Асинхронная версия метода 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.

Токен отмены можно использовать для запроса отказа от операции до истечения времени ожидания команды.The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Сведения об исключениях передаются в возвращенном объекте Task.Exceptions will be reported via the returned Task object.

WriteToServerAsync(DbDataReader) WriteToServerAsync(DbDataReader) WriteToServerAsync(DbDataReader) 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) WriteToServerAsync(DbDataReader, CancellationToken) WriteToServerAsync(DbDataReader, CancellationToken) WriteToServerAsync(DbDataReader, CancellationToken)

Асинхронная версия метода 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(IDataReader) WriteToServerAsync(IDataReader) WriteToServerAsync(IDataReader) WriteToServerAsync(IDataReader)

Асинхронная версия метода 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.

WriteToServerAsync(IDataReader, CancellationToken) WriteToServerAsync(IDataReader, CancellationToken) WriteToServerAsync(IDataReader, CancellationToken) 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. Сведения об исключениях передаются в возвращенном объекте Task.Exceptions will be reported via the returned Task object.

События

SqlRowsCopied SqlRowsCopied SqlRowsCopied SqlRowsCopied

Генерируется всякий раз после обработки количества строк, заданного в свойстве NotifyAfter.Occurs every time that the number of rows specified by the NotifyAfter property have been processed.

Явные реализации интерфейса

IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose() IDisposable.Dispose()

Освобождает все ресурсы, используемые текущим экземпляром класса SqlBulkCopy.Releases all resources used by the current instance of the SqlBulkCopy class.

Применяется к

Дополнительно