persistent-mysql-haskell

A pure haskell backend for the persistent library using MySQL database server. http://www.yesodweb.com/book/persistent

Stackage Nightly 2017-06-23:0.3.0.0
Latest on Hackage:0.3.0.0
MIT licensed by Naushadh, Felipe Lessa, Michael Snoyman
Maintained by Naushadh

Module documentation for 0.3.0.0

persistent-mysql-haskell

hackage version

A pure haskell backend for persistent using the MySQL database server. Internally it uses the mysql-haskell driver in order to access the database.

See example/Main.hs for how this MySQL backend can be used with Persistent.

Motivation

persistent-mysql uses mysql (via mysql-simple) as the database driver. mysql is a haskell FFI wrapper for mysqlclient written in C.

Reasons to use a pure haskell driver:

Personal experience on replacing mysql-simple with mysql-haskell in a project:

  • Performance gains consistent with benchmark.

  • Smoother deployment to Amazon AMI/EC2, since mysql appears to have a hard dependency on the oracle version of libmysqlclient that does not work with the open source variant that is available by default on EC2 (and possibly on other cloud providers).

Potential issues moving from persistent-mysql to persistent-mysql-haskell

ConnectInfo and defaultConnectInfo are not the same between mysql and mysql-haskell, therefore this package is not a 100% drop in replacement for persistent-mysql from the connection configuration perspective.

  • mysql-haskell does not allow provide an API for the entirety of mysqlclient options. Therefore neither can this package.

  • Given the inevitable incompatibility with persistent-mysql, and in the interest of providing a forward-compatible API, ConnectInfo internals and defaultConnectInfo have been deprecated. However the similar utility can be achieved like so:

    ```diff import Database.Persist.MySQL

    connectInfo :: MySQLConnectInfo - connectInfo = defaultConnectInfo

    • { connectHost = "localhost"
    • , connectUser = "test"
    • , connectPassword = "test"
    • , connectDatabase = "test"
    • }
    • connectInfo = mkMySQLConnectInfo "localhost" "test" "test" "test"

    connectInfoNewPort :: MySQLConnectInfo - connectInfoNewPort = connectInfo { connectPort = 3307 } + connectInfoNewPort = setMySQLConnectInfoPort 3307 connectInfo

    connectInfoNewCharSet :: MySQLConnectInfo - connectInfoNewCharSet = connectInfo { connectOptions = [CharsetName "utf8"] } + connectInfoNewCharSet = setMySQLConnectInfoCharset 33 connectInfo

    ```

Aside from connection configuration, persistent-mysql-haskell is functionally on par with persistent-mysql (as of writing this). This can be seen by comparing persistent-test between this fork and upstream.

FAQs

Why isn't this part of the main/upstream persistent repo?

persistent-mysql supports X but persistent-mysql-haskell API doesn't. Why?

  • Internals (getters/setters) of MySQLConnectInfo and defaultConnectInfo are intentionally masked for forward compatibility.

  • For all others, feel free to open an issue and/or submit a PR.

Does persistent-mysql-haskell ship with tests?

  • It does! :) persistent-test is fully re-used with an additional flag to specifically test persistent-mysql-haskell.

    `bash stack test persistent-test --flag persistent-test:mysql_haskell `

Changes

0.3.0.0

0.2.1.0

  • Bumped up version to update README.

0.2.0.0

  • Added APIs for setting port number and character encoding.
  • Updated type signature for mkMySQLConnectInfo to align with mysql-haskell.

0.1.1.0

  • Bumped up version to include README and example.

0.1.0.0

  • Ported persistent-mysql 2.6 to use mysql-haskell as the underlying database driver.
  • Deprecated MySQLConf and ConnectInfo native constructor and default instance in favor of mk functions for better forward compatibility. See http://www.snoyman.com/blog/2016/11/designing-apis-for-extensibility.
comments powered byDisqus