Optional ORDER hints for SqlBulkCopy

doc/samples/SqlBulkCopy_ColumnOrderHint.cs

@@ -0,0 +1,84 @@
+// <Snippet1>
+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;";
+    }
+}
+// </Snippet1>

doc/samples/SqlBulkCopy_ColumnOrderHintCollection.cs

@@ -0,0 +1,83 @@
+// <Snippet1>
+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";
+
+                // Specify the sort order for the ProductNumber column in 
+                // the destination table.
+                bulkCopy.ColumnOrderHints.Add("ProductNumber", SortOrder.Ascending);
+
+                // 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;";
+    }
+}
+// </Snippet1>

doc/samples/SqlBulkCopy_ColumnOrderHintCollectionAdd.cs

@@ -0,0 +1,86 @@
+// <Snippet1>
+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";
+
+                // Specify the sort order for the ProductNumber column in 
+                // the destination table.
+                // 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;";
+    }
+}
+// </Snippet1>

doc/samples/SqlBulkCopy_ColumnOrderHintCollectionAdd2.cs

@@ -0,0 +1,83 @@
+// <Snippet1>
+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";
+
+                // Specify the sort order for the ProductNumber column in 
+                // the destination table.
+                bulkCopy.ColumnOrderHints.Add("ProductNumber", SortOrder.Ascending);
+
+                // 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;";
+    }
+}
+// </Snippet1>