JSQLTool Project
===================

1. Requirements
------------
The following files must be available to execute JSQLTool:
- images.jar 
- jsqltool.jar
- jcalendar.jar
- poi-2.0-RC2-20040102.jar
- jgraph.jar
- itext-1.4.3.jar


2. Directory Structure
-------------------
src		source file of JSQLTool project.

build		jar files and .bat/.sh start files.

doc/api		javadoc files

doc		documentation files.


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

JSQLTool is based on these files:
- images.jar - contains all application images. These images are all freeware.
- jsqltool.jar - contains all application classes.
- jcalendar.jar - an open source library (LGPL) for viewing a calendar, written by Kai Toedter
- poi-2.0-RC2-20040102.jar - an open source library used to generate Excel (XLS) files
- jgraph.jar - an open source library used to create diagrams (nodes, edges...)
- itext-1.4.3.jar - an open source library used to render a document in PDF format

which are available in build directory.
Use run.bat or run.sh to start the application.

JDK 1.4 is required.

If you want to connect to a database without using ODBC, you have to provide a JDBC Driver for the specific database.
Usually a JDBC Driver is provided by the database vendor (Oracle, MS SQL Server, IBM DB2...).
Once you have obtained the JDBC Driver, add these files (jar files) to JSQLTool classpath, i.e. edit run.bat or run.sh file and add the JDBC Driver file name.

For example, if you want to connect to Oracle Database, edit run.bat, by adding "ojdbc14.jar" file (JDBC Driver for Oracle Database):

javaw -cp .;images.jar;jsqltool.jar;jcalendar.jar;poi-2.0-RC2-20040102.jar;jgraph.jar;itext-1.4.3.jar;ojdbc14.jar org.jsqltool.MainApp


For example, if you want to connect to MS SQLServer Database, edit run.bat, by adding the files mssqlserver.jar, msbase.jar and msutil.jar (JDBC Driver for MS SQLServer Database):

javaw -cp .;images.jar;jsqltool.jar;jcalendar.jar;poi-2.0-RC2-20040102.jar;jgraph.jar;itext-1.4.3.jar;mssqlserver.jar;msbase.jar;msutil.jar org.jsqltool.MainApp



4. How to use the application
----------------------

JSQLTool is java swing SQL Tool which can be used to: 
- connect to a database, using a JDBC or ODBC Driver 
- view tables, views and synonyms list 
  - for each table/view/synonym you can see entity details, like: structure, data, indexes and constraints 
  - table data can be visually ordered/filtered; you can add/edit/delete records directly on the table data grid 
  - table data can be exported as insert SQL statements, as text or in an Excel File Format (XLS) 
- edit SQL statements in a SQL shell (with text colored according to SQL syntax), by means of it you can execute queries or other statements and see query results; queries may contain parameters 
  - previous SQL statements are recorded to allow re-call and re-execution 

Many other features are available, according to the database type: edit/drop contraints, execution query explain plan, trace sessions. 
Table detail is pluggable: developers can add other table plugins to easly extends the application. 

The whole application is designed to support multi-language and internationalization settings.
At the moment these are the languages supported: english, french and italian. 



