Database.Persist.MySQL

A MySQL backend for persistent.

Documentation

withMySQLPool

Arguments

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

=> MySQLConnectInfo

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)

=> MySQLConnectInfo

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)

=> MySQLConnectInfo

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 MySQLConnectInfo

MySQL connection information.

Instances

Show MySQLConnectInfo

Methods

showsPrec :: Int -> MySQLConnectInfo -> ShowS

show :: MySQLConnectInfo -> String

showList :: [MySQLConnectInfo] -> ShowS

mkMySQLConnectInfo

Arguments

:: HostName

hostname

-> ByteString

username

-> ByteString

password

-> ByteString

database

-> MySQLConnectInfo

Public constructor for MySQLConnectInfo.

setMySQLConnectInfoPort :: PortNumber -> MySQLConnectInfo -> MySQLConnectInfo

Update port number for MySQLConnectInfo.

setMySQLConnectInfoCharset

Arguments

:: Word8

Numeric ID of collation. See https://dev.mysql.com/doc/refman/5.7/en/show-collation.html.

-> MySQLConnectInfo

Reference connectInfo to perform update on

-> MySQLConnectInfo

Update character set for MySQLConnectInfo.

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.

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

mkMySQLConf

Arguments

:: MySQLConnectInfo

The connection information.

-> Int

How many connections should be held on the connection pool.

-> MySQLConf

Public constructor for MySQLConf.

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.

TLS configuration

setMySQLConnectInfoTLS

Arguments

:: ClientParams

ClientParams to establish a TLS connection with.

-> MySQLConnectInfo

Reference connectInfo to perform update on

-> MySQLConnectInfo

Set TLS ClientParams for MySQLConnectInfo.

data TrustedCAStore :: *

The whole point of TLS is that: a peer should have already trusted some certificates, which can be used for validating other peer's certificates. if the certificates sent by other side form a chain. and one of them is issued by one of TrustedCAStore, Then the peer will be trusted.

Constructors

SystemCAStore

provided by your operating system.

MozillaCAStore

provided by Mozilla.

CustomCAStore FilePath

provided by your self, the CA file can contain multiple certificates.

Instances

Eq TrustedCAStore

Methods

(==) :: TrustedCAStore -> TrustedCAStore -> Bool

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

Show TrustedCAStore

Methods

showsPrec :: Int -> TrustedCAStore -> ShowS

show :: TrustedCAStore -> String

showList :: [TrustedCAStore] -> ShowS

makeClientParams

Arguments

:: TrustedCAStore

trusted certificates.

-> IO ClientParams

make a simple tls ClientParams that will validate server and use tls connection without providing client's own certificate. suitable for connecting server which don't validate clients.

we defer setting of clientServerIdentification to connecting phase.

Note, tls's default validating method require server has v3 certificate. you can use openssl's V3 extension to issue such a certificate. or change ClientParams before connecting.

makeClientParams'

Arguments

:: FilePath

public certificate (X.509 format).

-> [FilePath]

chain certificates (X.509 format). the root of your certificate chain should be already trusted by server, or tls will fail.

-> FilePath

private key associated.

-> TrustedCAStore

trusted certificates.

-> IO ClientParams

make a simple tls ClientParams that will validate server and use tls connection while providing client's own certificate as well. suitable for connecting server which validate clients.

Also only accept v3 certificate.

Orphan instances

Show ConnectInfo

Methods

showsPrec :: Int -> ConnectInfo -> ShowS

show :: ConnectInfo -> String

showList :: [ConnectInfo] -> ShowS