Database.MySQL.Hasqlator

Querying

data Query a

Instances

ToQueryBuilder (Query a)

Defined in Database.MySQL.Hasqlator

Methods

toQueryBuilder :: Query a -> QueryBuilder

data Command

Instances

ToQueryBuilder Command

Defined in Database.MySQL.Hasqlator

Methods

toQueryBuilder :: Command -> QueryBuilder

select :: Selector a -> QueryClauses -> Query a

mergeSelect :: Query b -> (a -> b -> c) -> Selector a -> Query c

replaceSelect :: Selector a -> Query b -> Query a

Query Clauses

data QueryClauses

Instances

Semigroup QueryClauses

Defined in Database.MySQL.Hasqlator

Methods

(<>) :: QueryClauses -> QueryClauses -> QueryClauses

sconcat :: NonEmpty QueryClauses -> QueryClauses

stimes :: Integral b => b -> QueryClauses -> QueryClauses

Monoid QueryClauses

Defined in Database.MySQL.Hasqlator

Methods

mempty :: QueryClauses

mappend :: QueryClauses -> QueryClauses -> QueryClauses

mconcat :: [QueryClauses] -> QueryClauses

from :: QueryBuilder -> QueryClauses

innerJoin :: [QueryBuilder] -> [QueryBuilder] -> QueryClauses

leftJoin :: [QueryBuilder] -> [QueryBuilder] -> QueryClauses

rightJoin :: [QueryBuilder] -> [QueryBuilder] -> QueryClauses

outerJoin :: [QueryBuilder] -> [QueryBuilder] -> QueryClauses

emptyJoins :: QueryClauses

where_ :: [QueryBuilder] -> QueryClauses

emptyWhere :: QueryClauses

groupBy_ :: [QueryBuilder] -> QueryClauses

having :: [QueryBuilder] -> QueryClauses

emptyHaving :: QueryClauses

data QueryOrdering

Constructors

Asc QueryBuilder

Desc QueryBuilder

Instances

ToQueryBuilder QueryOrdering

Defined in Database.MySQL.Hasqlator

Methods

toQueryBuilder :: QueryOrdering -> QueryBuilder

orderBy :: [QueryOrdering] -> QueryClauses

limit :: Int -> QueryClauses

limitOffset :: Int -> Int -> QueryClauses

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

as :: QueryBuilder -> QueryBuilder -> QueryBuilder

combinator for aliasing columns.

polymorphic selector

sel :: FromSql a => QueryBuilder -> Selector a

The polymorphic selector. The return type is determined by type inference.

specialised selectors

The following are specialised versions of sel. Using these may make refactoring easier, for example accidently swapping sel "age" and sel "name" would not give a type error, while intSel "age" and textSel "name" most likely would.

intSel :: (Show a, Bounded a, Integral a) => QueryBuilder -> Selector a

an integer field (TINYINT.. BIGINT). Any bounded haskell integer type can be used here , for example Int, Int32, Word32. An Overflow ur Underflow error will be raised if the value doesn't fit the type.

integerSel :: QueryBuilder -> Selector Integer

Un unbounded integer field, either a bounded integer (TINYINT, etc...) or DECIMAL in the database. Will throw a type error if the stored value is actually fractional.

WARNING: this function could potentially create huge integers with DECIMAL, if the exponent is large, even fillup the space and crash your program! Only use this on trusted inputs, or use Scientific instead.

doubleSel :: QueryBuilder -> Selector Double

a DOUBLE field.

floatSel :: QueryBuilder -> Selector Float

a FLOAT field.

scientificSel :: QueryBuilder -> Selector Scientific

A DECIMAL or NUMERIC field.

localTimeSel :: QueryBuilder -> Selector LocalTime

a DATETIME or a TIMESTAMP field.

timeOfDaySel :: QueryBuilder -> Selector TimeOfDay

A TIME field taken as a specific time.

diffTimeSel :: QueryBuilder -> Selector DiffTime

a TIME field taken as a time duration.

daySel :: QueryBuilder -> Selector Day

A DATE field.

byteStringSel :: QueryBuilder -> Selector ByteString

A binary BLOB field.

textSel :: QueryBuilder -> Selector Text

a TEXT field.

other selectors

values :: [QueryBuilder] -> Selector [MySQLValue]

Read the columns directly as a MySQLValue type without conversion.

values_ :: [QueryBuilder] -> Selector ()

Ignore the content of the given columns

Expressions

subQuery :: ToQueryBuilder a => a -> QueryBuilder

arg :: ToSql a => a -> QueryBuilder

fun :: Text -> [QueryBuilder] -> QueryBuilder

op :: Text -> QueryBuilder -> QueryBuilder -> QueryBuilder

(>.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(<.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(>=.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(<=.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(+.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(-.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(*.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(/.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(=.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(++.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(/=.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(&&.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

(||.) :: QueryBuilder -> QueryBuilder -> QueryBuilder

abs_ :: QueryBuilder -> QueryBuilder

negate_ :: QueryBuilder -> QueryBuilder

signum_ :: QueryBuilder -> QueryBuilder

sum_ :: QueryBuilder -> QueryBuilder

rawSql :: Text -> QueryBuilder

substr :: QueryBuilder -> QueryBuilder -> QueryBuilder -> QueryBuilder

in_ :: QueryBuilder -> [QueryBuilder] -> QueryBuilder

Insertion

data Insertor a

An Insertor a provides a mapping of parts of values of type a to columns in the database. Insertors can be combined using <>.

Instances

Contravariant Insertor

Defined in Database.MySQL.Hasqlator

Methods

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

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

Semigroup (Insertor a)

Defined in Database.MySQL.Hasqlator

Methods

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

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

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

Monoid (Insertor a)

Defined in Database.MySQL.Hasqlator

Methods

mempty :: Insertor a

mappend :: Insertor a -> Insertor a -> Insertor a

mconcat :: [Insertor a] -> Insertor a

insertValues :: QueryBuilder -> Insertor a -> [a] -> Command

insertSelect :: QueryBuilder -> [QueryBuilder] -> [QueryBuilder] -> QueryClauses -> Command

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

insertData inserts a tuple or other product type into the given fields. It uses generics to match the input to the fields. For example:

insert "Person" (insertData ("name", "age"))
  [Person "Bart Simpson" 10, Person "Lisa Simpson" 8]

skipInsert :: Insertor a

skipInsert is mempty specialized to an Insertor. It can be used to skip fields when using insertData.

into :: ToSql b => (a -> b) -> Text -> Insertor a

into uses the given accessor function to map the part to a field. For example:

insertValues "Person" (fst `into` "name" <> snd `into` "age")
  [("Bart Simpson", 10), ("Lisa Simpson", 8)]

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

A Getter type compatible with the lens library

lensInto :: ToSql b => Getter a b -> Text -> Insertor a

lensInto uses a lens to map the part to a field. For example:

insertValues "Person" (_1 `lensInto` "name" <> _2 `lensInto` "age")
  [("Bart Simpson", 10), ("Lisa Simpson", 8)]

insertOne :: ToSql a => Text -> Insertor a

insert a single value directly

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

Rendering Queries

renderStmt :: ToQueryBuilder a => a -> ByteString

renderPreparedStmt :: ToQueryBuilder a => a -> (ByteString, [MySQLValue])

data SQLError

Constructors

SQLError String

ResultSetCountError

TypeError MySQLValue String

ConversionError Text

Instances

Show SQLError

Defined in Database.MySQL.Hasqlator

Methods

showsPrec :: Int -> SQLError -> ShowS

show :: SQLError -> String

showList :: [SQLError] -> ShowS

Exception SQLError

Defined in Database.MySQL.Hasqlator

Methods

toException :: SQLError -> SomeException

fromException :: SomeException -> Maybe SQLError

displayException :: SQLError -> String

data QueryBuilder

Instances

IsString QueryBuilder

Defined in Database.MySQL.Hasqlator

Methods

fromString :: String -> QueryBuilder

Semigroup QueryBuilder

Defined in Database.MySQL.Hasqlator

Methods

(<>) :: QueryBuilder -> QueryBuilder -> QueryBuilder

sconcat :: NonEmpty QueryBuilder -> QueryBuilder

stimes :: Integral b => b -> QueryBuilder -> QueryBuilder

Monoid QueryBuilder

Defined in Database.MySQL.Hasqlator

Methods

mempty :: QueryBuilder

mappend :: QueryBuilder -> QueryBuilder -> QueryBuilder

mconcat :: [QueryBuilder] -> QueryBuilder

class ToQueryBuilder a where

Methods

toQueryBuilder :: a -> QueryBuilder

Instances

ToQueryBuilder QueryOrdering

Defined in Database.MySQL.Hasqlator

Methods

toQueryBuilder :: QueryOrdering -> QueryBuilder

ToQueryBuilder Command

Defined in Database.MySQL.Hasqlator

Methods

toQueryBuilder :: Command -> QueryBuilder

ToQueryBuilder (Query a)

Defined in Database.MySQL.Hasqlator

Methods

toQueryBuilder :: Query a -> QueryBuilder

ToQueryBuilder (Query database (Selector a))

Defined in Database.MySQL.Hasqlator.Typed

Methods

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

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)

Executing Queries

executeQuery :: MySQLConn -> Query a -> IO [a]

Execute a Query which returns a resultset. May throw a SQLError exception. See the mysql-haskell package for other exceptions it may throw.

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.