SqlBulkCopyColumnMapping Class
Defines the mapping between a column in a SqlBulkCopy instance's data source and a column in the instance's destination table.
Assembly: System.Data (in System.Data.dll)
The SqlBulkCopyColumnMapping type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | SqlBulkCopyColumnMapping() | Default constructor that initializes a new SqlBulkCopyColumnMapping object. |
![]() | SqlBulkCopyColumnMapping(Int32, Int32) | Creates a new column mapping, using column ordinals to refer to source and destination columns. |
![]() | SqlBulkCopyColumnMapping(Int32, String) | Creates a new column mapping, using a column ordinal to refer to the source column and a column name for the target column. |
![]() | SqlBulkCopyColumnMapping(String, Int32) | Creates a new column mapping, using a column name to refer to the source column and a column ordinal for the target column. |
![]() | SqlBulkCopyColumnMapping(String, String) | Creates a new column mapping, using column names to refer to source and destination columns. |
| Name | Description | |
|---|---|---|
![]() | DestinationColumn | Name of the column being mapped in the destination database table. |
![]() | DestinationOrdinal | Ordinal value of the destination column within the destination table. |
![]() | SourceColumn | Name of the column being mapped in the data source. |
![]() | SourceOrdinal | The ordinal position of the source column within the data source. |
| Name | Description | |
|---|---|---|
![]() | 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.) |
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 will be 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 also 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, and each destination column is in the same ordinal position as its corresponding source column, the column names do not match. SqlBulkCopyColumnMapping objects are used to create a column map for the bulk copy.
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. |
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.
