SQLTool

Version 0.65 (21-May-2016)


SQLTool is public domain
------------------------
This program may be freely distributed for no more than the cost of the
media on which it is distributed. It remains at all times
 Copyright 1997 to 2003 R. F. Windley & The Really Small Software Company.

Disclaimer:
This software is supplied as is. No responsibility will be taken by the
author for any loss of data through the use or misuse of this application.


Introduction
------------
SQLTool is a simple tool which allows an SQL database to be interrogated via 
an ODBC connection. What are SQL and ODBC? If these terms mean nothing to
you then SQLTool probably won't be of much use, but see below for an
explanation anyway.

What is ODBC?
-------------
ODBC stands for Open DataBase Connectivity. Open Database Connectivity is a
widely accepted application programming interface (API) for database access. 
It is based on the Call-Level Interface (CLI) specifications from X/Open and 
ISO/IEC for database APIs and uses Structured Query Language (SQL) as its
database access language.

What is SQL?
------------
SQL is an acronym for Structured Query Language. It is a database query
language that was adopted as an industry standard in 1986.


Getting started
---------------

Loading SQLTool
---------------
SQLTool is loaded by double clicking on the SQLTool icon in the filer
display. Once loaded an the SQLTool icon will appear on the iconbar in the
standard way.

Connecting to a datasource
--------------------------
Clicking Select on the iconbar icon will display a window containing valid
datasources that have been set up for the computer you are using.

For how to set up datasources refer to the information that came with the
ODBC driver manager you are using.

Double clicking on a datasource will display an entity window.

Database entities
-----------------
This shows the different entities that can exist on that datasource.
Currently these are Tables and Procedures.

Tables
------
Double clicking on the Tables entity displays a list of tables (and views)
that are defined for the datasource.

What is a Table?
----------------
A Table is a little like a spreadsheet in that it is made up of rows and
columns of data. Each column has a heading (or name), a type and a size. A
row must consist of an entry for each column - although a column can be
empty. The contents of a typical table might be as follows:

Columns
-------
When a Table is double clicked on the Columns that make up the table
definition are shown. 

All that is shown here is information about the columns themselves, not the
data contained within the columns. Rather than displaying just the name of
the columns it can be useful to display the type and size as well. This can
be done by choosing Display -> Full info from the main menu.

Viewing data on a table
-----------------------
The easiest way to view data is to highlight the table to view and choose
Item -> Return all rows... from the main menu. This will display a window
showing all of the rows on the table.

By editing the query displayed in this window and clicking Run the result
set can be changed. The query does not have to be restricted to a SELECT
statement against a single table, it can be any valid SQL query.

Adding columns to a query
-------------------------
Columns and Tables can be added to a query by highlighting the required
items and dragging them to the query window. Their names will then be
inserted into the query.

Exporting data
--------------
Data that is showing in a result window can be exported to other
applications. Clicking Menu over the data displays a small export menu which 
allows the data to be exported as a Text, CSV or TSV file.

The main menu
-------------
The main menu is displayed by clicking Menu over a window. The following
options are available:

Display
Moving the pointer over this option shows the Display menu. This allows the
size and level of detail for items to be set.

Large icons
Displays the items using large icons.

Small icons
Displays the items using small icons.

Full info
Displays the items using small icons and item information.

Entity
This provides a single item:

Choosing this item will return all the the rows of data for the Tables or
Columns that have been highlighted.

Select all
Choosing this will cause all items to be selected. This can also be achieved 
by pressing Control A.

Clear selection
Choosing this will cause all selected items to be unselected. This can also
be achieved by pressing Control Z.

Query
Choosing this item will display a blank query window allowing a new query to 
be entered.

The iconbar menu
----------------
Clicking Menu over the SQLTool icon on the iconbar will display this menu:

The following items are available:

Info
Moving the mouse pointer over this item displays the About this program
window which displays version information about SQLTool.

Quit
Choosing this item will cause SQLTool to exit.

Versions
--------
0.65
Provide version that works on RISC OS 5
Rebrand

0.63
Ordered table and columns by name

0.62
Added support for SQLServer types
Fixed NULL handling error
Allowing setting of SQLTool$FontWidth in !Run if results get clipped
Handle binary types better

0.61
Changed settings of query text gadget
