Database.Beam.Sqlite.Connection

Documentation

data Sqlite

The SQLite backend. Used to parameterize MonadBeam and FromBackendRow to provide support for SQLite databases. See the documentation for MonadBeam and the user guide for more information on how to use this backend.

Constructors

Sqlite

Instances

BeamSql92Backend Sqlite

BeamSqlBackend Sqlite

BeamBackend Sqlite

Associated Types

type BackendFromField Sqlite :: * -> Constraint

FromBackendRow Sqlite Bool

Methods

fromBackendRow :: FromBackendRowM Sqlite Bool

valuesNeeded :: Proxy * Sqlite -> Proxy * Bool -> Int

FromBackendRow Sqlite Char

Methods

fromBackendRow :: FromBackendRowM Sqlite Char

valuesNeeded :: Proxy * Sqlite -> Proxy * Char -> Int

FromBackendRow Sqlite Double

Methods

fromBackendRow :: FromBackendRowM Sqlite Double

valuesNeeded :: Proxy * Sqlite -> Proxy * Double -> Int

FromBackendRow Sqlite Float

Methods

fromBackendRow :: FromBackendRowM Sqlite Float

valuesNeeded :: Proxy * Sqlite -> Proxy * Float -> Int

FromBackendRow Sqlite Int

Methods

fromBackendRow :: FromBackendRowM Sqlite Int

valuesNeeded :: Proxy * Sqlite -> Proxy * Int -> Int

FromBackendRow Sqlite Int8

Methods

fromBackendRow :: FromBackendRowM Sqlite Int8

valuesNeeded :: Proxy * Sqlite -> Proxy * Int8 -> Int

FromBackendRow Sqlite Int16

Methods

fromBackendRow :: FromBackendRowM Sqlite Int16

valuesNeeded :: Proxy * Sqlite -> Proxy * Int16 -> Int

FromBackendRow Sqlite Int32

Methods

fromBackendRow :: FromBackendRowM Sqlite Int32

valuesNeeded :: Proxy * Sqlite -> Proxy * Int32 -> Int

FromBackendRow Sqlite Int64

Methods

fromBackendRow :: FromBackendRowM Sqlite Int64

valuesNeeded :: Proxy * Sqlite -> Proxy * Int64 -> Int

FromBackendRow Sqlite Integer

Methods

fromBackendRow :: FromBackendRowM Sqlite Integer

valuesNeeded :: Proxy * Sqlite -> Proxy * Integer -> Int

FromBackendRow Sqlite Word

Methods

fromBackendRow :: FromBackendRowM Sqlite Word

valuesNeeded :: Proxy * Sqlite -> Proxy * Word -> Int

FromBackendRow Sqlite Word8

Methods

fromBackendRow :: FromBackendRowM Sqlite Word8

valuesNeeded :: Proxy * Sqlite -> Proxy * Word8 -> Int

FromBackendRow Sqlite Word16

Methods

fromBackendRow :: FromBackendRowM Sqlite Word16

valuesNeeded :: Proxy * Sqlite -> Proxy * Word16 -> Int

FromBackendRow Sqlite Word32

Methods

fromBackendRow :: FromBackendRowM Sqlite Word32

valuesNeeded :: Proxy * Sqlite -> Proxy * Word32 -> Int

FromBackendRow Sqlite Word64

Methods

fromBackendRow :: FromBackendRowM Sqlite Word64

valuesNeeded :: Proxy * Sqlite -> Proxy * Word64 -> Int

FromBackendRow Sqlite ByteString

Methods

fromBackendRow :: FromBackendRowM Sqlite ByteString

valuesNeeded :: Proxy * Sqlite -> Proxy * ByteString -> Int

FromBackendRow Sqlite ByteString

Methods

fromBackendRow :: FromBackendRowM Sqlite ByteString

valuesNeeded :: Proxy * Sqlite -> Proxy * ByteString -> Int

FromBackendRow Sqlite Scientific

Methods

fromBackendRow :: FromBackendRowM Sqlite Scientific

valuesNeeded :: Proxy * Sqlite -> Proxy * Scientific -> Int

FromBackendRow Sqlite Text

Methods

fromBackendRow :: FromBackendRowM Sqlite Text

valuesNeeded :: Proxy * Sqlite -> Proxy * Text -> Int

FromBackendRow Sqlite UTCTime

Methods

fromBackendRow :: FromBackendRowM Sqlite UTCTime

valuesNeeded :: Proxy * Sqlite -> Proxy * UTCTime -> Int

FromBackendRow Sqlite Text

Methods

fromBackendRow :: FromBackendRowM Sqlite Text

valuesNeeded :: Proxy * Sqlite -> Proxy * Text -> Int

FromBackendRow Sqlite SqlNull

Methods

fromBackendRow :: FromBackendRowM Sqlite SqlNull

valuesNeeded :: Proxy * Sqlite -> Proxy * SqlNull -> Int

FromBackendRow Sqlite Null

Methods

fromBackendRow :: FromBackendRowM Sqlite Null

valuesNeeded :: Proxy * Sqlite -> Proxy * Null -> Int

FromBackendRow Sqlite LocalTime

Methods

fromBackendRow :: FromBackendRowM Sqlite LocalTime

valuesNeeded :: Proxy * Sqlite -> Proxy * LocalTime -> Int

FromBackendRow Sqlite Day

Methods

fromBackendRow :: FromBackendRowM Sqlite Day

valuesNeeded :: Proxy * Sqlite -> Proxy * Day -> Int

MonadBeamInsertReturning SqliteCommandSyntax Sqlite Connection SqliteM

Methods

runInsertReturningList :: (Beamable table, Projectible (Sql92ExpressionSyntax SqliteCommandSyntax) (table (QExpr (Sql92ExpressionSyntax SqliteCommandSyntax) ())), FromBackendRow Sqlite (table Identity)) => DatabaseEntity Sqlite db (TableEntity table) -> SqlInsertValues (Sql92InsertValuesSyntax (Sql92InsertSyntax SqliteCommandSyntax)) (table (QExpr (Sql92InsertExpressionSyntax (Sql92InsertSyntax SqliteCommandSyntax)) s)) -> SqliteM [table Identity]

MonadBeam SqliteCommandSyntax Sqlite Connection SqliteM

Methods

withDatabaseDebug :: (String -> IO ()) -> Connection -> SqliteM a -> IO a

withDatabase :: Connection -> SqliteM a -> IO a

runReturningMany :: FromBackendRow Sqlite x => SqliteCommandSyntax -> (SqliteM (Maybe x) -> SqliteM a) -> SqliteM a

runNoReturn :: SqliteCommandSyntax -> SqliteM ()

runReturningOne :: FromBackendRow Sqlite x => SqliteCommandSyntax -> SqliteM (Maybe x)

runReturningList :: FromBackendRow Sqlite x => SqliteCommandSyntax -> SqliteM [x]

type BackendFromField Sqlite

type BackendFromField Sqlite = FromField

newtype SqliteM a

MonadBeam instance inside whiche SQLite queries are run. See the user guide for more information

Constructors

SqliteM

Fields

• runSqliteM :: ReaderT (String -> IO (), Connection) IO a

  Run an IO action with access to a SQLite connection and a debug logging function, called or each query submitted on the connection.

Instances

Monad SqliteM

Methods

(>>=) :: SqliteM a -> (a -> SqliteM b) -> SqliteM b

(>>) :: SqliteM a -> SqliteM b -> SqliteM b

return :: a -> SqliteM a

fail :: String -> SqliteM a

Functor SqliteM

Methods

fmap :: (a -> b) -> SqliteM a -> SqliteM b

(<$) :: a -> SqliteM b -> SqliteM a

Applicative SqliteM

Methods

pure :: a -> SqliteM a

(<*>) :: SqliteM (a -> b) -> SqliteM a -> SqliteM b

liftA2 :: (a -> b -> c) -> SqliteM a -> SqliteM b -> SqliteM c

(*>) :: SqliteM a -> SqliteM b -> SqliteM b

(<*) :: SqliteM a -> SqliteM b -> SqliteM a

MonadIO SqliteM

Methods

liftIO :: IO a -> SqliteM a

MonadBeamInsertReturning SqliteCommandSyntax Sqlite Connection SqliteM

Methods

runInsertReturningList :: (Beamable table, Projectible (Sql92ExpressionSyntax SqliteCommandSyntax) (table (QExpr (Sql92ExpressionSyntax SqliteCommandSyntax) ())), FromBackendRow Sqlite (table Identity)) => DatabaseEntity Sqlite db (TableEntity table) -> SqlInsertValues (Sql92InsertValuesSyntax (Sql92InsertSyntax SqliteCommandSyntax)) (table (QExpr (Sql92InsertExpressionSyntax (Sql92InsertSyntax SqliteCommandSyntax)) s)) -> SqliteM [table Identity]

MonadBeam SqliteCommandSyntax Sqlite Connection SqliteM

Methods

withDatabaseDebug :: (String -> IO ()) -> Connection -> SqliteM a -> IO a

withDatabase :: Connection -> SqliteM a -> IO a

runReturningMany :: FromBackendRow Sqlite x => SqliteCommandSyntax -> (SqliteM (Maybe x) -> SqliteM a) -> SqliteM a

runNoReturn :: SqliteCommandSyntax -> SqliteM ()

runReturningOne :: FromBackendRow Sqlite x => SqliteCommandSyntax -> SqliteM (Maybe x)

runReturningList :: FromBackendRow Sqlite x => SqliteCommandSyntax -> SqliteM [x]

sqliteUriSyntax :: c SqliteCommandSyntax Sqlite Connection SqliteM -> BeamURIOpeners c

URI syntax for use with withDbConnection. See documentation for BeamURIOpeners for more information.

runBeamSqlite :: Connection -> SqliteM a -> IO a

runBeamSqliteDebug :: (String -> IO ()) -> Connection -> SqliteM a -> IO a

Emulated INSERT RETURNING support

data SqliteInsertReturning (table :: (* -> *) -> *)

Represents an INSERT statement, from which we can retrieve inserted rows. Beam also offers a backend-agnostic way of using this functionality in the MonadBeamInsertReturning extension. This functionality is emulated in SQLite using a temporary table and a trigger.

insertReturning :: DatabaseEntity be db (TableEntity table) -> SqlInsertValues SqliteInsertValuesSyntax (table (QExpr SqliteExpressionSyntax s)) -> SqliteInsertReturning table

Build a SqliteInsertReturning representing inserting the given values into the given table. Use runInsertReturningList

runInsertReturningList :: FromBackendRow Sqlite (table Identity) => SqliteInsertReturning table -> SqliteM [table Identity]

Runs a SqliteInsertReturning statement and returns a result for each inserted row.