Database.GP.Entity

Documentation

class (Generic a, HasConstructor (Rep a), HasSelectors (Rep a)) => Entity a where

Minimal complete definition

Nothing

Methods

fromRow :: Conn -> [SqlValue] -> IO a

Converts a database row to a value of type a.

default fromRow :: GFromRow (Rep a) => Conn -> [SqlValue] -> IO a

toRow :: Conn -> a -> IO [SqlValue]

Converts a value of type a to a database row.

default toRow :: GToRow (Rep a) => Conn -> a -> IO [SqlValue]

idField :: String

Returns the name of the primary key field for a type a.

default idField :: String

fieldsToColumns :: [(String, String)]

Returns a list of tuples that map field names to column names for a type a.

default fieldsToColumns :: [(String, String)]

tableName :: String

Returns the name of the table for a type a.

default tableName :: String

columnNameFor :: forall a. Entity a => String -> String

A convenience function: returns the name of the column for a field of a type a.

toString :: forall a. (Generic a, GShow' (Rep a)) => a -> String

Returns a string representation of a value of type a.

type EntityId = (String, SqlValue)

The EntityId is a tuple of the constructor name and the primary key value of an Entity.

gtoRow :: GToRow f => f a -> [SqlValue]

class GToRow f

Minimal complete definition

gtoRow

Instances

GToRow (U1 :: k -> Type)

Defined in Database.GP.Entity

Methods

gtoRow :: forall (a :: k0). U1 a -> [SqlValue]

(GToRow a, GToRow b) => GToRow (a :*: b :: k -> Type)

Defined in Database.GP.Entity

Methods

gtoRow :: forall (a0 :: k0). (a :*: b) a0 -> [SqlValue]

Convertible a SqlValue => GToRow (K1 i a :: k -> Type)

Defined in Database.GP.Entity

Methods

gtoRow :: forall (a0 :: k0). K1 i a a0 -> [SqlValue]

GToRow a => GToRow (M1 i c a :: k -> Type)

Defined in Database.GP.Entity

Methods

gtoRow :: forall (a0 :: k0). M1 i c a a0 -> [SqlValue]

class GFromRow f

Minimal complete definition

gfromRow

Instances

GFromRow (U1 :: k -> Type)

Defined in Database.GP.Entity

Methods

gfromRow :: forall (a :: k0). [SqlValue] -> U1 a

(KnownNat (NumFields f), GFromRow f, GFromRow g) => GFromRow (f :*: g :: Type -> Type)

This instance is the most interesting one. It splits the list of SqlValues into two parts, one for the first field and one for the rest. Then it uses the GFromRow instance for the first field to convert the first part of the list and the GFromRow instance for the rest of the fields to convert the second part of the list. Finally, it combines the two results using the :*: constructor. https://stackoverflow.com/questions/75485429/how-to-use-ghc-generics-to-convert-from-product-data-types-to-a-list-of-sqlvalue/75485650#75485650

Defined in Database.GP.Entity

Methods

gfromRow :: forall (a :: k). [SqlValue] -> (f :*: g) a

Convertible SqlValue a => GFromRow (K1 i a :: k -> Type)

Defined in Database.GP.Entity

Methods

gfromRow :: forall (a0 :: k0). [SqlValue] -> K1 i a a0

GFromRow a => GFromRow (M1 i c a :: k -> Type)

Defined in Database.GP.Entity

Methods

gfromRow :: forall (a0 :: k0). [SqlValue] -> M1 i c a a0

maybeFieldTypeFor :: forall a. Entity a => String -> Maybe TypeRep

data Conn

A wrapper around an HDBC IConnection.

Constructors

forall conn.IConnection conn => Conn

Fields

• db :: Database

  The database type

• implicitCommit :: Bool

  If True, the GenericPersistence functions will commit the transaction after each operation.

• connection :: conn

  The wrapped connection

Instances

IConnection Conn

manually implement the IConnection type class for the Conn type.

Defined in Database.GP.Conn

Methods

disconnect :: Conn -> IO ()

commit :: Conn -> IO ()

rollback :: Conn -> IO ()

runRaw :: Conn -> String -> IO ()

run :: Conn -> String -> [SqlValue] -> IO Integer

prepare :: Conn -> String -> IO Statement

clone :: Conn -> IO Conn

hdbcDriverName :: Conn -> String

hdbcClientVer :: Conn -> String

proxiedClientName :: Conn -> String

proxiedClientVer :: Conn -> String

dbServerVer :: Conn -> String

dbTransactionSupport :: Conn -> Bool

getTables :: Conn -> IO [String]

describeTable :: Conn -> String -> IO [(String, SqlColDesc)]

data Database

An enumeration of the supported database types.

Constructors

Postgres

MySQL

SQLite

Oracle

MSSQL

Instances

Enum Database

Defined in Database.GP.Conn

Methods

succ :: Database -> Database

pred :: Database -> Database

toEnum :: Int -> Database

fromEnum :: Database -> Int

enumFrom :: Database -> [Database]

enumFromThen :: Database -> Database -> [Database]

enumFromTo :: Database -> Database -> [Database]

enumFromThenTo :: Database -> Database -> Database -> [Database]

Show Database

Defined in Database.GP.Conn

Methods

showsPrec :: Int -> Database -> ShowS

show :: Database -> String

showList :: [Database] -> ShowS

Eq Database

Defined in Database.GP.Conn

Methods

(==) :: Database -> Database -> Bool

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