Safe Haskell	None
Language	Haskell2010

Database.Persist.ODBC

Description

An ODBC backend for persistent.

Synopsis

withODBCPool :: (MonadUnliftIO m, MonadLogger m) => Maybe DBType -> ConnectionString -> Int -> (ConnectionPool -> m a) -> m a
withODBCConn :: (MonadUnliftIO m, MonadLogger m) => Maybe DBType -> ConnectionString -> (SqlBackend -> m a) -> m a
createODBCPool :: (MonadUnliftIO m, MonadLogger m) => Maybe DBType -> ConnectionString -> Int -> m ConnectionPool
type ConnectionString = String
data OdbcConf = OdbcConf {
- odbcConnStr :: ConnectionString
- odbcPoolSize :: Int
- odbcDbtype :: String
}
openSimpleConn :: LogFunc -> Maybe DBType -> Connection -> IO SqlBackend
data DBType
- = MySQL
- | Postgres
- | MSSQL {
  - mssql2012 :: Bool
  }
- | Oracle {
  - oracle12c :: Bool
  }
- | DB2
- | Sqlite {
  - sqlite3619 :: Bool
  }
mysql :: DBType
postgres :: DBType
mssqlMin2012 :: DBType
mssql :: DBType
oracleMin12c :: DBType
oracle :: DBType
db2 :: DBType
sqlite :: DBType

Documentation

withODBCPool Source #

Arguments

:: (MonadUnliftIO m, MonadLogger m)
=> Maybe DBType
-> ConnectionString	Connection string to the database.
-> Int	Number of connections to be kept open in the pool.
-> (ConnectionPool -> m a)	Action to be executed that uses the connection pool.
-> m a

Create an ODBC 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.

withODBCConn :: (MonadUnliftIO m, MonadLogger m) => Maybe DBType -> ConnectionString -> (SqlBackend -> m a) -> m a Source #

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

createODBCPool Source #

Arguments

:: (MonadUnliftIO m, MonadLogger m)
=> Maybe DBType
-> ConnectionString	Connection string to the database.
-> Int	Number of connections to be kept open in the pool.
-> m ConnectionPool

Create an ODBC connection pool. Note that it's your responsibility to properly close the connection pool when unneeded. Use withODBCPool for an automatic resource control.

type ConnectionString = String Source #

An HDBC-odbc connection string. A simple example of connection string would be DSN=hdbctest1.

data OdbcConf Source #

Information required to connect to an ODBC database using persistent's generic facilities. These values are the same that are given to withODBCPool.

Constructors

OdbcConf
Fields odbcConnStr :: ConnectionString The connection string. odbcPoolSize :: Int How many connections should be held on the connection pool. odbcDbtype :: String

Instances

PersistConfig OdbcConf Source #
Instance details Defined in Database.Persist.ODBC Associated Types type PersistConfigBackend OdbcConf :: (Type -> Type) -> Type -> Type type PersistConfigPool OdbcConf :: Type Methods loadConfig :: Value -> Parser OdbcConf applyEnv :: OdbcConf -> IO OdbcConf createPoolConfig :: OdbcConf -> IO (PersistConfigPool OdbcConf) runPool :: MonadUnliftIO m => OdbcConf -> PersistConfigBackend OdbcConf m a -> PersistConfigPool OdbcConf -> m a
type PersistConfigBackend OdbcConf Source #
Instance details Defined in Database.Persist.ODBC type PersistConfigBackend OdbcConf = SqlPersistT
type PersistConfigPool OdbcConf Source #
Instance details Defined in Database.Persist.ODBC type PersistConfigPool OdbcConf = ConnectionPool

openSimpleConn :: LogFunc -> Maybe DBType -> Connection -> IO SqlBackend Source #

Generate a persistent Connection from an odbc Connection

data DBType Source #

List of DBMS that are supported

Constructors

MySQL
Postgres
MSSQL
Fields mssql2012 :: Bool
Oracle
Fields oracle12c :: Bool
DB2
Sqlite
Fields sqlite3619 :: Bool

Instances

Read DBType Source #
Instance details Defined in Database.Persist.ODBCTypes Methods readsPrec :: Int -> ReadS DBType # readList :: ReadS [DBType] # readPrec :: ReadPrec DBType # readListPrec :: ReadPrec [DBType] #
Show DBType Source #
Instance details Defined in Database.Persist.ODBCTypes Methods showsPrec :: Int -> DBType -> ShowS # show :: DBType -> String # showList :: [DBType] -> ShowS #

mysql :: DBType Source #

postgres :: DBType Source #

mssqlMin2012 :: DBType Source #

mssql :: DBType Source #

oracleMin12c :: DBType Source #

oracle :: DBType Source #

db2 :: DBType Source #

sqlite :: DBType Source #