Database.MySQL.Hasqlator.Typed

Database Types

data Table (table :: Symbol) database

Constructors

Table (Maybe Text) Text

data Field (table :: Symbol) database (nullable :: Nullable) a

Constructors

Field Text Text

newtype Tbl table database (joinType :: JoinType)

An table alias that can be used inside the Query. The function inside the newtype can also be applied directly to create an expression from a field.

Constructors

Tbl

Fields

• getTableAlias :: forall fieldNull exprNull a. CheckExprNullable (JoinNullable joinType fieldNull) exprNull => Field table database fieldNull a -> Expression exprNull a

(@@) :: CheckExprNullable (JoinNullable joinType fieldNull) exprNull => Tbl table database (joinType :: JoinType) -> Field table database fieldNull a -> Expression exprNull a infixl 9

Create an expression from an aliased table and a field.

data Nullable

Constructors

Nullable

NotNull

Querying

data Query database a

Instances

Monad (Query database)

Defined in Database.MySQL.Hasqlator.Typed

Methods

(>>=) :: Query database a -> (a -> Query database b) -> Query database b

(>>) :: Query database a -> Query database b -> Query database b

return :: a -> Query database a

Functor (Query database)

Defined in Database.MySQL.Hasqlator.Typed

Methods

fmap :: (a -> b) -> Query database a -> Query database b

(<$) :: a -> Query database b -> Query database a

Applicative (Query database)

Defined in Database.MySQL.Hasqlator.Typed

Methods

pure :: a -> Query database a

(<*>) :: Query database (a -> b) -> Query database a -> Query database b

liftA2 :: (a -> b -> c) -> Query database a -> Query database b -> Query database c

(*>) :: Query database a -> Query database b -> Query database b

(<*) :: Query database a -> Query database b -> Query database a

ToQueryBuilder (Query database (Selector a))

Defined in Database.MySQL.Hasqlator.Typed

Methods

toQueryBuilder :: Query database (Selector a) -> QueryBuilder

Selectors

data Selector a

Selectors contain the target fields or expressions in a SQL SELECT statement, and perform the conversion to haskell. Selectors are instances of Applicative, so they can return the desired haskell type.

Instances

Functor Selector

Defined in Database.MySQL.Hasqlator

Methods

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

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

Applicative Selector

Defined in Database.MySQL.Hasqlator

Methods

pure :: a -> Selector a

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

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

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

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

FromSql a => IsString (Selector a)

Defined in Database.MySQL.Hasqlator

Methods

fromString :: String -> Selector a

Semigroup a => Semigroup (Selector a)

Defined in Database.MySQL.Hasqlator

Methods

(<>) :: Selector a -> Selector a -> Selector a

sconcat :: NonEmpty (Selector a) -> Selector a

stimes :: Integral b => b -> Selector a -> Selector a

Monoid a => Monoid (Selector a)

Defined in Database.MySQL.Hasqlator

Methods

mempty :: Selector a

mappend :: Selector a -> Selector a -> Selector a

mconcat :: [Selector a] -> Selector a

ToQueryBuilder (Query database (Selector a))

Defined in Database.MySQL.Hasqlator.Typed

Methods

toQueryBuilder :: Query database (Selector a) -> QueryBuilder

sel :: FromSql a => Expression 'NotNull a -> Selector a

make a selector from a column

selMaybe :: FromSql (Maybe a) => Expression 'Nullable a -> Selector (Maybe a)

make a selector from a column that can be null

Expressions

data Expression (nullable :: Nullable) a

Instances

(Fractional n, ToSql n) => Fractional (Expression nullable n)

Defined in Database.MySQL.Hasqlator.Typed

Methods

(/) :: Expression nullable n -> Expression nullable n -> Expression nullable n

recip :: Expression nullable n -> Expression nullable n

fromRational :: Rational -> Expression nullable n

(Num n, ToSql n) => Num (Expression nullable n)

Defined in Database.MySQL.Hasqlator.Typed

Methods

(+) :: Expression nullable n -> Expression nullable n -> Expression nullable n

(-) :: Expression nullable n -> Expression nullable n -> Expression nullable n

(*) :: Expression nullable n -> Expression nullable n -> Expression nullable n

negate :: Expression nullable n -> Expression nullable n

abs :: Expression nullable n -> Expression nullable n

signum :: Expression nullable n -> Expression nullable n

fromInteger :: Integer -> Expression nullable n

IsString (Expression nullable Text)

Defined in Database.MySQL.Hasqlator.Typed

Methods

fromString :: String -> Expression nullable Text

Semigroup (Expression nullable Text)

Defined in Database.MySQL.Hasqlator.Typed

Methods

(<>) :: Expression nullable Text -> Expression nullable Text -> Expression nullable Text

sconcat :: NonEmpty (Expression nullable Text) -> Expression nullable Text

stimes :: Integral b => b -> Expression nullable Text -> Expression nullable Text

Monoid (Expression nullable Text)

Defined in Database.MySQL.Hasqlator.Typed

Methods

mempty :: Expression nullable Text

mappend :: Expression nullable Text -> Expression nullable Text -> Expression nullable Text

mconcat :: [Expression nullable Text] -> Expression nullable Text

data SomeExpression

An expression of any type

someExpr :: Expression nullable a -> SomeExpression

Remove types of an expression

type Operator a b c = forall nullable. Expression nullable a -> Expression nullable b -> Expression nullable c

arg :: ToSql a => a -> Expression nullable a

pass an argument

argMaybe :: ToSql a => Maybe a -> Expression 'Nullable a

pass an argument which can be null

nullable :: Expression nullable a -> Expression 'Nullable a

make expression nullable

cast :: Castable a => Expression nullable b -> Expression nullable a

Safe cast. This uses the SQL CAST function to convert safely from one type to another.

unsafeCast :: Expression nullable a -> Expression nullable b

Cast the return type of an expression to any other type, without changing the query. Since this library adds static typing on top of SQL, you may sometimes want to use this to get back the lenient behaviour of SQL. This opens up more possibilies for runtime errors, so it's up to the programmer to ensure type correctness.

op :: (QueryBuilder -> QueryBuilder -> QueryBuilder) -> Operator a b c

create an operator

fun1 :: (QueryBuilder -> QueryBuilder) -> Expression nullable a -> Expression nullable b

fun2 :: (QueryBuilder -> QueryBuilder -> QueryBuilder) -> Expression nullable a -> Expression nullable b -> Expression nullable c

fun3 :: (QueryBuilder -> QueryBuilder -> QueryBuilder -> QueryBuilder) -> Expression nullable a -> Expression nullable b -> Expression nullable c -> Expression nullable d

(>.) :: ToSql a => Operator a a Bool

(<.) :: ToSql a => Operator a a Bool

(>=.) :: ToSql a => Operator a a Bool

(<=.) :: ToSql a => Operator a a Bool

(&&.) :: Operator Bool Bool Bool

(||.) :: Operator Bool Bool Bool

substr :: Expression nullable Text -> Expression nullable Int -> Expression nullable Int -> Expression nullable Text

true_ :: Expression nullable Bool

false_ :: Expression nullable Bool

Clauses

from :: Table table database -> Query database (Tbl table database 'InnerJoined)

fromSubQuery :: (Generic inExprs, Generic outExprs, SubQueryExpr 'LeftJoined (Rep inExprs ()) (Rep outExprs ())) => Query database inExprs -> Query database outExprs

innerJoin :: Table table database -> (Tbl table database 'InnerJoined -> Expression nullable Bool) -> Query database (Tbl table database 'InnerJoined)

leftJoin :: Table table database -> (Tbl table database 'LeftJoined -> Expression nullable Bool) -> Query database (Tbl table database 'LeftJoined)

joinSubQuery :: (Generic inExprs, Generic outExprs, SubQueryExpr 'InnerJoined (Rep inExprs ()) (Rep outExprs ())) => Query database inExprs -> (outExprs -> Expression nullable Bool) -> Query database outExprs

leftJoinSubQuery :: (Generic inExprs, Generic outExprs, SubQueryExpr 'LeftJoined (Rep inExprs ()) (Rep outExprs ())) => Query database inExprs -> (outExprs -> Expression nullable Bool) -> Query database outExprs

where_ :: Expression nullable Bool -> Query database ()

groupBy_ :: [SomeExpression] -> Query database ()

having :: Expression nullable Bool -> Query database ()

orderBy :: [QueryOrdering] -> Query database ()

limit :: Int -> Query database ()

limitOffset :: Int -> Int -> Query database ()

Insertion

data Insertor (table :: Symbol) database a

Instances

Contravariant (Insertor table database)

Defined in Database.MySQL.Hasqlator.Typed

Methods

contramap :: (a -> b) -> Insertor table database b -> Insertor table database a

(>$) :: b -> Insertor table database b -> Insertor table database a

Semigroup (Insertor table database a)

Defined in Database.MySQL.Hasqlator.Typed

Methods

(<>) :: Insertor table database a -> Insertor table database a -> Insertor table database a

sconcat :: NonEmpty (Insertor table database a) -> Insertor table database a

stimes :: Integral b => b -> Insertor table database a -> Insertor table database a

Monoid (Insertor table database a)

Defined in Database.MySQL.Hasqlator.Typed

Methods

mempty :: Insertor table database a

mappend :: Insertor table database a -> Insertor table database a -> Insertor table database a

mconcat :: [Insertor table database a] -> Insertor table database a

insertValues :: Table table database -> Insertor table database a -> [a] -> Command

insertSelect :: Table table database -> Query database [Into database table] -> Command

insertData :: (Generic a, Generic b, InsertGeneric tbl db (Rep a ()) (Rep b ())) => a -> Insertor tbl db b

skipInsert :: Insertor tbl db a

into :: Insertable fieldNull fieldType b => (a -> b) -> Field table database fieldNull fieldType -> Insertor table database a

lensInto :: Insertable fieldNull fieldType b => Getter a b -> Field table database fieldNull fieldType -> Insertor table database a

insertOne :: Insertable fieldNull fieldType a => Field table database fieldNull fieldType -> Insertor table database a

exprInto :: CheckExprNullable exprNullable fieldNullable => Expression exprNullable a -> Field table database fieldNullable a -> Into database table

data Into database (table :: Symbol)

imported from Database.MySQL.Hasqlator

type Getter s a = (a -> Const a a) -> s -> Const a s

A Getter type compatible with the lens library

class ToSql a

Minimal complete definition

toSqlValue

Instances

ToSql Bool

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Bool -> MySQLValue

ToSql Double

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Double -> MySQLValue

ToSql Float

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Float -> MySQLValue

ToSql Int

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Int -> MySQLValue

ToSql Int8

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Int8 -> MySQLValue

ToSql Int16

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Int16 -> MySQLValue

ToSql Int32

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Int32 -> MySQLValue

ToSql Int64

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Int64 -> MySQLValue

ToSql Integer

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Integer -> MySQLValue

ToSql Word8

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Word8 -> MySQLValue

ToSql Word16

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Word16 -> MySQLValue

ToSql Word32

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Word32 -> MySQLValue

ToSql Word64

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Word64 -> MySQLValue

ToSql ByteString

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: ByteString -> MySQLValue

ToSql Scientific

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Scientific -> MySQLValue

ToSql Text

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Text -> MySQLValue

ToSql Value

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Value -> MySQLValue

ToSql TimeOfDay

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: TimeOfDay -> MySQLValue

ToSql LocalTime

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: LocalTime -> MySQLValue

ToSql DiffTime

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: DiffTime -> MySQLValue

ToSql Day

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Day -> MySQLValue

ToSql a => ToSql (Maybe a)

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Maybe a -> MySQLValue

class FromSql a

Minimal complete definition

fromSql

Instances

FromSql Bool

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Bool

FromSql Double

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Double

FromSql Float

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Float

FromSql Int

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Int

FromSql Int8

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Int8

FromSql Int16

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Int16

FromSql Int32

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Int32

FromSql Int64

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Int64

FromSql Integer

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Integer

FromSql Word8

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Word8

FromSql Word16

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Word16

FromSql Word32

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Word32

FromSql Word64

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Word64

FromSql ByteString

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError ByteString

FromSql Scientific

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Scientific

FromSql Text

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Text

FromSql Value

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Value

FromSql TimeOfDay

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError TimeOfDay

FromSql LocalTime

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError LocalTime

FromSql DiffTime

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError DiffTime

FromSql Day

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Day

FromSql a => FromSql (Maybe a)

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError (Maybe a)

subQueryExpr :: Query database (Expression nullable a) -> Expression nullable a