Merge pull request #3800 from madewokherd/mingwbuild
[mono.git] / man / sqlsharp.1
old mode 100755 (executable)
new mode 100644 (file)
index bb58b15..4bf500f
@@ -1,18 +1,18 @@
-.TH sqlsharp 1 "10 December 2002"
+.TH sqlsharp 1 "9 September 2008"
 .SH NAME 
-sqlsharp \- Mono SQL# command-line SQL Query tool
+sqlsharp \- Mono SQL Query command-line tool
 .SH SYNOPSIS
 .B sqlsharp 
 [\-f filename] [\-o filename] [\-s]
 .SH DESCRIPTION
-sqlsharp is the Mono SQL# tool used for entering SQL queries
-to a database using Mono ADO.NET providers.
+sqlsharp is a Mono SQL tool used for entering SQL queries
+to a database using Mono data providers.
 .PP
 .SH OPTIONS
 The following options are supported:
 .TP
 .I "-f filename"
-Output file to load SQL# commands from.
+Output file to load SQL commands from.
 .TP
 .I "-o filename"
 Output file to send results.
@@ -21,7 +21,7 @@ Output file to send results.
 Silent mode.
 .PP
 .SH HOW TO USE
-The SQL# tool accepts commands via its command line interface.  Commands
+The SQL tool accepts commands via its command line interface.  Commands
 begin with a backslash followed by the command name.
 .PP
 Example:
@@ -69,6 +69,8 @@ Sets the Connection String
 
 Example:
        SQL# \\ConnectionString Database=testdb
+       or
+       SQL# \\cs Database=testdb
 
 For more examples, see section CONNECTION STRING EXAMPLES.
 
@@ -80,10 +82,58 @@ Sets the Provider of the Data Source.  For list of Providers, see section PROVID
        
 Example: to set the provider for MySQL:
        SQL# \\provider mysql
+           or
+       SQL# \\p mysql
                
 Note: if you need to load an external provider in SQL#, 
       see the SQL# command \\loadextprovider 
       
+.fi
+.TP
+.I "ListProviders"
+List ADO.NET 2.0 Providers available
+.nf
+
+Example:
+       SQL# \\ListProviders 
+          or
+       SQL# \\listp
+
+.fi
+.TP
+.I "BCS"
+Prompts you for building each connection parameter and builds the connection string
+and also allows you to enter a password wich does not echo.
+.nf
+
+Example:
+       SQL# \\bcs
+
+       ConnectionString Option: Data Source [] SQL# blazer
+
+       ConnectionString Option: Persist Security Info [False] SQL# 
+
+       ConnectionString Option: Integrated Security [False] SQL# 
+
+       ConnectionString Option: User ID [] SQL# scott
+
+       Password: *****
+
+       ConnectionString Option: Enlist [False] SQL# 
+
+       ConnectionString Option: Pooling [True] SQL# 
+
+       ConnectionString Option: Min Pool Size [0] SQL# 
+
+       ConnectionString Option: Max Pool Size [100] SQL# 
+
+       ConnectionString Option: Unicode [False] SQL# 
+
+       ConnectionString Option: Load Balance Timeout [0] SQL# 
+
+       ConnectionString Option: Omit Oracle Connection Name [False] SQL# 
+       ConnectionString is set.        
+
 .fi
 .TP
 .I "LoadExtProvider"
@@ -344,28 +394,30 @@ ption defaulting to true.
 
 PROVIDER   NAME          NAMESPACE                  ASSEMBLY
 
-Internal
---------
+oracle     Oracle 8i-11g System.Data.OracleClient   System.Data.OracleClient
+postgresql NetPostgreSQL Npgsql                     Npgsql
+bytefx     ByteFX MySQL  ByteFX.Data.MySqlClient    ByteFX.Data
+sqlclient  MS SQL 7-2008 System.Data.SqlClient      System.Data
+odbc       ODBC          System.Data.Odbc           System.Data
+sqlite     SQL Lite      Mono.Data.SqliteClient     Mono.Data.SqliteClient
+sybase     Sybase        Mono.Data.SybaseClient     Mono.Data.SybaseClient
+firebird   Firebird SQL  FirebirdSql.Data.FirebirdSql FirebirdSql.Data.Firebird
+mysql      MySQL AB      MySql.Data.MySqlClient     MySql.Data
 
-OleDb      OLE DB        System.Data.OleDb          System.Data 
-SqlClient  MS SQL 7/2000 System.Data.SqlClient      System.Data
-Odbc       ODBC          System.Data.Odbc           System.Data
+NOTES:
 
-External to System.Data
------------------------
-MySql      MySQL         Mono.Data.MySql            Mono.Data.MySql
-Sqlite     SQL Lite      Mono.Data.SqliteClient     Mono.Data.SqliteClient
-Sybase     Sybase        Mono.Data.SybaseClient     Mono.Data.SybaseClient
-Tds        TDS Generic   Mono.Data.TdsClient        Mono.Data.TdsClient
-PostgreSql M PostgreSQL  Mono.Data.PostgreSqlClient Mono.Data.PostgreSqlClient
-DB2        IBM DB2       Mono.Data.DB2Client        Mono.Data.DB2Client
-Oracle     Oracle 8i     System.Data.OracleClient   System.Data.OracleClient
+Ngsql is the .Net Data Provider for PosgreSQL.  The
+latest verison can be downloaded from 
+http://npgsql.projects.postgresql.org/
 
-External to Mono
-----------------
+MySql.Data is the MySQL Connector/Net for connecting to MySql databases.
+For MySQL, it is strongly recommend to use MySql.Data instead of the old
+ByteFX.Data provider.  Unfortunately, MySql.Data is not included with Mono.
+You can download the latest MySQL Connector/Net from MySQL AB at
+http://dev.mysql.com/downloads/
 
-Npgsql     NetPostgreSQL Npgsql                     Npgsql
-MySQLNet   ByteFX MySQL  ByteFX.Data.MySQL          ByteFX.Data
+FirebirdSql.Data.Firebird can be downloaded from here:
+http://www.firebirdsql.org/index.php?op=files&id=netprovider
 
 .fi
 .SH CONNECTION STRING SAMPLES
@@ -381,24 +433,17 @@ Connection String examples:
 
 
 Microsoft SQL Server via System.Data.SqlClient 
-or Mono.Data.TdsClient provider:
-
-       Server=DANPC;Database=pubs;User ID=saPassword=
 
-               
-PostgreSQL via Mono.Data.PostgreSqlClient provider:
-
-       host=localhost;dbname=test;user=postgres;password=fun2db
+       Server=DANPC;Database=pubs;User ID=saPassword=;
 
-                         or
+       For Integrated Security, bear in mind that Mono is not
+       integrated with Windows, SQL Server client nor server, nor
+       Windows Server.  Therefore, you must provide the Windows Domain
+       name and domain user name and password for this user.
 
-       Server=localhost;Database=test;User ID=postgres;Password=fun2db
-
-               
-MySQL via Mono.Data.MySql provider:
-
-       Server=localhost;Database=test;User ID=mysql;Password=
+       Server=DANPC;Database=pubs;User ID=DOMAIN\user;Password=pass;Integrated Security=SSPI
 
+       For a server locally, you can use localhost.
        
 ODBC via System.Data.Odbc provider using 
 a DSN named "MSSQLDSN" I set up 
@@ -407,6 +452,8 @@ which connects to Microsoft SQL Server 2000:
 
        DSN=MSSQLDSN;UID=danmorg;PWD=freetds
 
+To use ODBC ON Unix, consider unixODBC from http://www.unixodbc.org/
+or use iODBC from http://www.iodbc.org/
 
 SQL Lite via Mono.Data.SqliteClient 
 provider which connects to the
@@ -415,21 +462,20 @@ the file is created:
 
        URI=file:SqliteTest.db
 
-
-OLE DB via System.Data.OleDb provider 
-which connects to a PostgreSQL database:
-
-       Provider=PostgreSQL;Addr=127.0.0.1;Database=rodrigo
-
-               
 Oracle via System.Data.OracleClient
 
        Data Source=testdb;User ID=scott;Password=tiger
 
-               
-IBM DB2 Universal Database via Mono.Data.DB2Client
+        If you prefer to not use a tnsnames.ora file, you can 
+       use a connection string which allows a
+       TNS network description that is parentheses delimited
+       like the following which has the host, port, and
+       service name.  For host, you can specify an IP address
+        instead of a hostname.
 
-       DSN=sample;User ID=db2admin;Password=mysecret   
+User ID=SCOTT;
+Password=TIGER;
+Data Source=(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=192.168.1.101)(PORT=1521))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=TESTDB)))
 
                
 Npgsql (.NET PostgreSQL) from 
@@ -438,43 +484,54 @@ http://gborg.postgresql.org/project/npgsql/projdisplay.php
        Server=localhost;Database=test;User ID=postgres;Password=fun2db
 
                
-MySQLNet (ByteFX MySQL) from 
-http://sourceforge.net/projects/mysqlnet/
+ByteFX (ByteFX MySQL) from 
+
+       Please use MySql.Data instead.
 
        Server=localhost;Database=test;User ID=mysql;Password=
 
 
+FirebirdSql via FirebirdSql.Data.Firebird (download latest form FirebirdSql.org)
+
+       Database=C:\\FIREBIRD\\EXAMPLES\\EMPLOYEE.FDB;User=SYSDBA;Password=masterkey;Dialect=3;Server=localhost
+
+
+MySQL via (MySql.Data) MySQL Connector/Net from http://www.mysql.com/
+
+       Server=localhost;Database=test;User ID=mysql;Password=mypass;Pooling=false
+
+
 .fi
 .SH TRACING SUPPORT
 No support for tracing right now.
 .SH AUTHORS
-The Mono SQL# Tool was written 
+The Mono SQL Query Tool was written 
 .nf
-by Daniel Morgan <danmorg@sc.rr.com>
+by Daniel Morgan <monodanmorg@yahoo.com>
 .fi
 .PP
 .SH LICENSE
-The Mono SQL# Tool is released under the terms of the GNU GPL.
+The Mono SQL Query Tool is released under the terms of the GNU GPL.
 Please read the accompanying `COPYING' file for details.  Alternative
-licenses are available from Ximian or Daniel Morgan.
+licenses are available from Novell or Daniel Morgan.
 .SH BUGS
 To report bugs in the compiler, you can use `bug-buddy', or you can
 file bug reports in our bug tracking system:
 .nf
-http://bugzilla.ximian.com.
+http://bugzilla.xamarin.com.
 .fi
 .PP
 .SH MAILING LISTS
 For details, visit:
 .nf
-http://mail.ximian.com/mailman/mono-list 
+http://lists.ximian.com/mailman/listinfo/mono-devel-list
 .fi
 .SH WEB SITE
 For details, visit: 
 .nf
-http://www.go-mono.com 
+http://www.mono-project.com 
 .fi
 .PP
 .SH SEE ALSO
-mono(1), mint(1)
+mono(1)