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

AllFields

Field Text Text

newtype Alias 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. For constructing records, applicativeDo is the recommended way. However note that this may fail due to a bug in ghc, that breaks the polymorphism. In that case as a workaround you should use the Alias newtype directly and use the @@ operator to create an expression instead

Constructors

Alias

Fields

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

(@@) :: Alias table database (joinType :: JoinType) -> Field table database fieldNull a -> Expression (JoinNullable joinType fieldNull) a infixl 9

Create an expression from an aliased table and a field.

data Nullable

Constructors

Nullable

NotNull

data JoinType

Constructors

LeftJoined

InnerJoined

quotedTableName :: Table table database -> Text

quotedFieldName :: Field table database nullable a -> Text

Querying

data QueryClauses database a

Instances

Applicative (QueryClauses database)

Defined in Database.MySQL.Hasqlator.Typed

Methods

pure :: a -> QueryClauses database a

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

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

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

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

Functor (QueryClauses database)

Defined in Database.MySQL.Hasqlator.Typed

Methods

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

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

Monad (QueryClauses database)

Defined in Database.MySQL.Hasqlator.Typed

Methods

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

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

return :: a -> QueryClauses database a

data Query database a

mkQuery :: QueryClauses database a -> Query database a

untypeQuery :: Query database (Selector a) -> Query a

executeQuery :: MySQLConn -> Query database (Selector a) -> IO [a]

unionAll :: Query database a -> Query database a -> Query database a

unionDistinct :: Query database a -> Query database a -> Query database a

Selectors

data Selector a

Instances

Applicative Selector

Defined in Database.MySQL.Hasqlator.Typed

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

Functor Selector

Defined in Database.MySQL.Hasqlator.Typed

Methods

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

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

Monoid a => Monoid (Selector a)

Defined in Database.MySQL.Hasqlator.Typed

Methods

mempty :: Selector a

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

mconcat :: [Selector a] -> Selector a

Semigroup a => Semigroup (Selector a)

Defined in Database.MySQL.Hasqlator.Typed

Methods

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

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

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

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

forUpdate :: [Table table database] -> WaitLock -> QueryClauses database ()

forShare :: [Table table database] -> WaitLock -> QueryClauses database ()

shareMode :: QueryClauses database ()

Expressions

data Expression (nullable :: Nullable) a

Instances

IsString (Expression nullable Text)

Defined in Database.MySQL.Hasqlator.Typed

Methods

fromString :: String -> 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

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

(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

(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

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

isNull :: Expression nullable a -> Expression 'NotNull Bool

isNotNull :: Expression 'Nullable a -> Expression 'NotNull Bool

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

make expression nullable

notNull :: Expression 'NotNull a -> Expression 'NotNull a

ensure expression is not null

orNull :: Expression nullable a -> (Expression 'NotNull a -> Expression 'NotNull Bool) -> Expression 'NotNull Bool

Return a true expression if the given expression is NULL (using the IS NULL sql test), or pass the expression (coerced to 'NotNull) to the given test.

unlessNull :: Expression nullable a -> (Expression 'NotNull a -> Expression 'NotNull Bool) -> Expression 'NotNull Bool

Perform test if given expression is not NULL

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 infix 4

(/=.) :: ToSql a => Operator a a Bool infix 4

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

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

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

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

(&&.) :: Operator Bool Bool Bool infixr 3

(||.) :: Operator Bool Bool Bool infixr 3

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

true_ :: Expression nullable Bool

false_ :: Expression nullable Bool

in_ :: Expression nullable a -> [Expression nullable a] -> Expression nullable Bool

notIn_ :: Expression nullable a -> [Expression nullable a] -> Expression nullable Bool

and_ :: Foldable f => f (Expression nullable Bool) -> Expression nullable Bool

or_ :: Foldable f => f (Expression nullable Bool) -> Expression nullable Bool

newtype All_ nullable

Constructors

All_

Fields

• getAll_ :: Expression nullable Bool

Instances

Monoid (All_ nullable)

Defined in Database.MySQL.Hasqlator.Typed

Methods

mempty :: All_ nullable

mappend :: All_ nullable -> All_ nullable -> All_ nullable

mconcat :: [All_ nullable] -> All_ nullable

Semigroup (All_ nullable)

Defined in Database.MySQL.Hasqlator.Typed

Methods

(<>) :: All_ nullable -> All_ nullable -> All_ nullable

sconcat :: NonEmpty (All_ nullable) -> All_ nullable

stimes :: Integral b => b -> All_ nullable -> All_ nullable

newtype Any_ nullable

Constructors

Any_

Fields

• getAny_ :: Expression nullable Bool

Instances

Monoid (Any_ nullable)

Defined in Database.MySQL.Hasqlator.Typed

Methods

mempty :: Any_ nullable

mappend :: Any_ nullable -> Any_ nullable -> Any_ nullable

mconcat :: [Any_ nullable] -> Any_ nullable

Semigroup (Any_ nullable)

Defined in Database.MySQL.Hasqlator.Typed

Methods

(<>) :: Any_ nullable -> Any_ nullable -> Any_ nullable

sconcat :: NonEmpty (Any_ nullable) -> Any_ nullable

stimes :: Integral b => b -> Any_ nullable -> Any_ nullable

all_ :: Foldable f => (a -> Expression nullable Bool) -> f a -> Expression nullable Bool

any_ :: Foldable f => (a -> Expression nullable Bool) -> f a -> Expression nullable Bool

Clauses

from :: Table table database -> QueryClauses database (Alias table database 'InnerJoined)

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

innerJoin :: Table table database -> (Alias table database 'InnerJoined -> Expression nullable Bool) -> QueryClauses database (Alias table database 'InnerJoined)

leftJoin :: Table table database -> (Alias table database 'LeftJoined -> Expression nullable Bool) -> QueryClauses database (Alias table database 'LeftJoined)

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

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

where_ :: Expression 'NotNull Bool -> QueryClauses database ()

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

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

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

data QueryOrdering

Constructors

Asc SomeExpression

Desc SomeExpression

limit :: Int -> QueryClauses database ()

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

Insertion

data Insertor (table :: Symbol) database a

Instances

Contravariant (Insertor table database)

Defined in Database.MySQL.Hasqlator.Typed

Methods

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

(>$) :: b -> Insertor table database b -> 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

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

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

insertUpdateValues :: Table table database -> Insertor table database a -> (Alias table database 'InnerJoined -> Alias table database 'InnerJoined -> [Updator table database]) -> [a] -> Command

insertSelect :: Table table database -> QueryClauses 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 :: (a -> Expression nullable b) -> Field table database nullable b -> Insertor table database a

lensInto :: ToSql b => Getter a b -> Field table database 'NotNull b -> Insertor table database a

maybeLensInto :: ToSql b => Getter a (Maybe b) -> Field table database 'Nullable b -> Insertor table database a

opticInto :: (ToSql b, Is k A_Getter) => Optic' k is a b -> Field table database 'NotNull b -> Insertor table database a

maybeOpticInto :: (ToSql b, Is k A_Getter) => Optic' k is a (Maybe b) -> Field table database 'Nullable b -> Insertor table database a

insertOne :: ToSql a => Field table database 'NotNull fieldType -> Insertor table database a

exprInto :: Expression nullable a -> Field table database nullable a -> Into database table

data Into database (table :: Symbol)

insertWithout :: Field tables database nullable b -> Insertor table database a -> Insertor table database a

updateWithout :: Field table database nullable a -> [Updator table database] -> [Updator table database]

Deletion

delete :: QueryClauses database (Alias table database 'InnerJoined) -> Command

Update

data Updator table database

Constructors

forall nullable a. (Field table database nullable a) := (Expression nullable a) infix 0

update :: Table table database -> (Alias table database 'InnerJoined -> QueryClauses database [Updator table database]) -> Command

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 Value

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Value -> 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 Int8

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Int8 -> 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 Word8

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Word8 -> 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 Day

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Day -> MySQLValue

ToSql DiffTime

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: DiffTime -> MySQLValue

ToSql LocalTime

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: LocalTime -> MySQLValue

ToSql TimeOfDay

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: TimeOfDay -> MySQLValue

ToSql Integer

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Integer -> MySQLValue

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 a => ToSql (Maybe a)

Defined in Database.MySQL.Hasqlator

Methods

toSqlValue :: Maybe a -> MySQLValue

class FromSql a

Minimal complete definition

fromSql

Instances

FromSql Value

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Value

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 Int8

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Int8

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 Word8

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Word8

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 Day

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Day

FromSql DiffTime

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError DiffTime

FromSql LocalTime

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError LocalTime

FromSql TimeOfDay

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError TimeOfDay

FromSql Integer

Defined in Database.MySQL.Hasqlator

Methods

fromSql :: MySQLValue -> Either SQLError Integer

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 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

executeCommand :: MySQLConn -> Command -> IO OK

Execute a Command which doesn't return a result-set. May throw a SQLError exception. See the mysql-haskell package for other exceptions it may throw.

data Command

A command is a database query that doesn't return a value, but is executed for the side effect (inserting, updating, deleteing).

Instances

ToQueryBuilder Command

Defined in Database.MySQL.Hasqlator

Methods

toQueryBuilder :: Command -> QueryBuilder

data WaitLock