NAME

sqlayin - input drivers for sqlay.

SYNOPSIS

libsqlayindummy.so sqlayindummy, driver for a dummy database engine.

libsqlayinfiles.so sqlayinfiles, driver for SQL files.

libsqlayinfilet.so sqlayinfilet, driver for csv or tab separated files.

libsqlayinslite.so sqlayinslite, driver for SQLite.

libsqlayinmdbtl.so sqlayinmdbtl, driver for MDBTools.

libsqlayinpgsql.so sqlayinpgsql, driver for PostgreSQL.

libsqlayinmysql.so sqlayinmysql, driver for MySQL.

libsqlayinfrtds.so sqlayinfrtds, driver for FreeTDS.

libsqlayinodbcu.so sqlayinodbci, driver for unixODBC.

libsqlayinodbci.so sqlayinodbci, driver for iodbc.

[sqlaytool] [options] drivername:datasource

DESCRIPTION

sqlayin is a small collection of input drivers for sqlay, meant to support SQL DDL and DML or one of these, read-write or read-only.

INVOCATION

The drivers are loaded by the sqlaytool front-end executables through URL's in the form drivername:datasource. An exception to this is the sqlayinfiles driver which uses file: instead of files: as driver name.

Additional options, i.e. specific to a driver, may also be passed to the driver through -i command line options of the front-end.

OPTIONS

Here are global options. Please, also refer to the drivers man pages for more detailed info.

• Datasource:
  • //[[user[:password]@]host[:port]]/[database]/[<table>|<table name pattern>]] where:
  • user User name to use for the connection, default to $USER
  • passwd Password to use for the connection, (barely tested).
  • host Host to connect to, default localhost.
  • port Port to connect to.
  • database Database to connect to, default $USER.
  • table name pattern means that adding a percent ('%') at the end of the table name allows selection of multiple tables similarily to the -in option, but strict by default. Most driver allow use of '_' (underscore) as wildcard for a single character, as they use like operators to build the queries.
• Options:
  • -d level Debug level as bitmask > 16 (if compiled with debug).
  • -id string Driver to use for the connection.
  • -iu string User name to use for the connection.
  • -ip string Password to use for the connection.
  • -ih string Host name to connect to.
  • -iP integer Port number to connect to.
  • -iD string Database name to connect to.
  • -it filter Table name to use (similar to -in but strict, or to table name pattern).
  • -in filter Filter on tables whose name begin with string (similar to table name pattern, but not strict).
  • -ix filter Exclude tables whose name begin with string.

FEATURES

The purpose of those drivers is to feed in a simple manner, with a very small set of functions, front-end executables with a minimum amount of metadata helpfull either for database schema overview or design, or for reasonably comfortable data entry.

Drivers are designed to be able to detect tables, views and columns, (commonly used) datatypes with their length, precision, not null flags and default values, primary and foreign keys, indexes with their unique flag set or unset, a count of data by table, comments on tables and columns, grants on tables and views.

They currently do not detect checks on columns nor tables, non-standard triggers, stored procedures, sequences, schemas or ownerships, and they will very probably never support various server optimization options targetted towards DBA's and, by principle, hidden to end-users like tablespaces, ...

Also they should normally not be able, at this stage, to handle spaces in object names, nor binary data in DML.

They are currently supposed to be read-write for DML only. Here comes a summary of the features.

• debuglevel Allows to track parsing or querying.
• connection Currently, the driver will share the connection with any request.
• DDL selection of tables Reads metadata on tables and views.
• DDL selection of references Reads metadata on references (barely tested).
• DML selection Reads data.
• DML execution Writes data.

Please, also refer to the drivers man pages for supported / unsupported features.

ENVIRONMENT

Besides from USER, used as default database name, SQLAYDRIVER may be used to override the default driver specified at compile time.

NOTES

A compiled-in driver named null exists as well which always returns success on connection or disconnection requests but always nothing or error on any other request.

Pls understand that this is an alpha release and none of the executables is securized against buffer overflows, and so on.

Also, the drivers are not thread safe. Not even the connections are safe. The API has really been designed until now for use on trusted developpement machines, accessed only by trusted users.

Above this, there may be (lot of) memory leaks in them. So, for small scale use, they are fine, but you should not expect much more for now.

BUGS

See the NOTE above for important security warnings.

AUTHOR

E. Lurquin <sqlay@hitud.net>

SEE ALSO

sqlayindummy(1), sqlayinfiles(1), sqlayinfilet(1), sqlayinslite(1), sqlayinmdbtl(1), sqlayinpgsql(1), sqlayinmysql(1), sqlayinfrtds(1), sqlayinodbc3(1), sqlay(1), sqlds(1)