persistent-mysql-haskell: A pure haskell backend for the persistent library using MySQL database server.

[ database, library, mit, program, yesod ] [ Propose Tags ]

This package contains a backend for persistent using the MySQL database server. Internally it uses the mysql-haskell package in order to access the database. See for more.

This package supports only MySQL 5.1 and above. However, it has been tested only on MySQL 5.5. Only the InnoDB storage engine is officially supported.

Known problems:

  • This package does not support statements inside other statements.

[Skip to Readme]


[Index] [Quick Jump]


Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


  • No Candidates
Versions [RSS],,,,, 0.3.3, 0.3.4,, 0.3.5, 0.3.6, 0.4.0, 0.4.1, 0.4.2, 0.5.0, 0.5.1, 0.5.2, 0.6.0
Change log
Dependencies aeson (>=1.0), base (>=4.9 && <5), bytestring (>=0.10.8), conduit (>=1.2.12), containers (>=0.5), io-streams (>=1.2 && <2.0), monad-logger, mysql-haskell (>= && <1.0), network (>=2.3 && <4.0), persistent (>=2.10.0 && <3), persistent-mysql-haskell, persistent-template, resource-pool, resourcet (>=1.1), text (>=1.2), time (>=1.5.0), tls (>=1.3.5 && <1.5), transformers (>=0.5), unliftio-core [details]
License MIT
Author Naushadh <>, Felipe Lessa <>, Michael Snoyman
Maintainer Naushadh <>
Category Database, Yesod
Home page
Bug tracker
Source repo head: git clone git:// -b persistent-mysql-haskell(persistent-mysql-haskell)
Uploaded by naushadh at 2019-12-28T18:54:01Z
Executables persistent-mysql-haskell-example
Downloads 9116 total (35 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2019-12-28 [all 1 reports]

Readme for persistent-mysql-haskell-0.6.0

[back to package description]


hackage version Build Status

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.


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 AWS, 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 Amazon Linux (and possibly on other Linux distros).

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:

    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
  • mysql-haskell and mysql have different APIs/mechanisms for securing the connection to MySQL. persistent-mysql-haskell exposes an API to utilize TLS client params that ships with mysql-haskell.

    connectInfoCustomCaStore :: MySQLConnectInfo
    - connectInfoCustomCaStore = connectInfo { connectSSL = Just customCaParams }
    + connectInfoCustomCaStore = setMySQLConnectInfoTLS customCaParams connectInfo
    -         customCaParams = defaultSSLInfo { sslCAPath = "foobar.pem" }
    +         customCaParams = makeClientParams $ CustomCAStore "foobar.pem"

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.


In order to use persistent-mysql-haskell with yesod you have to modify Settings.hs:

- import Database.Persist.MySQL     (MySQLConf (..))
+ import Database.Persist.MySQL     (MySQLConf, mkMySQLConf, myConnInfo, myPoolSize, setMySQLConnectInfoCharset)
- import qualified Database.MySQL.Base as MySQL
-         -- This code enables MySQL's strict mode, without which MySQL will truncate data.
-         -- See for details
-         -- If you choose to keep strict mode enabled, it's recommended that you enable it in your my.cnf file so that it's also enabled for your MySQL console sessions.
-         -- (If you enable it in your my.cnf file, you can delete this code).
-         let appDatabaseConf = fromYamlAppDatabaseConf { myConnInfo = (myConnInfo fromYamlAppDatabaseConf) {
-                 MySQL.connectOptions =
-                   ( MySQL.connectOptions (myConnInfo fromYamlAppDatabaseConf)) ++ [MySQL.InitCommand "SET SESSION sql_mode = 'STRICT_ALL_TABLES';\0"]
-               }
-             }

And in Application.hs:

- import qualified Database.MySQL.Base as MySQL
  import Network.Wai.Handler.Warp             (Settings, defaultSettings,
                                               runSettings, setHost,
-                                              setFork, setOnOpen, setOnClose,
+                                              setFork,
                                               setOnException, setPort, getPort)
-     -- See
-     MySQL.initLibrary
-     $ setOnOpen (const $ MySQL.initThread >> return True)
-     $ setOnClose (const MySQL.endThread)

Optionally you may enable the MYSQL strict mode (in each transaction) by modifying Foundation.hs (or editing the my.cnf server configuration):

- import Database.Persist.Sql (ConnectionPool, runSqlPool)
+ import Database.Persist.Sql (ConnectionPool, rawExecute, runSqlPool)
-         runSqlPool action $ appConnPool master
+         runSqlPool
+           (rawExecute "SET SESSION sql_mode = 'STRICT_ALL_TABLES'" [] >> action)
+           (appConnPool master)


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.

    stack test persistent-test --flag persistent-test:mysql_haskell --exec persistent-test