grammar updates
[mono.git] / web / sqlclient
index f73ba3eb4f4d354d4c47055875de1fe63f5e4e2f..d17f4695593ad19ad80360d82099f92750c071a5 100755 (executable)
 * Microsoft SQL Server Provider
 
 <ul>
-       <li>ADO.NET Provider for Microsoft SQL Server 7/2000 databases
+       <li>ADO.NET Provider for Microsoft SQL Server 7/2000 databases</li>
 
-       <li>Exists in namespace System.Data.SqlClient and assembly System.Data
+       <li>Exists in namespace System.Data.SqlClient and assembly System.Data</li>
        
-       <li>Created by Tim Coleman
+       <li>Created by Tim Coleman</li>
        
        <li>Used the <a href="http://www.freetds.org/">FreeTDS</a> and 
-       <a href="http://jtds.sourceforge.net/">jTDS</a> projects as resources.
+       <a href="http://jtds.sourceforge.net/">jTDS</a> projects as resources.</li>
        
-       <li>Implemented in 100% C#
+       <li>Implemented in 100% C#</li>
+       
+       <li>Is similar to the Mono.Data.TdsClient and Mono.Data.SybaseClient providers.</li>
+       
+       <li>Requires the assembly Mono.Data.Tds.dll which implements the TDS protocol in 100% C#.</li>
+       
+       <li>Uses TDS Protocol Version 7.0</li>
+       
+       <li>Bugs with Mono or the data provider should be reported 
+       in Mono's Bugzilla <a href="http://bugzilla.ximian.com/">here</a>.  If you
+       do not have Bugzilla user account, it is free 
+       and easy to 
+       create one <a href="http://bugzilla.ximian.com/createaccount.cgi">here</a>.</li>
        
-       <li>Is similar to the Mono.Data.TdsClient and Mono.Data.SybaseClient providers.
 </ul>
 
-* Current Status
-       
+
+** Current Status
+
+
 <ul>
-       <li>Able to connect to Microsoft SQL Server 7/2000 databases
+       <li>Able to connect to Microsoft SQL Server 7/2000 databases</li>
        
-       <li>Connection pooling works.
+       <li>Connection pooling works.</li>
        
-       <li>Stored Procedures work
+       <li>Stored Procedures work</li>
        
-       <li>Parameters work.  
+       <li>Parameters work.</li>
        
-       <li>Prepare works.
+       <li>Prepare works.</li>
        
        <li>SQL commands can be executed
-       via ExecuteNonQuery() of a SqlCommand.
+       via ExecuteNonQuery() of a SqlCommand.</li>
        
        <li>SQL aggregates can be executed and a single row and single column
-       result can be retrieved via ExecuteScalar() of a SqlCommand
+       result can be retrieved via ExecuteScalar() of a SqlCommand</li>
        
        <li>SQL queries can be executed via ExecuteReader() and results 
-       can be retrieved via SqlDataReader.
+       can be retrieved via SqlDataReader.</li>
        
        <li>a DataTable with schema info about a result can be gotten via GetSchemaTable()
-       in a SqlDataReader
+       in a SqlDataReader</li>
        
-       <li>XML can be read via ExecuteXmlReader in a SqlCommand.
+       <li>XML can be read via ExecuteXmlReader in a SqlCommand.</li>
        
-       <li>Data can be filled in a DataTable in a DataSet via a SqlDataAdapter
+       <li>Data can be filled in a DataTable in a DataSet via a SqlDataAdapter</li>
        
-       <li>Uses TDS Protocol Version 7.0
+       <li>Uses TDS Protocol Version 7.0</li>
        
-       <li><a href="http://www.go-mono.com/tds-providers.html">Design of the Microsoft SQL Server, Sybase, and TDS Providers in Mono</a>
+       <li><a href="http://www.go-mono.com/tds-providers.html">Design of the Microsoft SQL Server, Sybase, and TDS Providers in Mono</a></li>
+       
+       <li>Works in the SQL# command-line and GTK# GUI version</li>
 </ul>
 
-* Action plan
+** Action plan
 
 <ul>
-       <li>Connection timeouts is being developed now.
+       <li>Connection timeouts is being developed now</li>
+       
+       <li>Needs more testing</li>
+       
+       <li>Would like to figure out how to connect via Trusted_Connection or Integrated Security</li>
+       
+       <li>Start work on TDS Protocol Version 8.0 support</li>
 
-       <li>TODO
 </ul>
+
+** Testing
+
+<ul>
+       <li>Have a working mono and mcs installed</li>
+       
+       <li>Have access to a Microsoft SQL Server database 
+       or either download it:
+               <ul>
+                       <li><a href="http://www.microsoft.com/sql/default.asp">Microsoft SQL Server</a></li>
+               </ul>
+       </li>
+       
+       <li>If using Microsoft SQL Server 2000, make sure
+       you are using at least Service Pack 3 for Microsoft SQL Server 2000.  If using
+       MSDE 2000, make sure you have the special Service Pack 3 for MSDE 2000.</li>
+       
+       <li>For those that only have MSDE installed.  You can change the authentication mode \r
+       from Windows Only Authentication to SQL Server and Windows Authentications (also knows as Mixed-mode authentication)\r
+       via the <a href="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q322336&sd=tech#4">registry</a></li>.  It is\r
+       the LoginMode you need to change.  By default,\r
+       MSDE is installed with Windows Only Authentication. For SqlClient to work with MSDE, you will\r
+       need to change the setting.</a>\r
+       \r
+       <li>If using MSDE, you might need to create a new user with password.  Give\r
+    this user access to various databases in this MSDE instance.  Also, for each\r
+    database, give this new user at least SELECT access to the various tables you want\r
+    to retrieve data from.</li>\r
+       \r
+       <li>If you have Enterprise Manager, you can easily change the authentication mode\r
+       for both MSDE and Microsoft SQL Server.  To change the authentication mode in \r
+       Enterprise Mananger, select the instance, right-click on it, and select properites.\r
+       The SQL Server properties dialog for that instance will pop up.  Choose the Security\r
+       tab.  Change the authentication from Windows Only to SQL Server and Windows.  If\r
+       the instance of your database does not show up in Enterprise Manager, Register first\r
+       by selecting the Action menu and choosing New SQL Server Registration.</li>\r
+
+       <li>Located at mcs/class/System.Data/Test is a test for System.Data.SqlClient
+       named SqlTest.cs and you could use this as a basis for your test.</li>
+       
+       <li>Mono's SqlClient does not support trusted connections 
+       nor integrated security.  You can not use this when connecting.  You need 
+       to explicitly use a User ID and Password
+       authenticated by SQL Server.</li>
+       
+       <li>Has a connection string format:
+<pre>
+ Server=hostname;Database=databaseName;User ID=userid;Password=password
+</pre>
+       </li>
+       <li>The Server part can be used three ways:
+       
+               <table border=1>
+                       <tr>
+                               <td><b>Server Definition</b></td> <td><b>Example</b></td>
+                       </tr>   
+               
+                       <tr>
+                               <td>hostname</td> <td>Server=MYHOST</td>
+                       </tr>
+                       
+                       <tr>
+                               <td>hostname,port</td> <td>Server=MYHOST,1433</td>
+                       </tr>
+                       
+                       <tr>
+                               <td>hostname\\instance</td> <td>Server=MYHOST\\NETSDK</td>
+                       </tr>
+               </table>
+       </li>
+       
+       <li>C# Example:
+<pre>
+ using System;
+ using System.Data;
+ using System.Data.SqlClient;
+ public class Test 
+ {
+    public static void Main(string[] args)
+    {
+       string connectionString = 
+          "Server=localhost;" +
+          "Database=pubs;" +
+          "User ID=myuserid;" +
+          "Password=mypassword;";
+       IDbConnection dbcon;
+       dbcon = new SqlConnection(connectionString);
+       dbcon.Open();
+       IDbCommand dbcmd = dbcon.CreateCommand();
+       string sql = 
+           "SELECT fname, lname " +
+           "FROM employee";
+       dbcmd.CommandText = sql;
+       IDataReader reader = dbcmd.ExecuteReader();
+       while(reader.Read()) {
+            string FirstName = (string) reader["fname"];
+            string LastName = (string) reader["lname"];
+            Console.WriteLine("Name: " + 
+                 FirstName + " " + LastName);
+       }
+       // clean up
+       reader.Close();
+       reader = null;
+       dbcmd.Dispose();
+       dbcmd = null;
+       dbcon.Close();
+       dbcon = null;
+    }
+ }
+</pre>
+       </li>
+       <li>Building C# Example:
+       <ul>
+               <li>Save the example to a file, such as, TestExample.cs</li>
+               <li>Build on Linux:
+<pre>
+       mcs TestExample.cs -r System.Data.dll
+</pre>
+               </li>
+               <li>Build on Windows via Cygwin:
+<pre>
+       mono C:/cygwin/home/MyHome/mono/install/bin/mcs.exe \
+            TestExample.cs -r System.Data.dll
+</pre>
+               </li>
+       </ul>
+       </li>
+       <li>Running the Example:
+<pre>
+mono TestExample.exe
+</pre>
+       </li>
+
+</ul>
+