m (Removed "Refactoring the test cases" as it is done now)
(Updated the link to HDBC)
Revision as of 21:26, 2 January 2011
1 Short Introduction
MetaHDBC is a project that uses Template Haskell and HDBC to do statically checked database access. The programmer writes ordinary SQL, which is then validated by a relational database management system (RDMS). If the RDMS' ODBC driver supports type inference, then MetaHDBC also makes use of the infered types to do static type checking. Validation and type checking both occurs at compile-time.
2 Getting started with MetaHDBC
There is no real tutorial about MetaHDBC. Nonetheless, the MetaHDBC draft paper will help you get started. Especially the first few chapters will be good for beginners.
After installation you can look at the examples directory in the repository to get started easily with MetaHDBC.
For a little background, see this haskell-cafe post which got the project started.
MetaHDBC is implemented and can be used, but it has some shortcomings.
MetaHDBC do not implement a SQL (or relational algebra) type inference engine itself. In stead it ask a RDMS (though ODBC) to infer the result of a SQL statement. Unfortunately, popular open source database like PostgreSQL, MySQL and SQLite do a poor job reporting the type of SQL statements. On the other hand, if you use IBM's DB2, you are in luck as DB2's ODBC driver do a good job of reporting the type of SQL statements. We have not tested MS SQL server's ability to report types of SQL statements, but we suspect it is also good. If you try to use MetaHDBC with MS SQL server, then please report the results.
Second, MetaHDBC have not seen much use, so bugs may be lurking that has yet to be fixed.
If you are interested in helping out with any of the following task, please contact me. If you have other tasks, that could help MetaHDBC, it would also be beneficiary to contact me before starting.
4.1 Make popular open source database report type inference result though ODBC
For MetaHDBC to shine we need to RDMS's ODBC drivers to:
- report the type of SQL statements though ODBC, see SQLDescribeParam, SQLDescribeCol, ...
- we need the reported types to be available before we execute a SQL statement
Currently, we have found no open source database, which satisfy the two requirements above. This is unfortunately as it makes MetaHDBC a lot less valuable.
4.2 Testing MetaHDBC on MS Windows
MetaHDBC has only been run on Linux. We would especially like to see MetaHDBC used with MS SQL server, as we expect (hope for) SQL server to have good type inference.
4.3 Removing the need to patch HDBC
To make MetaHDBC compile we need to patch HDBC. It would be better if did not need this.
The need can be removed by either making our own binding towards ODBC, or by making a patch that would be acceptable by the HDBC maintainer (John Goerzen). The latter solution would be preferable and we have made two feature request towards HDBC-ODBC, here and here. However, feature requests is one thing, working maintainable code is another. Please consider implementing the two feature requests in such a way that they could be included in the HDBC-ODBC package. You should, of cause, talk to John Goerzen before implementing these feature requests.