Safe Haskell	None
Language	Haskell2010

Database.Schema

Contents

Synopsis
Database columns
Database rows and tables
SQL Queries
Testing

Synopsis

class PersistField a => IsCol a where
- getSqlType :: Proxy a -> SqlColType
newtype SqlColType = SqlColType Text
toColType :: SqlType -> SqlColType
newtype Primary = Primary {
- getPrimary :: Int
}
data Table (name :: Symbol ) = Table
newtype Col (name :: Symbol ) a = Col a
data a :. b = a :. b
class IsRow row where
- getTableName :: Proxy row -> Text
- getColNames :: Proxy row -> [ Text ]
- getSqlTypes :: Proxy row -> [ SqlColType ]
- toSqlValues :: row -> [ PersistValue ]
- fromSqlValues :: [ PersistValue ] -> Either Text row
data Query row
callSql :: ( MonadIO m, IsRow row) => Query row -> SqlPersistT m [row]
runSql :: MonadIO m => Query () -> SqlPersistT m ()
createTable :: IsRow row => Proxy row -> Query ()
selectAll :: forall row. IsRow row => Query row
insertOne :: forall row. IsRow row => row -> Query ()
repsertOne :: forall row. IsRow row => (row :. Col "id" Primary ) -> Query ()
updateOne :: forall row. IsRow row => (row :. Col "id" Primary ) -> Query ()
deleteAll :: forall row. IsRow row => Proxy row -> Query ()
deleteOne :: forall row. IsRow row => Proxy row -> Col "id" Primary -> Query ()
testPerson :: PersonRow

Synopsis

Typed database tables and rows.

Database columns

class PersistField a => IsCol a where Source #

Class of columns that can be stored in database tables.

Methods

getSqlType :: Proxy a -> SqlColType Source #

Instances

Instances details

IsCol Int Source #
Instance details Defined in Database.Schema Methods getSqlType :: Proxy Int -> SqlColType Source #
( PersistField a, PersistFieldSql a) => IsCol a Source #
Instance details Defined in Database.Schema Methods getSqlType :: Proxy a -> SqlColType Source #
IsCol Primary Source #
Instance details Defined in Database.Schema Methods getSqlType :: Proxy Primary -> SqlColType Source #
IsCol ( Maybe Int ) Source #
Instance details Defined in Database.Schema Methods getSqlType :: Proxy ( Maybe Int ) -> SqlColType Source #

newtype SqlColType Source #

SQL column types, including constraints. Values of type SqlColType represent SQL types such as

INTEGER  PRIMARY KEY NOT NULL
TEXT  NOT NULL

Constructors

SqlColType Text

Instances

Instances details

Eq SqlColType Source #
Instance details Defined in Database.Schema Methods (==) :: SqlColType -> SqlColType -> Bool Source # (/=) :: SqlColType -> SqlColType -> Bool Source #
Ord SqlColType Source #
Instance details Defined in Database.Schema Methods compare :: SqlColType -> SqlColType -> Ordering Source # (<) :: SqlColType -> SqlColType -> Bool Source # (<=) :: SqlColType -> SqlColType -> Bool Source # (>) :: SqlColType -> SqlColType -> Bool Source # (>=) :: SqlColType -> SqlColType -> Bool Source # max :: SqlColType -> SqlColType -> SqlColType Source # min :: SqlColType -> SqlColType -> SqlColType Source #
Show SqlColType Source #
Instance details Defined in Database.Schema Methods showsPrec :: Int -> SqlColType -> ShowS Source # show :: SqlColType -> String Source # showList :: [ SqlColType ] -> ShowS Source #

toColType :: SqlType -> SqlColType Source #

Helper for converting SqlType into an SQL column type with constraints.

newtype Primary Source #

Primary key.

Constructors

Primary
Fields getPrimary :: Int

Instances

Instances details

Eq Primary Source #
Instance details Defined in Database.Schema Methods (==) :: Primary -> Primary -> Bool Source # (/=) :: Primary -> Primary -> Bool Source #
Ord Primary Source #
Instance details Defined in Database.Schema Methods compare :: Primary -> Primary -> Ordering Source # (<) :: Primary -> Primary -> Bool Source # (<=) :: Primary -> Primary -> Bool Source # (>) :: Primary -> Primary -> Bool Source # (>=) :: Primary -> Primary -> Bool Source # max :: Primary -> Primary -> Primary Source # min :: Primary -> Primary -> Primary Source #
Show Primary Source #
Instance details Defined in Database.Schema Methods showsPrec :: Int -> Primary -> ShowS Source # show :: Primary -> String Source # showList :: [ Primary ] -> ShowS Source #
PersistField Primary Source #
Instance details Defined in Database.Schema Methods toPersistValue :: Primary -> PersistValue Source # fromPersistValue :: PersistValue -> Either Text Primary Source #
IsCol Primary Source #
Instance details Defined in Database.Schema Methods getSqlType :: Proxy Primary -> SqlColType Source #

Database rows and tables

data Table (name :: Symbol ) Source #

Named database table.

Constructors

Table

Instances

Instances details

Eq ( Table name) Source #
Instance details Defined in Database.Schema Methods (==) :: Table name -> Table name -> Bool Source # (/=) :: Table name -> Table name -> Bool Source #
Ord ( Table name) Source #
Instance details Defined in Database.Schema Methods compare :: Table name -> Table name -> Ordering Source # (<) :: Table name -> Table name -> Bool Source # (<=) :: Table name -> Table name -> Bool Source # (>) :: Table name -> Table name -> Bool Source # (>=) :: Table name -> Table name -> Bool Source # max :: Table name -> Table name -> Table name Source # min :: Table name -> Table name -> Table name Source #
Show ( Table name) Source #
Instance details Defined in Database.Schema Methods showsPrec :: Int -> Table name -> ShowS Source # show :: Table name -> String Source # showList :: [ Table name] -> ShowS Source #
KnownSymbol name => IsRow ( Table name) Source #
Instance details Defined in Database.Schema Methods getTableName :: Proxy ( Table name) -> Text Source # getColNames :: Proxy ( Table name) -> [ Text ] Source # getSqlTypes :: Proxy ( Table name) -> [ SqlColType ] Source # toSqlValues :: Table name -> [ PersistValue ] Source # fromSqlValues :: [ PersistValue ] -> Either Text ( Table name) Source #

newtype Col (name :: Symbol ) a Source #

Named database column.

Constructors

Col a

Instances

Instances details

Eq a => Eq ( Col name a) Source #
Instance details Defined in Database.Schema Methods (==) :: Col name a -> Col name a -> Bool Source # (/=) :: Col name a -> Col name a -> Bool Source #
Ord a => Ord ( Col name a) Source #
Instance details Defined in Database.Schema Methods compare :: Col name a -> Col name a -> Ordering Source # (<) :: Col name a -> Col name a -> Bool Source # (<=) :: Col name a -> Col name a -> Bool Source # (>) :: Col name a -> Col name a -> Bool Source # (>=) :: Col name a -> Col name a -> Bool Source # max :: Col name a -> Col name a -> Col name a Source # min :: Col name a -> Col name a -> Col name a Source #
Show a => Show ( Col name a) Source #
Instance details Defined in Database.Schema Methods showsPrec :: Int -> Col name a -> ShowS Source # show :: Col name a -> String Source # showList :: [ Col name a] -> ShowS Source #
( IsRow row, KnownSymbol name, IsCol a) => IsRow (row :. Col name a) Source #
Instance details Defined in Database.Schema Methods getTableName :: Proxy (row :. Col name a) -> Text Source # getColNames :: Proxy (row :. Col name a) -> [ Text ] Source # getSqlTypes :: Proxy (row :. Col name a) -> [ SqlColType ] Source # toSqlValues :: (row :. Col name a) -> [ PersistValue ] Source # fromSqlValues :: [ PersistValue ] -> Either Text (row :. Col name a) Source #

data a :. b infixl 3 Source #

Infix notation for a pair of types.

Constructors

a :. b infixl 3

Instances

Instances details

( Eq a, Eq b) => Eq (a :. b) Source #
Instance details Defined in Database.Schema Methods (==) :: (a :. b) -> (a :. b) -> Bool Source # (/=) :: (a :. b) -> (a :. b) -> Bool Source #
( Ord a, Ord b) => Ord (a :. b) Source #
Instance details Defined in Database.Schema Methods compare :: (a :. b) -> (a :. b) -> Ordering Source # (<) :: (a :. b) -> (a :. b) -> Bool Source # (<=) :: (a :. b) -> (a :. b) -> Bool Source # (>) :: (a :. b) -> (a :. b) -> Bool Source # (>=) :: (a :. b) -> (a :. b) -> Bool Source # max :: (a :. b) -> (a :. b) -> a :. b Source # min :: (a :. b) -> (a :. b) -> a :. b Source #
( Read a, Read b) => Read (a :. b) Source #
Instance details Defined in Database.Schema Methods readsPrec :: Int -> ReadS (a :. b) Source # readList :: ReadS [a :. b] Source # readPrec :: ReadPrec (a :. b) Source # readListPrec :: ReadPrec [a :. b] Source #
( Show a, Show b) => Show (a :. b) Source #
Instance details Defined in Database.Schema Methods showsPrec :: Int -> (a :. b) -> ShowS Source # show :: (a :. b) -> String Source # showList :: [a :. b] -> ShowS Source #
( IsRow row, KnownSymbol name, IsCol a) => IsRow (row :. Col name a) Source #
Instance details Defined in Database.Schema Methods getTableName :: Proxy (row :. Col name a) -> Text Source # getColNames :: Proxy (row :. Col name a) -> [ Text ] Source # getSqlTypes :: Proxy (row :. Col name a) -> [ SqlColType ] Source # toSqlValues :: (row :. Col name a) -> [ PersistValue ] Source # fromSqlValues :: [ PersistValue ] -> Either Text (row :. Col name a) Source #

class IsRow row where Source #

Class of row types that can be stored in database tables. Instances of this class are essentially lists of columns. Example:

type PersonRow = Table "person" :. Col "name" Text :. Col "age" Int

Methods

getTableName :: Proxy row -> Text Source #

getColNames :: Proxy row -> [ Text ] Source #

getSqlTypes :: Proxy row -> [ SqlColType ] Source #

toSqlValues :: row -> [ PersistValue ] Source #

fromSqlValues :: [ PersistValue ] -> Either Text row Source #

Instances

Instances details

KnownSymbol name => IsRow ( Table name) Source #
Instance details Defined in Database.Schema Methods getTableName :: Proxy ( Table name) -> Text Source # getColNames :: Proxy ( Table name) -> [ Text ] Source # getSqlTypes :: Proxy ( Table name) -> [ SqlColType ] Source # toSqlValues :: Table name -> [ PersistValue ] Source # fromSqlValues :: [ PersistValue ] -> Either Text ( Table name) Source #
( IsRow row, KnownSymbol name, IsCol a) => IsRow (row :. Col name a) Source #
Instance details Defined in Database.Schema Methods getTableName :: Proxy (row :. Col name a) -> Text Source # getColNames :: Proxy (row :. Col name a) -> [ Text ] Source # getSqlTypes :: Proxy (row :. Col name a) -> [ SqlColType ] Source # toSqlValues :: (row :. Col name a) -> [ PersistValue ] Source # fromSqlValues :: [ PersistValue ] -> Either Text (row :. Col name a) Source #

SQL Queries

data Query row Source #

An SQL query that returns a list of values of type row .

Instances

Instances details

Eq ( Query row) Source #
Instance details Defined in Database.Schema Methods (==) :: Query row -> Query row -> Bool Source # (/=) :: Query row -> Query row -> Bool Source #
Show ( Query row) Source #
Instance details Defined in Database.Schema Methods showsPrec :: Int -> Query row -> ShowS Source # show :: Query row -> String Source # showList :: [ Query row] -> ShowS Source #

callSql :: ( MonadIO m, IsRow row) => Query row -> SqlPersistT m [row] Source #

Run an SQL query and return a list of rows as result.

runSql :: MonadIO m => Query () -> SqlPersistT m () Source #

Execute an SQL query, but do not return any results

createTable :: IsRow row => Proxy row -> Query () Source #

Create a database table that can store the given rows.

selectAll :: forall row. IsRow row => Query row Source #

Select all rows from the table.

insertOne :: forall row. IsRow row => row -> Query () Source #

Insert a single row into the corresponding table.

repsertOne :: forall row. IsRow row => (row :. Col "id" Primary ) -> Query () Source #

Replace or insert a single row with a primary key into a database.

FIXME: It would be nicer if the "id" column was the first column instead of the last column in the table.

updateOne :: forall row. IsRow row => (row :. Col "id" Primary ) -> Query () Source #

Update one row with a given "id" column in a database table.

deleteAll :: forall row. IsRow row => Proxy row -> Query () Source #

Delete all rows in a database table

deleteOne :: forall row. IsRow row => Proxy row -> Col "id" Primary -> Query () Source #

Delete one row with a given "id" column in a database table.

Testing

testPerson :: PersonRow Source #