SqlBulkCopy Class

.NET Framework 4

Other Versions

• .NET Framework 3.5
• .NET Framework 3.0
• .NET Framework 2.0

 

Lets you efficiently bulk load a SQL Server table with data from another source.

Inheritance Hierarchy

---

System.Object
   System.Data.SqlClient.SqlBulkCopy

 

Namespace:   System.Data.SqlClient
Assembly:   System.Data (in System.Data.dll)

Syntax

---

VB

C#

C++

F#

JScript

Copy

public sealed class SqlBulkCopy : IDisposable

The SqlBulkCopy type exposes the following members.

Constructors

---

	Name	Description
	SqlBulkCopy(SqlConnection)	Initializes a new instance of the SqlBulkCopy class using the specified open instance of SqlConnection.
	SqlBulkCopy(String)	Initializes and opens a new instance of SqlConnection based on the supplied connectionString. The constructor uses the SqlConnection to initialize a new instance of the SqlBulkCopy class.
	SqlBulkCopy(String, SqlBulkCopyOptions)	Initializes and opens a new instance of SqlConnection based on the supplied connectionString. The constructor uses that SqlConnection to initialize a new instance of the SqlBulkCopy class. The SqlConnection instance behaves according to options supplied in the copyOptions parameter.
	SqlBulkCopy(SqlConnection, SqlBulkCopyOptions, SqlTransaction)	Initializes a new instance of the SqlBulkCopy class using the supplied existing open instance of SqlConnection. The SqlBulkCopy instance behaves according to options supplied in the copyOptions parameter. If a non-null SqlTransaction is supplied, the copy operations will be performed within that transaction.

Top

Properties

---

	Name	Description
	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	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.
	NotifyAfter	Defines the number of rows to be processed before generating a notification event.

Top

Methods

---

	Name	Description
	Close	Closes the SqlBulkCopy instance.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteToServer(DataRow[])	Copies all rows from the supplied DataRow array to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.
	WriteToServer(DataTable)	Copies all rows in the supplied DataTable to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.
	WriteToServer(IDataReader)	Copies all rows in the supplied IDataReader to a destination table specified by the DestinationTableName property of the SqlBulkCopy object.
	WriteToServer(DataTable, DataRowState)	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.

Top

Events

---

	Name	Description
	SqlRowsCopied	Occurs every time that the number of rows specified by the NotifyAfter property have been processed.

Top

Explicit Interface Implementations

---

	Name	Description
	IDisposable.Dispose	Releases all resources used by the current instance of the SqlBulkCopy class.

Top

Remarks

---

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. The SqlBulkCopy class lets you write managed code solutions that provide similar functionality. 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.

The SqlBulkCopy class can be used to write data only to SQL Server tables. 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 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.

Examples

---

The following console application demonstrates how to load data using the SqlBulkCopy class. In this example, a SqlDataReader is used to copy data from the Production.Product table in the SQL Server 2005 AdventureWorks database to a similar table in the same database.

Important
This sample will not run unless you have created the work tables as described in Bulk Copy Example Setup (ADO.NET). This code is provided to demonstrate the syntax for using SqlBulkCopy only. 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.

VB

C#

C++

F#

JScript

Copy

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

Version Information

---

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

---

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role not supported), Windows Server 2003 SP2

 

 

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety

---

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

---

Reference

System.Data.SqlClient Namespace

Other Resources

Bulk Copy Operations in SQL Server (ADO.NET)

Community Content Add

FAQ

error The locale id '1033' of the source column 'col1' and the locale id '1025' of the destination c

i did the same thing..... $0$0 $0 $0and i add collation....$0 $0$0 $0 $0also i add collation row mapping...$0 $0$0 $0 $0but this error $0 $0$0 $0 $0 The locale id '1033' of the source column 'col1' and the locale id '1025' of the destination column 'col1' do not match.$0 $0$0 $0 $0still appear$0 $0$0 $0 $0and help????$0

History

• 2/14/2011
• MABUSAFIAH

Very helpful article.

This command is very helpful and same i have implemented in SSIS, where data is comming from ~100 sources in multiple files.

Cheers

History

• 12/28/2010
• Ravinder Sirohi

No error-handling documentation at all.

Very superficial. No documentation to be found anywhere regarding error handling or error logging with the SqlBulkCopy class. Any errors thrown due to things like key violations never result in any of the rows (or even the DataSet itself) having the HasError flag turned on. How to find these problematic rows without this?