Share via


SqlBulkCopy.ColumnMappings Property

Definition

Returns a collection of SqlBulkCopyColumnMapping items. Column mappings define the relationships between columns in the data source and columns in the destination.

public:
 property Microsoft::Data::SqlClient::SqlBulkCopyColumnMappingCollection ^ ColumnMappings { Microsoft::Data::SqlClient::SqlBulkCopyColumnMappingCollection ^ get(); };
public Microsoft.Data.SqlClient.SqlBulkCopyColumnMappingCollection ColumnMappings { get; }
member this.ColumnMappings : Microsoft.Data.SqlClient.SqlBulkCopyColumnMappingCollection
Public ReadOnly Property ColumnMappings As SqlBulkCopyColumnMappingCollection

Property Value

A collection of column mappings. By default, it is an empty collection.

Remarks

If the data source and the destination table have the same number of columns, and the ordinal position of each source column within the data source matches the ordinal position of the corresponding destination column, the ColumnMappings collection is unnecessary. However, if the column counts differ, or the ordinal positions are not consistent, you must use ColumnMappings to make sure that data is copied into the correct columns.

During the execution of a bulk copy operation, this collection can be accessed, but it cannot be changed. Any attempt to change it will throw an InvalidOperationException.

Applies to