SqlBulkCopyColumnMappingCollectionとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

SqlBulkCopyColumnMappingCollection クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

CollectionBase を継承する SqlBulkCopyColumnMapping オブジェクトのコレクション。

名前空間: System.Data.SqlClient
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 SqlBulkCopyColumnMappingCollection
    Inherits CollectionBase

Visual Basic (使用法)

Dim instance As SqlBulkCopyColumnMappingCollection

public sealed class SqlBulkCopyColumnMappingCollection
 : CollectionBase

C++

public ref class SqlBulkCopyColumnMappingCollection
 sealed : public CollectionBase

public final class SqlBulkCopyColumnMappingCollection
 extends CollectionBase

JScript

public final class SqlBulkCopyColumnMappingCollection
 extends CollectionBase

解説

データソースとコピー先テーブルとの間の対応付けは、列マップによって定義されます。

マップが定義されていない場合、つまり、ColumnMappings コレクションが空の場合、列の序数位置に基づいて暗黙的に対応付けされます。そのためには、コピー元とコピー先のスキーマが一致していることが必要です。スキーマが一致していない場合、InvalidOperationException がスローされます。

ColumnMappings コレクションが空ではない場合、データソース内のすべての列を指定する必要はありません。コレクションでマップされていない列は無視されます。

コピー元とコピー先の列は、名前で参照することも、序数で参照することもできます。名前による列の参照と、序数による列の参照が、同じマップコレクション内で混在していてもかまいません。

使用例

次の例は、AdventureWorks サンプルデータベースのソーステーブルからデータを、同じデータベースの別のテーブルに一括コピーします。コピー先の列数はコピー元の列数と一致しますが、列名と序数位置が一致していません。一括コピーの列マップを作成するために、SqlBulkCopyColumnMapping が SqlBulkCopy オブジェクトの SqlBulkCopyColumnMappingCollection に追加されます。

重要 :
このサンプルを実行するには、あらかじめ、「バルクコピーの例のためのテーブルの作成」の説明に従って作業テーブルを作成しておく必要があります。このコードは、SqlBulkCopy を使用する構文を示すためだけに提供されています。同じ SQL Server インスタンスにコピー元テーブルとコピー先テーブルが存在する場合、Transact-SQL の `INSERT … SELECT` ステートメントを使用した方が容易かつ迅速にデータをコピーできます。

重要 :

このサンプルを実行するには、あらかじめ、「バルクコピーの例のためのテーブルの作成」の説明に従って作業テーブルを作成しておく必要があります。このコードは、SqlBulkCopy を使用する構文を示すためだけに提供されています。同じ SQL Server インスタンスにコピー元テーブルとコピー先テーブルが存在する場合、Transact-SQL の INSERT … SELECT ステートメントを使用した方が容易かつ迅速にデータをコピーできます。

Visual Basic

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

            ' Set up the bulk copy object.
            Using bulkCopy As SqlBulkCopy = 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 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 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

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

継承階層

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

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SqlBulkCopyColumnMappingCollection メンバ
System.Data.SqlClient 名前空間
その他の技術情報
バルクコピー操作の実行

SqlBulkCopyColumnMappingCollection プロパティ

パブリックプロパティパブリックプロパティ

( プロテクトプロパティも参照)

	名前	説明
	Capacity	CollectionBase に格納できる要素の数を取得または設定します。 ( CollectionBase から継承されます。)
	Count	CollectionBase インスタンスに格納されている要素の数を取得します。このプロパティはオーバーライドできません。 ( CollectionBase から継承されます。)
	Item	指定したインデックス位置にある SqlBulkCopyColumnMapping オブジェクトを取得します。

プロテクトプロパティ

	名前	説明
	InnerList	CollectionBase インスタンス内の要素のリストを格納する ArrayList を取得します。 ( CollectionBase から継承されます。)
	List	CollectionBase インスタンス内の要素のリストを格納する IList を取得します。 ( CollectionBase から継承されます。)

参照

その他の技術情報

バルクコピー操作の実行

SqlBulkCopyColumnMappingCollection メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Add	オーバーロードされます。新しい SqlBulkCopyColumnMapping を SqlBulkCopyColumnMappingCollection に追加します。
	Clear	コレクションの内容を消去します。
	Contains	指定した SqlBulkCopyColumnMapping オブジェクトがコレクション内に存在するかどうかを示す値を取得します。
	CopyTo	SqlBulkCopyColumnMappingCollection の要素を、SqlBulkCopyColumnMapping アイテムの配列にコピーします (特定のインデックスからコピーが開始されます)。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetEnumerator	CollectionBase インスタンスを反復処理する列挙子を返します。 ( CollectionBase から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IndexOf	指定した SqlBulkCopyColumnMapping オブジェクトのインデックスを取得します。
	Insert	指定されたインデックス位置に、新しい SqlBulkCopyColumnMapping を挿入します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Remove	指定された SqlBulkCopyColumnMapping 要素を SqlBulkCopyColumnMappingCollection から削除します。
	RemoveAt	指定したインデックス位置にあるマップをコレクションから削除します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	OnClear	CollectionBase インスタンスの内容を消去するときに、追加のカスタムプロセスを実行します。 ( CollectionBase から継承されます。)
	OnClearComplete	CollectionBase インスタンスの内容を消去した後に、追加のカスタムプロセスを実行します。 ( CollectionBase から継承されます。)
	OnInsert	CollectionBase インスタンスに新しい要素を挿入する前に、追加のカスタムプロセスを実行します。 ( CollectionBase から継承されます。)
	OnInsertComplete	CollectionBase インスタンスに新しい要素を挿入した後に、追加のカスタムプロセスを実行します。 ( CollectionBase から継承されます。)
	OnRemove	CollectionBase インスタンスから要素を削除するときに、追加のカスタムプロセスを実行します。 ( CollectionBase から継承されます。)
	OnRemoveComplete	CollectionBase インスタンスから要素を削除した後に、追加のカスタムプロセスを実行します。 ( CollectionBase から継承されます。)
	OnSet	CollectionBase インスタンスに値を設定する前に、追加のカスタムプロセスを実行します。 ( CollectionBase から継承されます。)
	OnSetComplete	CollectionBase インスタンスに値を設定した後に、追加のカスタムプロセスを実行します。 ( CollectionBase から継承されます。)
	OnValidate	値を検証するときに、追加のカスタムプロセスを実行します。 ( CollectionBase から継承されます。)

参照

その他の技術情報

バルクコピー操作の実行

SqlBulkCopyColumnMappingCollection メンバ

CollectionBase を継承する SqlBulkCopyColumnMapping オブジェクトのコレクション。

SqlBulkCopyColumnMappingCollection データ型で公開されるメンバを以下の表に示します。

パブリックプロパティ

( プロテクトプロパティも参照)

	名前	説明
	Capacity	CollectionBase に格納できる要素の数を取得または設定します。(CollectionBase から継承されます。)
	Count	CollectionBase インスタンスに格納されている要素の数を取得します。このプロパティはオーバーライドできません。(CollectionBase から継承されます。)
	Item	指定したインデックス位置にある SqlBulkCopyColumnMapping オブジェクトを取得します。

プロテクトプロパティ

	名前	説明
	InnerList	CollectionBase インスタンス内の要素のリストを格納する ArrayList を取得します。(CollectionBase から継承されます。)
	List	CollectionBase インスタンス内の要素のリストを格納する IList を取得します。(CollectionBase から継承されます。)

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Add	オーバーロードされます。新しい SqlBulkCopyColumnMapping を SqlBulkCopyColumnMappingCollection に追加します。
	Clear	コレクションの内容を消去します。
	Contains	指定した SqlBulkCopyColumnMapping オブジェクトがコレクション内に存在するかどうかを示す値を取得します。
	CopyTo	SqlBulkCopyColumnMappingCollection の要素を、SqlBulkCopyColumnMapping アイテムの配列にコピーします (特定のインデックスからコピーが開始されます)。
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetEnumerator	CollectionBase インスタンスを反復処理する列挙子を返します。 (CollectionBase から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IndexOf	指定した SqlBulkCopyColumnMapping オブジェクトのインデックスを取得します。
	Insert	指定されたインデックス位置に、新しい SqlBulkCopyColumnMapping を挿入します。
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Remove	指定された SqlBulkCopyColumnMapping 要素を SqlBulkCopyColumnMappingCollection から削除します。
	RemoveAt	指定したインデックス位置にあるマップをコレクションから削除します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	OnClear	CollectionBase インスタンスの内容を消去するときに、追加のカスタムプロセスを実行します。 (CollectionBase から継承されます。)
	OnClearComplete	CollectionBase インスタンスの内容を消去した後に、追加のカスタムプロセスを実行します。 (CollectionBase から継承されます。)
	OnInsert	CollectionBase インスタンスに新しい要素を挿入する前に、追加のカスタムプロセスを実行します。 (CollectionBase から継承されます。)
	OnInsertComplete	CollectionBase インスタンスに新しい要素を挿入した後に、追加のカスタムプロセスを実行します。 (CollectionBase から継承されます。)
	OnRemove	CollectionBase インスタンスから要素を削除するときに、追加のカスタムプロセスを実行します。 (CollectionBase から継承されます。)
	OnRemoveComplete	CollectionBase インスタンスから要素を削除した後に、追加のカスタムプロセスを実行します。 (CollectionBase から継承されます。)
	OnSet	CollectionBase インスタンスに値を設定する前に、追加のカスタムプロセスを実行します。 (CollectionBase から継承されます。)
	OnSetComplete	CollectionBase インスタンスに値を設定した後に、追加のカスタムプロセスを実行します。 (CollectionBase から継承されます。)
	OnValidate	値を検証するときに、追加のカスタムプロセスを実行します。 (CollectionBase から継承されます。)