SqlBulkCopyColumnOrderHint クラス

定義

名前空間:

Microsoft.Data.SqlClient

アセンブリ:

Microsoft.Data.SqlClient.dll

パッケージ:

Microsoft.Data.SqlClient v5.2.0

インスタンスの変換先テーブルの SqlBulkCopy 列の並べ替え順序を、テーブルのクラスター化インデックスに従って定義します。

public ref class SqlBulkCopyColumnOrderHint sealed

public sealed class SqlBulkCopyColumnOrderHint

type SqlBulkCopyColumnOrderHint = class

Public NotInheritable Class SqlBulkCopyColumnOrderHint

継承

Object

SqlBulkCopyColumnOrderHint

例

次の例では、AdventureWorks サンプル データベースのソース テーブルから、同じデータベース内のコピー先テーブルにデータを一括コピーします。 SqlBulkCopyColumnOrderHint オブジェクトは、ProductNumber 変換先列の並べ替え順序を定義するために使用されます。

重要

このサンプルは、「バルク コピー サンプルのセットアップ」で説明されているように作業テーブルを作成してからでないと動作しません。 このコードでは、SqlBulkCopy だけを使用した構文について説明します。 ソース テーブルと変換先テーブルが同じSQL Server インスタンスにある場合は、Transact-SQL INSERT … SELECT ステートメントを使用してデータをコピーする方が簡単かつ迅速です。

using System;
using System.Data;
using Microsoft.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();

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

                // Setup an order hint for the ProductNumber column.
                SqlBulkCopyColumnOrderHint hintNumber =
                    new SqlBulkCopyColumnOrderHint("ProductNumber", SortOrder.Ascending);
                bulkCopy.ColumnOrderHints.Add(hintNumber);

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

注釈

列の順序ヒントは、変換先テーブルの列の並べ替え順序を定義します。

インポートされるデータがテーブルのクラスター化インデックス (存在する場合) に従って並べ替えられると、SqlBulkCopy のパフォーマンスが向上します。 クラスター化インデックス キーの順序と異なる順序でデータが並べ替えられている場合、またはテーブルにクラスター化インデックスがない場合、順序ヒントは無視されます。

順序ヒントは、変換先テーブルの任意の数の列に対して指定できます。 既定では、ヒントが指定されていない場合、一括挿入操作ではデータの順序が指定されていないと見なされます。

指定する列の名前は、インポート先のテーブル内で有効な列の名前であることが必要です。 ヒントを指定できる順序は任意です。 1 つの列名を複数回指定することはできません。

コレクションが ColumnMappings 空でない場合は、マップされた有効な宛先列に対してのみ注文ヒントを指定できます。

Unspecified の が SortOrder 指定されている場合は、 ArgumentException がスローされます。

コンストラクター

SqlBulkCopyColumnOrderHint(String, SortOrder)

指定した変換先列の新しい列順序ヒントを作成します。

プロパティ

Column	ヒントが指定されている変換先テーブル内のコピー先列の名前。
SortOrder	変換先テーブルの変換先列の並べ替え順序。