Database.Persist.MySQL

A MySQL backend for persistent.

Documentation

withMySQLPool

Arguments

:: (MonadIO m, MonadLogger m, MonadBaseControl IO m, IsSqlBackend backend)

=> ConnectInfo

Connection information.

-> Int

Number of connections to be kept open in the pool.

-> (Pool backend -> m a)

Action to be executed that uses the connection pool.

-> m a

Create a MySQL connection pool and run the given action. The pool is properly released after the action finishes using it. Note that you should not use the given ConnectionPool outside the action since it may be already been released.

withMySQLConn

Arguments

:: (MonadBaseControl IO m, MonadIO m, MonadLogger m, IsSqlBackend backend)

=> ConnectInfo

Connection information.

-> (backend -> m a)

Action to be executed that uses the connection.

-> m a

Same as withMySQLPool, but instead of opening a pool of connections, only one connection is opened.

createMySQLPool

Arguments

:: (MonadBaseControl IO m, MonadIO m, MonadLogger m, IsSqlBackend backend)

=> ConnectInfo

Connection information.

-> Int

Number of connections to be kept open in the pool.

-> m (Pool backend)

Create a MySQL connection pool. Note that it's your responsibility to properly close the connection pool when unneeded. Use withMySQLPool for automatic resource control.

module Database.Persist.Sql

data ConnectInfo :: *

Constructors

ConnectInfo

Fields

• connectHost :: String
• connectPort :: Word16
• connectUser :: String
• connectPassword :: String
• connectDatabase :: String
• connectOptions :: [Option]
• connectPath :: FilePath
• connectSSL :: Maybe SSLInfo

Instances

Eq ConnectInfo

Methods

(==) :: ConnectInfo -> ConnectInfo -> Bool

(/=) :: ConnectInfo -> ConnectInfo -> Bool

Read ConnectInfo

Methods

readsPrec :: Int -> ReadS ConnectInfo

readList :: ReadS [ConnectInfo]

readPrec :: ReadPrec ConnectInfo

readListPrec :: ReadPrec [ConnectInfo]

Show ConnectInfo

Methods

showsPrec :: Int -> ConnectInfo -> ShowS

show :: ConnectInfo -> String

showList :: [ConnectInfo] -> ShowS

data SSLInfo :: *

Constructors

SSLInfo

Fields

• sslKey :: FilePath
• sslCert :: FilePath
• sslCA :: FilePath
• sslCAPath :: FilePath
• sslCiphers :: String

  Comma-separated list of cipher names.

Instances

Eq SSLInfo

Methods

(==) :: SSLInfo -> SSLInfo -> Bool

(/=) :: SSLInfo -> SSLInfo -> Bool

Read SSLInfo

Methods

readsPrec :: Int -> ReadS SSLInfo

readList :: ReadS [SSLInfo]

readPrec :: ReadPrec SSLInfo

readListPrec :: ReadPrec [SSLInfo]

Show SSLInfo

Methods

showsPrec :: Int -> SSLInfo -> ShowS

show :: SSLInfo -> String

showList :: [SSLInfo] -> ShowS

defaultConnectInfo :: ConnectInfo

Default information for setting up a connection.

Defaults are as follows:

• Server on localhost
• User root
• No password
• Database test
• Character set utf8

Use as in the following example:

connect defaultConnectInfo { connectHost = "db.example.com" }

defaultSSLInfo :: SSLInfo

Default (empty) information for setting up an SSL connection.

data MySQLConf

Information required to connect to a MySQL database using persistent's generic facilities. These values are the same that are given to withMySQLPool.

Constructors

MySQLConf

Fields

• myConnInfo :: ConnectInfo

  The connection information.

• myPoolSize :: Int

  How many connections should be held on the connection pool.

Instances

Show MySQLConf

Methods

showsPrec :: Int -> MySQLConf -> ShowS

show :: MySQLConf -> String

showList :: [MySQLConf] -> ShowS

FromJSON MySQLConf

Methods

parseJSON :: Value -> Parser MySQLConf

parseJSONList :: Value -> Parser [MySQLConf]

PersistConfig MySQLConf

Associated Types

type PersistConfigBackend MySQLConf :: (* -> *) -> * -> *

type PersistConfigPool MySQLConf :: *

Methods

loadConfig :: Value -> Parser MySQLConf

applyEnv :: MySQLConf -> IO MySQLConf

createPoolConfig :: MySQLConf -> IO (PersistConfigPool MySQLConf)

runPool :: (MonadBaseControl IO m, MonadIO m) => MySQLConf -> PersistConfigBackend MySQLConf m a -> PersistConfigPool MySQLConf -> m a

type PersistConfigPool MySQLConf

type PersistConfigPool MySQLConf = ConnectionPool

type PersistConfigBackend MySQLConf

type PersistConfigBackend MySQLConf = SqlPersistT

mockMigration :: Migration -> IO ()

Mock a migration even when the database is not present. This function will mock the migration for a database even when the actual database isn't already present in the system.