The hesql package

[Tags: gpl, program]

hesql rewrites SQL-function to Haskell/HDBC-functions


[Skip to ReadMe]

Properties

Versions0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8
Change logNone available
Dependenciesbase (>=2 && <4), filepath, haskell-src, HDBC, HDBC-postgresql, hssqlppp (>=0.0.9), parsec [details]
LicenseGPL
AuthorChristoph Bauer <ich@christoph-bauer.net>
MaintainerChristoph Bauer <ich@christoph-bauer.net>
CategoryDatabase
Executableshesql
UploadedThu Nov 19 20:58:49 UTC 2009 by ChristophBauer
Downloads1321 total (68 in last 30 days)
Votes
0 []
StatusDocs not available [build log]
All reported builds failed as of 2015-05-31 [all 1 reports]

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for hesql-0.5

hesql - Haskell's embedded SQL

hesql is a preprocessor. It reads a file (module) with
SQL-like functions and translates it to Haskell source code.
It uses HDBC.

The result of a select statement is automatically converted
to list of tuples. Also fromSql/toSql conversion are done.

The current implementation is just a proof of concept with narrow limits.
It sticks to a subset of PostgreSQL's variant of SQL. Don't expect too
much, but please send me patches to improve hesql.

An example is found under example/Account.hesql. It works with this 
tables:


CREATE TABLE Account
  (AccountID SERIAL PRIMARY KEY,
   Login TEXT NOT NULL,
   Password TEXT NOT NULL,
   RealName TEXT,
   Email TEXT  NOT NULL,
   LoggedIn BOOL DEFAULT FALSE NOT NULL,
   Locked BOOL DEFAULT FALSE NOT NULL,
   LastLogout TIMESTAMP,
   LastRequest TimeStamp DEFAULT 'now' NOT NULL,
   Validated BOOL DEFAULT FALSE NOT NULL
 );

CREATE UNIQUE INDEX AccountIdx ON Account(Lower(Login));


A select query may return a list or just a maybe type. If you
just want the maybe type, use
   
   maybe select a from t where e;


It is planned, that a prefix "lazy" should work in the same way. Then with
"lazy", the lazy HBDC-fetchAllRows are used.
   

For example:

verifyLogin login password =
  maybe select Accountid, Login, RealName, Email from Account
     where (Password is null or Password  = md5(password)) and Lower(Login) = login
           and not Locked;

will generate code for a Haskell-function with the type:

verifyLogin :: Stmts -> String -> String -> IO (Maybe (Int, String, String, String))

(To be honest, the type is simplified by me. hesql won't write any type annotation.)

Each module will have a function

init :: Connection -> IO Stmts

it prepares each statement for the later use.


TODO
  - add a separate TODO file
  - parse group by, having, column/table aliases, subselects
  - verify table and column names
  - resolve column names in SELECT * FROM ...
  - fix command line argument parsing
  - improve documentation
  - make backup of old .hs-File


INSTALL
  $ make
  $ sudo make install


USAGE
  $ createdb account
  $ psql account

  # create the account table from above

  $ cd example/
  $ hesql Account.hesql dbname=account
  $ less Account.hs


DEPENDENCIES:

  hesql depends on 
    - ghc
    - postgresql
    - HDBC with PostgreSQL backend
    - haskell-src (to print the haskell code)
    - parsec (for the SQL parser)
    - do we have to call finish on Maybe-Statements?