| Documentation of sqlFree V3.0
Screenshot
DB configuration
Viewing results
Installation and Configuration
Visual SQLBuilder
| Available menus:
|  | Databaseconfiguration lets you set database-parameters like db-name, login-information etc.. Load statements loads preconfigured SQL-statements and shows them in your history. On how you can make SQL-statements available you'll get more information at the configuration-part. Clear field clears the area in which SQL-statements are entered.
| This menu let's you cut/copy/paste text from the statement-area to/from your clipboard.
|  | Here you can create new instances of the visual SQLBuilder. You may create an empty visualBuilder to form a completely new SQL-statement.
The other option is to visualize a given SQL-statement by the visualBuilder. With this feature you're able to visualize SQL-statements generated by other applications very easy. |
|  | You're enabled to show DB-information directly: show table- and columnnames including information on them.
Statementarea:
| You can type your queries into this field. Generated statements by the visualSQLBuilder are also put into this area. To send your query to the database you have specified in the options-window you have to press the button . If you think your statement is worth it to be remembered for later you can put it into the history by pressing the button .
DB-configuration | All information needed for a connection to the database has to be filled in here:
Use profile: | Preconfigured settings may be chosen here. They can be configured in the file cfg/configSqlFree.xml
Login: | Login for the database. Optional.
Password: | Password for login. Optional.
DB-Name: | Choose the DB-Name from the list or type the name/URL. On Windows systems the content of odbc.ini is shown in the dropdown-list by default. Examples: Connecting over the JDBC-ODBC-bridge just enter the appropriate name configured on your system. Connecting over JDBC you are able to specify locations, ports etc.. The syntax is protocol specific (refer to the Protocol entry). @localhost:1521:myhome //computer.mydomain.com:3800/mydb
Computer RMI-Registry: | You can also connect to a running RMI-Server or make direct connections from your local PC. A scenario for using this could be that there's one machine which is configured for DB access but the others are not. For RMI-connections you have to enter the location where the RMI-Registry of sqlFree is running on. You have to press Enter in this field after typing the name of the remote computer. This is the trigger for getting the information from the RMI-Server. Optional. Example: mycomputer.anywhere.com (or an IP-address)
Protocol: | Enter the protocolname to use for communication. Examples: jdbc:odbc: jdbc:oracle:thin:
Driverclass: | A defaultdriver is specified. Feel free to use any other driver. Examples: sun.jdbc.odbc.JdbcOdbcDriver oracle.jdbc.driver.OracleDriver
Datasets to read at once: | Specify the number of results to be read in a block. If there are less results: ok. If there are more results you will have the possibility to click 'Next results' in the 'Resultarea' of SQLFree window. This is useful if there may be huge resultsets. They will be read en block.
Viewing results |
Results are shown in a separate window. The SQL-statement which has been executed is shown in the top of the window. Initially the amount of result-sets is being shown which has been configured in the DB configuration. Should there be more results to be read you may press or if you want to see all results (Be careful if there may be many results left). Note: A lazy-read mechanism is implemented. Only the shown results are read from the database.
Installation and Configuration | General: Requirements on software: sqlFree was developed for jre1.3 but should also work under jre1.2.2. Configurationfiles can generally be found in sqlFree/cfg. All below mentioned files can be found in there. Output and logging is redirected to sqlFree/log by default. Configuration: To run sqlFree from your commandline or Fileexplorer the only setting to be done is to adjust your PATH. Afterwards sqlFree may be starting by calling the appropriate batch (or shellscript).
| cfg/setpath.bat: Here you only have to change the environmentvariable PATH. You should complete the PATH variable with the bin-directory location of your java-installation. This file only has to be modified if sqlFree is being run under Windows.
| cfg/setpath: In this file you only have to change the environmentvariable PATH. You should complete the PATH variable with the bin-directory location of your java-installation. This file only has to be modified if sqlFree is being run under Linux/Unix.
Using different JDBC-Drivers: To use sqlFree with different JDBC-Drivers just edit the file sqlFree/cfg/setpath.bat The environment-variable CLASSPATH has to be extended with the appropriate jar-filenames. Restart sqlFree afterwards and you should be able to use your own JDBC-Driver. Shipped with the application you can find an Oracle-thin-driver and a mySQL-driver. Feel free to put additional JDBC-drivers into your classpath. Please refer to the appropriate sites to get the latest versions of JDBC-drivers. Registration:
| Registration can be obtained at http://www.independencesoft.com
| If you have purchased a registrationcode just put the cryptic looking line into the file sqlFree/cfg/license.sqlFree
| Example: Only "738;rYkftkcth28352fs52e43" should be put into the file sqlFree/cfg/license.sqlFree.
configSqlFree.xml:
| Defaultvalues and profiles may be defined in this config-file. In the following you'll find an example configuration XML-file. The explanation is attached where needed.
<?xml version="1.0"?> |
<data> |
<display> |
<default> |
<login>anonymous</login> | Defaultlogin.
<pathtoodbcini>d:\\winnt\\odbc.ini</pathtoodbcini> | File for odbc-list.
<protocollist> |
<protocol name='bridge'>jdbc:odbc:</protocol> | Protocols with
<protocol name='mysql' >jdbc:mysql:</protocol> | name.
</protocollist> |
<dbhostportlist> |
<dbhostport name='testdb' >Testdatenbank</dbhostport> | Reference to DB
<dbhostport name='mysqlhome' >//localhost/mysql</dbhostport> | with unique name.
</dbhostportlist> |
<driverclasslist> |
<driverclass name='bridge'>sun.jdbc.odbc.JdbcOdbcDriver</driverclass> | Driver-class with
<driverclass name='mysql' >org.gjt.mm.mysql.Driver</driverclass> | name.
</driverclasslist> |
</default> |
<preconfigured> |
<config> |
<name>Access DB Test</name> | Profilename.
<login></login> | Defaultlogin.
<rmi></rmi> | RMI-Server(opt).
<protocol>bridge</protocol> | References to
<dbhostport>testdb</dbhostport> | named entries in
<driverclass>bridge</driverclass> | default-section.
</config> <config> <name>mySQL DB Test</name> <login>root</login> <protocol>mysql</protocol> <dbhostport>mysqlhome</dbhostport> <driverclass>mysql</driverclass> </config> </preconfigured> </display> </data> |
| <preconfigured>-section: You may specify multiple config-blocks. The configured elements will be mapped to the appropriate fields in the GUI where DB data can be specified.
Preconfigured queries:
| sqlStatements.sqlFree: You can make predefined queries available by putting them into this file. A user loading the statements in the main window will get these queries. Feel free to use placeholders in these queries, too (have a closer look at the Visual SQLBuilder-documentation).
| [A queryname] --query with comments --comments are optional select * from ... and so forth

Up to date versions at http://www.independencesoft.com