Add API documentation for SqlConnection to SqlTransaction

doc/samples/DataTableReader_GetValues.cs

@@ -8,6 +8,7 @@ static void Main()
     {
     }
     // <Snippet1>
+    // using Microsoft.Data.SqlClient;
     private static void TestGetValues(DataTableReader reader)
     {
         // Given a DataTableReader, use the GetValues
@@ -40,6 +41,7 @@ private static void TestGetValues(DataTableReader reader)
     // </Snippet1>
 
     // <Snippet2>
+    // using Microsoft.Data.SqlClient;
     private static void TestGetValues(SqlDataReader reader)
     {
         // Given a SqlDataReader, use the GetValues

doc/samples/SqlCommand_ExecuteNonQuery.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Data;
+// <Snippet1>
+using Microsoft.Data.SqlClient;
+
+namespace SqlCommandCS
+{
+    class Program
+    {
+        static void Main()
+        {
+            string str = "Data Source=(local);Initial Catalog=Northwind;"
+                + "Integrated Security=SSPI";
+            string qs = "SELECT OrderID, CustomerID FROM dbo.Orders;";
+            CreateCommand(qs, str);
+        }
+        private static void CreateCommand(string queryString,
+            string connectionString)
+        {
+            using (SqlConnection connection = new SqlConnection(
+                       connectionString))
+            {
+                SqlCommand command = new SqlCommand(queryString, connection);
+                command.Connection.Open();
+                command.ExecuteNonQuery();
+            }
+        }
+    }
+}
+// </Snippet1>

doc/samples/SqlConnectionStringBuilder.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Data;
+// <Snippet1>
+using Microsoft.Data.SqlClient;
+
+class Program
+{
+    static void Main()
+    {
+        // Create a new SqlConnectionStringBuilder and
+        // initialize it with a few name/value pairs.
+        SqlConnectionStringBuilder builder =
+            new SqlConnectionStringBuilder(GetConnectionString());
+
+        // The input connection string used the 
+        // Server key, but the new connection string uses
+        // the well-known Data Source key instead.
+        Console.WriteLine(builder.ConnectionString);
+
+        // Pass the SqlConnectionStringBuilder an existing 
+        // connection string, and you can retrieve and
+        // modify any of the elements.
+        builder.ConnectionString = "server=(local);user id=ab;" +
+            "password= a!Pass113;initial catalog=AdventureWorks";
+
+        // Now that the connection string has been parsed,
+        // you can work with individual items.
+        Console.WriteLine(builder.Password);
+        builder.Password = "new@1Password";
+        builder.AsynchronousProcessing = true;
+
+        // You can refer to connection keys using strings, 
+        // as well. When you use this technique (the default
+        // Item property in Visual Basic, or the indexer in C#),
+        // you can specify any synonym for the connection string key
+        // name.
+        builder["Server"] = ".";
+        builder["Connect Timeout"] = 1000;
+        builder["Trusted_Connection"] = true;
+        Console.WriteLine(builder.ConnectionString);
+
+        Console.WriteLine("Press Enter to finish.");
+        Console.ReadLine();
+    }
+
+    private static string GetConnectionString()
+    {
+        // To avoid storing the connection string in your code,
+        // you can retrieve it from a configuration file. 
+        return "Server=(local);Integrated Security=SSPI;" +
+            "Initial Catalog=AdventureWorks";
+    }
+}
+// </Snippet1>

doc/samples/SqlConnectionStringBuilder2.cs

@@ -0,0 +1,25 @@
+using System;
+using System.Data;
+// <Snippet1>
+using Microsoft.Data.SqlClient;
+
+class Program
+{
+    static void Main()
+    {
+        SqlConnectionStringBuilder builder = 
+            new SqlConnectionStringBuilder();
+        builder["Data Source"] = "(local)";
+        builder["Integrated Security"] = true;
+        builder["Initial Catalog"] = "AdventureWorks";
+
+        // Overwrite the existing value for the Data Source value.
+        builder["Data Source"] = ".";
+
+        Console.WriteLine(builder.ConnectionString);
+        Console.WriteLine();
+        Console.WriteLine("Press Enter to continue.");
+        Console.ReadLine();
+    }
+}
+// </Snippet1>

doc/samples/SqlConnectionStringBuilder3.cs

@@ -0,0 +1,34 @@
+using System;
+using System.Data;
+// <Snippet1>
+using Microsoft.Data.SqlClient;
+
+class Program
+{
+    static void Main()
+    {
+        try
+        {
+            string connectString = 
+                "Server=(local);Database=AdventureWorks;UID=ab;Pwd= a!Pass@@";
+            Console.WriteLine("Original: " + connectString);
+            SqlConnectionStringBuilder builder = 
+                new SqlConnectionStringBuilder(connectString);
+            Console.WriteLine("Modified: " + builder.ConnectionString);
+            foreach (string key in builder.Keys)
+                Console.WriteLine(key + "=" + builder[key].ToString());
+            Console.WriteLine("Press any key to finish.");
+            Console.ReadLine();
+
+        }
+        catch (System.Collections.Generic.KeyNotFoundException ex)
+        {
+            Console.WriteLine("KeyNotFoundException: " + ex.Message);
+        }
+        catch (System.FormatException ex)
+        {
+            Console.WriteLine("Format exception: " + ex.Message);
+        }
+    }
+}
+// </Snippet1>

doc/samples/SqlConnectionStringBuilder_ApplicationName.cs

@@ -0,0 +1,33 @@
+using System;
+using System.Data;
+// <Snippet1>
+using Microsoft.Data.SqlClient;
+
+class Program
+{
+    static void Main()
+    {
+        try
+        {
+            string connectString = "Server=(local);Initial Catalog=AdventureWorks;" + 
+                "Integrated Security=true";
+            SqlConnectionStringBuilder builder = 
+                new SqlConnectionStringBuilder(connectString);
+            Console.WriteLine("Original: " + builder.ConnectionString);
+            Console.WriteLine("ApplicationName={0}",
+                builder.ApplicationName);
+
+            builder.ApplicationName = "My Application";
+            Console.WriteLine("Modified: " + builder.ConnectionString);
+
+            Console.WriteLine("Press any key to finish.");
+            Console.ReadLine();
+
+        }
+        catch (Exception ex)
+        {
+            Console.WriteLine(ex.Message);
+        }
+    }
+}
+// </Snippet1>

doc/samples/SqlConnectionStringBuilder_AsynchronousProcessing.cs

@@ -0,0 +1,88 @@
+using System;
+using System.Data;
+// <Snippet1>
+using Microsoft.Data.SqlClient;
+using System.Threading;
+
+class Program
+{
+    static void Main()
+    {
+        // Create a SqlConnectionStringBuilder instance, 
+        // and ensure that it is set up for asynchronous processing.
+        SqlConnectionStringBuilder builder =
+            new SqlConnectionStringBuilder(GetConnectionString());
+        // Asynchronous method calls won't work unless you
+        // have added this option, or have added
+        // the clause "Asynchronous Processing=true"
+        // to the connection string.
+        builder.AsynchronousProcessing = true;
+
+        string commandText =
+            "UPDATE Production.Product SET ReorderPoint = ReorderPoint + 1 " +
+            "WHERE ReorderPoint IS NOT Null;" +
+            "WAITFOR DELAY '0:0:3';" +
+            "UPDATE Production.Product SET ReorderPoint = ReorderPoint - 1 " +
+            "WHERE ReorderPoint IS NOT Null";
+        RunCommandAsynchronously(commandText, builder.ConnectionString);
+
+        Console.WriteLine("Press any key to finish.");
+        Console.ReadLine();
+    }
+
+    private static string GetConnectionString()
+    {
+        // To avoid storing the connection string in your code,
+        // you can retrieve it from a configuration file. 
+        return "Data Source=(local);Integrated Security=SSPI;" +
+            "Initial Catalog=AdventureWorks";
+    }
+
+    private static void RunCommandAsynchronously(string commandText, 
+        string connectionString)
+    {
+        // Given command text and connection string, asynchronously execute
+        // the specified command against the connection. For this example,
+        // the code displays an indicator as it's working, verifying the 
+        // asynchronous behavior. 
+        using (SqlConnection connection = new SqlConnection(connectionString))
+        {
+            try
+            {
+                int count = 0;
+                SqlCommand command = new SqlCommand(commandText, connection);
+                connection.Open();
+                IAsyncResult result = command.BeginExecuteNonQuery();
+                while (!result.IsCompleted)
+                {
+                    Console.WriteLine("Waiting {0}.", count);
+                    // Wait for 1/10 second, so the counter
+                    // doesn't consume all available resources 
+                    // on the main thread.
+                    Thread.Sleep(100);
+                    count += 1;
+                }
+                Console.WriteLine("Command complete. Affected {0} rows.",
+                    command.EndExecuteNonQuery(result));
+
+            }
+            catch (SqlException ex)
+            {
+                Console.WriteLine(
+                    "Error {0}: Microsoft.Data.SqlClient.SqlConnectionStringBuilder", 
+                    ex.Number, ex.Message);
+            }
+            catch (InvalidOperationException ex)
+            {
+                Console.WriteLine("Error: {0}", ex.Message);
+            }
+            catch (Exception ex)
+            {
+                // You might want to pass these errors
+                // back out to the caller.
+                Console.WriteLine("Error: {0}", ex.Message);
+            }
+        }
+    }
+}
+// </Snippet1>

doc/samples/SqlConnectionStringBuilder_AttachDBFilename.cs

@@ -0,0 +1,38 @@
+using System;
+using System.Data;
+// <Snippet1>
+using Microsoft.Data.SqlClient;
+
+class Program
+{
+    static void Main()
+    {
+        try
+        {
+            string connectString =
+                "Server=(local);" +
+                "Integrated Security=true";
+            SqlConnectionStringBuilder builder =
+                new SqlConnectionStringBuilder(connectString);
+            Console.WriteLine("Original: " + builder.ConnectionString);
+            Console.WriteLine("AttachDBFileName={0}", builder.AttachDBFilename);
+
+            builder.AttachDBFilename = @"C:\MyDatabase.mdf";
+            Console.WriteLine("Modified: " + builder.ConnectionString);
+
+            using (SqlConnection connection = new SqlConnection(builder.ConnectionString))
+            {
+                connection.Open();
+                // Now use the open connection.
+                Console.WriteLine("Database = " + connection.Database);
+            }
+            Console.WriteLine("Press any key to finish.");
+            Console.ReadLine();
+        }
+        catch (Exception ex)
+        {
+            Console.WriteLine(ex.Message);
+        }
+    }
+}
+// </Snippet1>

doc/samples/SqlConnectionStringBuilder_Clear.cs

@@ -0,0 +1,25 @@
+using System;
+using System.Data;
+// <Snippet1>
+using Microsoft.Data.SqlClient;
+
+class Program
+{
+    static void Main()
+    {
+        SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder();
+        builder.DataSource = "(local)";
+        builder.IntegratedSecurity = true;
+        builder.InitialCatalog = "AdventureWorks";
+        Console.WriteLine("Initial connection string: " + builder.ConnectionString);
+
+        builder.Clear();
+        Console.WriteLine("After call to Clear, count = " + builder.Count);
+        Console.WriteLine("Cleared connection string: " + builder.ConnectionString);
+        Console.WriteLine();
+
+        Console.WriteLine("Press Enter to continue.");
+        Console.ReadLine();
+    }
+}
+// </Snippet1>

doc/samples/SqlConnectionStringBuilder_ConnectTimeout.cs

@@ -0,0 +1,33 @@
+using System;
+using System.Data;
+// <Snippet1>
+using Microsoft.Data.SqlClient;
+
+class Program
+{
+    static void Main()
+    {
+        try
+        {
+            string connectString =
+                "Server=(local);Initial Catalog=AdventureWorks;" +
+                "Integrated Security=true";
+            SqlConnectionStringBuilder builder =
+                new SqlConnectionStringBuilder(connectString);
+            Console.WriteLine("Original: " + builder.ConnectionString);
+            Console.WriteLine("ConnectTimeout={0}",
+                builder.ConnectTimeout);
+            builder.ConnectTimeout = 100;
+            Console.WriteLine("Modified: " + builder.ConnectionString);
+
+            Console.WriteLine("Press any key to finish.");
+            Console.ReadLine();
+
+        }
+        catch (Exception ex)
+        {
+            Console.WriteLine(ex.Message);
+        }
+    }
+}
+// </Snippet1>