mysql / README.markdown

# mysql: bindings to the mysqlclient library

This library is a Haskell binding to the MySQL `mysqlclient` client
library.  It is a fairly faithful, low level library that implements
most of the MySQL client API.

This library deliberately avoids the question of providing a "good"
API. Its purpose is to serve as a base on which higher-level libraries
can be build.

# Licensing

This library is BSD-licensed under the terms of the
[MySQL FOSS License Exception](http://www.mysql.com/about/legal/licensing/foss-exception/).

Since this library links against the GPL-licensed `mysqlclient`
library, a non-open-source application that uses it *may* be subject
to the terms of the GPL.

# To do

* Add support for prepared statements. This API is huge and of dubious
  performance worth, so it's not currently a priority for me. Patches
  welcome!

# Get involved!

We are happy to receive bug reports, fixes, documentation enhancements,
and other improvements.

Please report bugs via the
[github issue tracker](http://github.com/mailrank/mysql/issues).

Master [git repository](http://github.com/mailrank/mysql):

* `git clone git://github.com/mailrank/mysql.git`

There's also a [Mercurial mirror](http://bitbucket.org/bos/mysql):

* `hg clone http://bitbucket.org/bos/mysql`

(You can create and contribute changes using either git or Mercurial.)

# Authors

This library is written and maintained by Bryan O'Sullivan,
<bos@mailrank.com>.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.