Safe Haskell	Safe-Inferred
Language	GHC2021

Database.GP.SqlGenerator

Synopsis

insertStmtFor :: forall a. Entity a => String
insertReturningStmtFor :: forall a. Entity a => String
updateStmtFor :: forall a. Entity a => String
selectFromStmt :: forall a. Entity a => WhereClauseExpr -> String
deleteStmtFor :: forall a. Entity a => String
createTableStmtFor :: forall a. Entity a => Database -> String
dropTableStmtFor :: forall a. Entity a => String
columnTypeFor :: forall a. Entity a => Database -> String -> String
data WhereClauseExpr
data Field
field :: String -> Field
whereClauseValues :: WhereClauseExpr -> [SqlValue]
(&&.) :: WhereClauseExpr -> WhereClauseExpr -> WhereClauseExpr
(||.) :: WhereClauseExpr -> WhereClauseExpr -> WhereClauseExpr
(=.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr
(>.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr
(<.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr
(>=.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr
(<=.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr
(<>.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr
like :: Convertible b SqlValue => Field -> b -> WhereClauseExpr
between :: (Convertible a1 SqlValue, Convertible a2 SqlValue) => Field -> (a1, a2) -> WhereClauseExpr
in' :: Convertible b SqlValue => Field -> [b] -> WhereClauseExpr
isNull :: Field -> WhereClauseExpr
not' :: WhereClauseExpr -> WhereClauseExpr
sqlFun :: String -> Field -> Field
allEntries :: WhereClauseExpr
byId :: Convertible a SqlValue => a -> WhereClauseExpr
byIdColumn :: WhereClauseExpr
orderBy :: WhereClauseExpr -> NonEmpty (Field, SortOrder) -> WhereClauseExpr
data SortOrder
- = ASC
- | DESC
limit :: WhereClauseExpr -> Int -> WhereClauseExpr
limitOffset :: WhereClauseExpr -> (Int, Int) -> WhereClauseExpr
data NonEmpty a = a :| [a]
data Database
- = Postgres
- | SQLite

Documentation

insertStmtFor :: forall a. Entity a => String Source #

This module defines some basic SQL statements for Record Data Types that are instances of Entity. The SQL statements are generated using Haskell generics to provide compile time reflection capabilities.

A function that returns an SQL insert statement for an entity. Type a must be an instance of Data. The function will use the field names of the data type to generate the column names in the insert statement. The values of the fields will be used as the values in the insert statement. Output example: INSERT INTO Person (id, name, age, address) VALUES (123456, Alice, 25, "123 Main St");

insertReturningStmtFor :: forall a. Entity a => String Source #

updateStmtFor :: forall a. Entity a => String Source #

A function that returns an SQL update statement for an entity. Type a must be an instance of Entity.

selectFromStmt :: forall a. Entity a => WhereClauseExpr -> String Source #

A function that returns an SQL select statement for an entity. Type a must be an instance of Entity. The function takes a where clause expression as parameter. This expression is used to filter the result set.

deleteStmtFor :: forall a. Entity a => String Source #

createTableStmtFor :: forall a. Entity a => Database -> String Source #

dropTableStmtFor :: forall a. Entity a => String Source #

columnTypeFor :: forall a. Entity a => Database -> String -> String Source #

A function that returns the column type for a field of an entity. TODO: Support other databases than just SQLite and Postgres.

data WhereClauseExpr Source #

data Field Source #

field :: String -> Field Source #

whereClauseValues :: WhereClauseExpr -> [SqlValue] Source #

(&&.) :: WhereClauseExpr -> WhereClauseExpr -> WhereClauseExpr infixl 3 Source #

(||.) :: WhereClauseExpr -> WhereClauseExpr -> WhereClauseExpr infixl 2 Source #

(=.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr infixl 4 Source #

(>.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr infixl 4 Source #

(<.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr infixl 4 Source #

(>=.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr infixl 4 Source #

(<=.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr infixl 4 Source #

(<>.) :: Convertible b SqlValue => Field -> b -> WhereClauseExpr infixl 4 Source #

like :: Convertible b SqlValue => Field -> b -> WhereClauseExpr infixl 4 Source #

between :: (Convertible a1 SqlValue, Convertible a2 SqlValue) => Field -> (a1, a2) -> WhereClauseExpr infixl 4 Source #

in' :: Convertible b SqlValue => Field -> [b] -> WhereClauseExpr infixl 4 Source #

isNull :: Field -> WhereClauseExpr Source #

not' :: WhereClauseExpr -> WhereClauseExpr Source #

sqlFun :: String -> Field -> Field Source #

allEntries :: WhereClauseExpr Source #

byId :: Convertible a SqlValue => a -> WhereClauseExpr Source #

byIdColumn :: WhereClauseExpr Source #

orderBy :: WhereClauseExpr -> NonEmpty (Field, SortOrder) -> WhereClauseExpr infixl 1 Source #

data SortOrder Source #

Constructors

ASC
DESC

Instances

Instances details

Show SortOrder Source #
Instance details Defined in Database.GP.Query Methods showsPrec :: Int -> SortOrder -> ShowS # show :: SortOrder -> String # showList :: [SortOrder] -> ShowS #

limit :: WhereClauseExpr -> Int -> WhereClauseExpr Source #

limitOffset :: WhereClauseExpr -> (Int, Int) -> WhereClauseExpr Source #

data NonEmpty a #

Non-empty (and non-strict) list type.

Since: base-4.9.0.0

Constructors

a :| [a] infixr 5

Instances

Instances details

Foldable NonEmpty	Since: base-4.9.0.0
Instance details Defined in Data.Foldable Methods fold :: Monoid m => NonEmpty m -> m # foldMap :: Monoid m => (a -> m) -> NonEmpty a -> m # foldMap' :: Monoid m => (a -> m) -> NonEmpty a -> m # foldr :: (a -> b -> b) -> b -> NonEmpty a -> b # foldr' :: (a -> b -> b) -> b -> NonEmpty a -> b # foldl :: (b -> a -> b) -> b -> NonEmpty a -> b # foldl' :: (b -> a -> b) -> b -> NonEmpty a -> b # foldr1 :: (a -> a -> a) -> NonEmpty a -> a # foldl1 :: (a -> a -> a) -> NonEmpty a -> a # toList :: NonEmpty a -> [a] # null :: NonEmpty a -> Bool # length :: NonEmpty a -> Int # elem :: Eq a => a -> NonEmpty a -> Bool # maximum :: Ord a => NonEmpty a -> a # minimum :: Ord a => NonEmpty a -> a # sum :: Num a => NonEmpty a -> a # product :: Num a => NonEmpty a -> a #
Traversable NonEmpty	Since: base-4.9.0.0
Instance details Defined in Data.Traversable Methods traverse :: Applicative f => (a -> f b) -> NonEmpty a -> f (NonEmpty b) # sequenceA :: Applicative f => NonEmpty (f a) -> f (NonEmpty a) # mapM :: Monad m => (a -> m b) -> NonEmpty a -> m (NonEmpty b) # sequence :: Monad m => NonEmpty (m a) -> m (NonEmpty a) #
Applicative NonEmpty	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods pure :: a -> NonEmpty a # (<>) :: NonEmpty (a -> b) -> NonEmpty a -> NonEmpty b # liftA2 :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c # (>) :: NonEmpty a -> NonEmpty b -> NonEmpty b # (<*) :: NonEmpty a -> NonEmpty b -> NonEmpty a #
Functor NonEmpty	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods fmap :: (a -> b) -> NonEmpty a -> NonEmpty b # (<$) :: a -> NonEmpty b -> NonEmpty a #
Monad NonEmpty	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods (>>=) :: NonEmpty a -> (a -> NonEmpty b) -> NonEmpty b # (>>) :: NonEmpty a -> NonEmpty b -> NonEmpty b # return :: a -> NonEmpty a #
Hashable1 NonEmpty	Since: hashable-1.3.1.0
Instance details Defined in Data.Hashable.Class Methods liftHashWithSalt :: (Int -> a -> Int) -> Int -> NonEmpty a -> Int #
Generic1 NonEmpty
Instance details Defined in GHC.Generics Associated Types type Rep1 NonEmpty :: k -> Type # Methods from1 :: forall (a :: k). NonEmpty a -> Rep1 NonEmpty a # to1 :: forall (a :: k). Rep1 NonEmpty a -> NonEmpty a #
Semigroup (NonEmpty a)	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods (<>) :: NonEmpty a -> NonEmpty a -> NonEmpty a # sconcat :: NonEmpty (NonEmpty a) -> NonEmpty a # stimes :: Integral b => b -> NonEmpty a -> NonEmpty a #
IsList (NonEmpty a)	Since: base-4.9.0.0
Instance details Defined in GHC.Exts Associated Types type Item (NonEmpty a) # Methods fromList :: [Item (NonEmpty a)] -> NonEmpty a # fromListN :: Int -> [Item (NonEmpty a)] -> NonEmpty a # toList :: NonEmpty a -> [Item (NonEmpty a)] #
Generic (NonEmpty a)
Instance details Defined in GHC.Generics Associated Types type Rep (NonEmpty a) :: Type -> Type # Methods from :: NonEmpty a -> Rep (NonEmpty a) x # to :: Rep (NonEmpty a) x -> NonEmpty a #
Read a => Read (NonEmpty a)	Since: base-4.11.0.0
Instance details Defined in GHC.Read Methods readsPrec :: Int -> ReadS (NonEmpty a) # readList :: ReadS [NonEmpty a] # readPrec :: ReadPrec (NonEmpty a) # readListPrec :: ReadPrec [NonEmpty a] #
Show a => Show (NonEmpty a)	Since: base-4.11.0.0
Instance details Defined in GHC.Show Methods showsPrec :: Int -> NonEmpty a -> ShowS # show :: NonEmpty a -> String # showList :: [NonEmpty a] -> ShowS #
Eq a => Eq (NonEmpty a)	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods (==) :: NonEmpty a -> NonEmpty a -> Bool # (/=) :: NonEmpty a -> NonEmpty a -> Bool #
Ord a => Ord (NonEmpty a)	Since: base-4.9.0.0
Instance details Defined in GHC.Base Methods compare :: NonEmpty a -> NonEmpty a -> Ordering # (<) :: NonEmpty a -> NonEmpty a -> Bool # (<=) :: NonEmpty a -> NonEmpty a -> Bool # (>) :: NonEmpty a -> NonEmpty a -> Bool # (>=) :: NonEmpty a -> NonEmpty a -> Bool # max :: NonEmpty a -> NonEmpty a -> NonEmpty a # min :: NonEmpty a -> NonEmpty a -> NonEmpty a #
Hashable a => Hashable (NonEmpty a)
Instance details Defined in Data.Hashable.Class Methods hashWithSalt :: Int -> NonEmpty a -> Int # hash :: NonEmpty a -> Int #
type Rep1 NonEmpty	Since: base-4.6.0.0
Instance details Defined in GHC.Generics type Rep1 NonEmpty = D1 ('MetaData "NonEmpty" "GHC.Base" "base" 'False) (C1 ('MetaCons ":\|" ('InfixI 'LeftAssociative 9) 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) Par1 :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec1 [])))
type Item (NonEmpty a)
Instance details Defined in GHC.Exts type Item (NonEmpty a) = a
type Rep (NonEmpty a)	Since: base-4.6.0.0
Instance details Defined in GHC.Generics type Rep (NonEmpty a) = D1 ('MetaData "NonEmpty" "GHC.Base" "base" 'False) (C1 ('MetaCons ":\|" ('InfixI 'LeftAssociative 9) 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a])))

data Database Source #

An enumeration of the supported database types.

Constructors

Postgres
SQLite

Instances

Instances details

Show Database Source #	Oracle \| MSSQL \| MySQL
Instance details Defined in Database.GP.SqlGenerator Methods showsPrec :: Int -> Database -> ShowS # show :: Database -> String # showList :: [Database] -> ShowS #
Eq Database Source #
Instance details Defined in Database.GP.SqlGenerator Methods (==) :: Database -> Database -> Bool # (/=) :: Database -> Database -> Bool #