4.2. Database descriptions

As mentioned above EasySQL uses it's own abstraction - an SQL database. Applications then refers to these databases not knowing about what real SQL engine serves queries. Databases are described by a text files in system directory (see db-dir parameter) and then in user's `~/.easysql' if it is enabled (see user-configs parameter). A name of text file used for description of database corresponds to the name of that database from EasySQL point of view.

Database description file consists from text lines; empty lines and lines beginning with `#' are ignored. Actual lines are formed from option name and value separated by spaces and/or tabulations. Only leading and trailing spaces are removed from values, no any other processing is done.

Only required option in every database description is ``driver'' -- by it's means a real engine driver used to connect to this database is defined.

All other options are entirely driver dependent; no any default values are provided for them. Though some names are recommended and commonly used -- here is an alphabetical list:

database

Internal database name of underlying engine (it's usually required; both `mysql' and `msql' drivers will not work without this option set, for example).

host

FQDN (full qualified domain name) of a host on which real SQL engine sits.

password

Password used (usually in pair with ``user'' option) for authorization purposes.

port

TCP port on which SQL database listens for queries.

socket

Unix socket used for communication with SQL database.

user

User name for authorization purposes.

Any options not set in database description may be set at run time through API calls. It's most usable for providing authorization information: host, socket etc may be set from database description, but user name and his password may be entered from keyboard for example.