===========================
SQLWorks 0.6.1 - readme.txt
===========================

Copyright (C) Andrey Levichev, 2000.
homepage: http://www.uniyar.ac.ru/~lan
email: lan@uniyar.ac.ru


Contents
--------

1. Description
2. Requirements
3. Installation
4. Using SQLWorks
5. Uninstallation
6. Know bugs and limitations
7. Licence info
8. Comments and bug report


1. Description
--------------

SQLWorks allows you execute SQL statements and scripts against any ODBC 
data source. SQLWorks is based upon design of SQL Worksheet utility from 
Oracle Enterprise Manager. SQLWorks offers additional features and has some 
advantages over SQL Worksheet.

Features:

* Can execute SQL statements against any database which has ODBC driver.
* Can execute single statements or scripts consisting of many statements.
* Has handy design of main window, divided into two panes. One pane is used 
  to enter SQL commands and the other pane shows execution results.        
* Save output & spool output feature.
* Ability to find and replace text in editor.
* History of executed commands.
* Keyboard shortcuts to most often used commands.
* Small executable size in comparison with other similar programs.
* Disable output feature that can significantly speed up execution of 
  large scripts.


2. Requirements
---------------

* Microsoft Windows 95, Windows 98, Windows NT or Windows 2000.
* ODBC driver installed and configured.


3. Installation
--------------- 

* Create a folder for the program, for example c:\Program Files\SQLWorks. 
* Extract files from archive sqlwks.zip to this folder. Following files are 
  extracted:

    sqlwks.exe      program executable
    readme.txt      documentation
    sample.sql      sample file with SQL commands
    bugs.txt        full list of known bugs
    
* Create shortcut for the program on desktop or in Start menu.
* During first run program registers .sql extension, so you can open .sql 
  files from Windows Explorer.


4. Using SQLWorks
-----------------

Main window of the program is divided into two horizontal panes. Lower 
pane is called 'script pane'. It is used to enter and edit SQL commands. 
Upper pane is read-only. It is called 'output pane' and is used to output 
executed commands, query results and error messages. When you run SQLWorks, 
connect dialog appears. Here you can enter data source name, user name and 
password to connect to database (data source must be configured using 
Control Panel->ODBC drivers). Connection dialog disappears when connection 
is established. Connection information (user name and data source) is shown 
in the title of main window.

Once connected, you can enter and execute SQL commands. All common editing
operations are available including find and replace. You can use keyboard
commands to perform main tasks in SQLWorks:

Ctrl+Enter          Execute SQL commands in script pane
Alt+left arrow      Move to previously executed statement
Alt+right arrow     Move to next statement
F6                  Swap to the other pane.

When statements are executed, various information is printed in output pane 
depending on type of statement being executed. For every statement 
statement text is printed and if it is a query, query results are printed. 
For example, for query 'select * from accounts' the output is:

SQL> select * from accounts
id                 amount             
------------------ ------------------ 
1                  200                
2                  45                 
3                  420                
4                  -175               
4 row(s) fetched

If there is a error you will get error message after statement text:

SQL> select * from ccounts
Error: [Microsoft][ODBC SQL Server Driver][SQL Server]Invalid object name 
'ccounts'. SQLSTATE = S0002

After working for a long time you may wish to clear output pane from old 
results. To do it use Edit|Clear Output. If you want to save your results 
use File|Save Output command. During session you can use History feature to 
select previously executed commands from dialog or you can use Alt+arrows 
to move back/forward in history list. You can always use File|Change 
Connection to establish new connection during your session.

In Edit|Options there is a chechbox - 'Enable output for statements which 
don't produce resultset'. It is checked by default. If you uncheck it - SQL 
statements are not printed in output pane during execution. Results are 
printed only when statement is a query or when there is an error in the 
statement. Disabling output can significantly improve execution speed for 
some kinds of scripts. For example, when you create a large table:

drop table test;
create table test (...);
insert into test values (...);
    .
    .
    .
insert into test values (...);
commit;


5. Uninstallation
-----------------

* Delete folder and files of the program.
* Delete file associations from the registry:

    HKEY_CLASSES_ROOT\.sql
    HKEY_CLASSES_ROOT\Applications\sqlwks.exe
    
* Delete program configuration data from the registry:

    HKEY_CURRENT_USER\Software\SQLWorks


6. Know bugs and limitations
----------------------------

* Some fonts are set incorrectly on win2000 (for example fixedsys). This is 
  probably a bug in richedit control in Win2000. The same problem exists for 
  example with standard windows application - WordPad.
* System scripts will probably won't work in SQLWorks however they can. I 
  have no time to test all the scripts on all the databases. For example many 
  system scripts in Oracle include commands specific to SQL*Plus so they 
  won't work in SQLWorks. To be sure always use SQL*Plus for Oracle or other 
  corresponding utility to execute such scripts.
* This program doesn't work with Paradox tables. You must create primary key 
  for every Paradox table, but I don't know how.
* Of course this program contains a lot of other bugs. Full list is too 
  long and too boring to read ;-).


7. Licence info
---------------

This program is freeware. This means you can use and distribute it freely, 
without any charge. However commercial distribution of the program in any 
form without prior written permission of the author is strictly prohibited. 
The program is provided "as is" without express or implied warranty. Use it 
at your own risk. The author accepts no liability for any damage/loss of 
business that this product may cause. By using this program you accept the 
terms of this licence agreement.


8. Comments and bug report
--------------------------
                                                
If you have any comments, please send them to lan@uniyar.ac.ru.
If you are reporting a bug, please include a detailed report about
conditions which lead to the bug.

Latest updates can be found at: http://www.uniyar.ac.ru/~lan
