This topic has not yet been rated - Rate this topic

SqlBulkCopyColumnMappingCollection Class

Collection of SqlBulkCopyColumnMapping objects that inherits from CollectionBase.

System.Object
  System.Collections.CollectionBase
    System.Data.SqlClient.SqlBulkCopyColumnMappingCollection

Namespace:  System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)
public sealed class SqlBulkCopyColumnMappingCollection : CollectionBase

The SqlBulkCopyColumnMappingCollection type exposes the following members.

  Name Description
Public property Capacity Gets or sets the number of elements that the CollectionBase can contain. (Inherited from CollectionBase.)
Public property Count Gets the number of elements contained in the CollectionBase instance. This property cannot be overridden. (Inherited from CollectionBase.)
Protected property InnerList Gets an ArrayList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Public property Item Gets the SqlBulkCopyColumnMapping object at the specified index.
Protected property List Gets an IList containing the list of elements in the CollectionBase instance. (Inherited from CollectionBase.)
Top
  Name Description
Public method Add(SqlBulkCopyColumnMapping) Adds the specified mapping to the SqlBulkCopyColumnMappingCollection.
Public method Add(Int32, Int32) Creates a new SqlBulkCopyColumnMapping and adds it to the collection, using ordinals to specify both source and destination columns.
Public method Add(Int32, String) Creates a new SqlBulkCopyColumnMapping and adds it to the collection, using an ordinal for the source column and a string for the destination column.
Public method Add(String, Int32) Creates a new SqlBulkCopyColumnMapping and adds it to the collection, using a column name to describe the source column and an ordinal to specify the destination column.
Public method Add(String, String) Creates a new SqlBulkCopyColumnMapping and adds it to the collection, using column names to specify both source and destination columns.
Public method Clear Clears the contents of the collection.
Public method Contains Gets a value indicating whether a specified SqlBulkCopyColumnMapping object exists in the collection.
Public method CopyTo Copies the elements of the SqlBulkCopyColumnMappingCollection to an array of SqlBulkCopyColumnMapping items, starting at a particular index.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetEnumerator Returns an enumerator that iterates through the CollectionBase instance. (Inherited from CollectionBase.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Gets the index of the specified SqlBulkCopyColumnMapping object.
Public method Insert Insert a new SqlBulkCopyColumnMapping at the index specified.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnClear Performs additional custom processes when clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnClearComplete Performs additional custom processes after clearing the contents of the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnInsert Performs additional custom processes before inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnInsertComplete Performs additional custom processes after inserting a new element into the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnRemove Performs additional custom processes when removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnRemoveComplete Performs additional custom processes after removing an element from the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnSet Performs additional custom processes before setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnSetComplete Performs additional custom processes after setting a value in the CollectionBase instance. (Inherited from CollectionBase.)
Protected method OnValidate Performs additional custom processes when validating a value. (Inherited from CollectionBase.)
Public method Remove Removes the specified SqlBulkCopyColumnMapping element from the SqlBulkCopyColumnMappingCollection.
Public method RemoveAt Removes the mapping at the specified index from the collection.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Copies the entire CollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from CollectionBase.)
Explicit interface implemetation Private property ICollection.IsSynchronized Gets a value indicating whether access to the CollectionBase is synchronized (thread safe). (Inherited from CollectionBase.)
Explicit interface implemetation Private property ICollection.SyncRoot Gets an object that can be used to synchronize access to the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.Add Adds an object to the end of the CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.Contains Determines whether the CollectionBase contains a specific element. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.IndexOf Searches for the specified Object and returns the zero-based index of the first occurrence within the entire CollectionBase. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.Insert Inserts an element into the CollectionBase at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetation Private property IList.IsFixedSize Gets a value indicating whether the CollectionBase has a fixed size. (Inherited from CollectionBase.)
Explicit interface implemetation Private property IList.IsReadOnly Gets a value indicating whether the CollectionBase is read-only. (Inherited from CollectionBase.)
Explicit interface implemetation Private property IList.Item Gets or sets the element at the specified index. (Inherited from CollectionBase.)
Explicit interface implemetation Private method IList.Remove Removes the first occurrence of a specific object from the CollectionBase. (Inherited from CollectionBase.)
Top

Column mappings define the mapping between data source and the target table.

If mappings are not defined—that is, the ColumnMappings collection is empty—the columns are mapped implicitly based on ordinal position. For this to work, source and target schemas must match. If they do not, an InvalidOperationException is thrown.

If the ColumnMappings collection is not empty, not every column present in the data source has to be specified. Those not mapped by the collection are ignored.

You can refer to source and target columns by either name or ordinal. You can mix by-name and by-ordinal column references in the same mappings collection.

The following example bulk copies data from a source table in the AdventureWorks sample database to a destination table in the same database. Although the number of columns in the destination matches the number of columns in the source, the column names and ordinal positions do not match. SqlBulkCopyColumnMapping are added to the SqlBulkCopyColumnMappingCollection for the SqlBulkCopy object to create a column map for the bulk copy.

Important note 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.


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.BulkCopyDemoDifferentColumns;",
                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();

            // Set up the bulk copy object. 
            using (SqlBulkCopy bulkCopy =
                       new SqlBulkCopy(connectionString))
            {
                bulkCopy.DestinationTableName =
                    "dbo.BulkCopyDemoDifferentColumns";

                // The column order in the source doesn't match the order 
                // in the destination, so ColumnMappings must be defined.
                bulkCopy.ColumnMappings.Add("ProductID", "ProdID");
                bulkCopy.ColumnMappings.Add("Name", "ProdName");
                bulkCopy.ColumnMappings.Add("ProductNumber", "ProdNum");

                // Write from the source to the destination.
                try
                {
                    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;";
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), 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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ