mysql-simple-0.4.5: A mid-level MySQL client library.

Copyright(c) 2011 MailRank Inc.
LicenseBSD3
MaintainerPaul Rouse <pyr@doynton.org>
Stabilityexperimental
Portabilityportable
Safe HaskellNone
LanguageHaskell98

Database.MySQL.Simple.Types

Description

Basic types.

Synopsis

Documentation

data Null #

A placeholder for the SQL NULL value.

Constructors

Null 
Instances
Eq Null # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

(==) :: Null -> Null -> Bool #

(/=) :: Null -> Null -> Bool #

Read Null # 
Instance details

Defined in Database.MySQL.Simple.Types

Show Null # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

showsPrec :: Int -> Null -> ShowS #

show :: Null -> String #

showList :: [Null] -> ShowS #

Param Null # 
Instance details

Defined in Database.MySQL.Simple.Param

Methods

render :: Null -> Action #

newtype Only a #

A single-value "collection".

This is useful if you need to supply a single parameter to a SQL query, or extract a single column from a SQL result.

Parameter example:

query c "select x from scores where x > ?" (Only (42::Int))

Result example:

xs <- query_ c "select id from users"
forM_ xs $ \(Only id) -> {- ... -}

Constructors

Only 

Fields

Instances
Functor Only # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

fmap :: (a -> b) -> Only a -> Only b #

(<$) :: a -> Only b -> Only a #

Eq a => Eq (Only a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

(==) :: Only a -> Only a -> Bool #

(/=) :: Only a -> Only a -> Bool #

Ord a => Ord (Only a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

compare :: Only a -> Only a -> Ordering #

(<) :: Only a -> Only a -> Bool #

(<=) :: Only a -> Only a -> Bool #

(>) :: Only a -> Only a -> Bool #

(>=) :: Only a -> Only a -> Bool #

max :: Only a -> Only a -> Only a #

min :: Only a -> Only a -> Only a #

Read a => Read (Only a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Show a => Show (Only a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

showsPrec :: Int -> Only a -> ShowS #

show :: Only a -> String #

showList :: [Only a] -> ShowS #

Result a => QueryResults (Only a) # 
Instance details

Defined in Database.MySQL.Simple.QueryResults

Methods

convertResults :: [Field] -> [Maybe ByteString] -> Only a #

Param a => QueryParams (Only a) # 
Instance details

Defined in Database.MySQL.Simple.QueryParams

Methods

renderParams :: Only a -> [Action] #

newtype In a #

Wrap a list of values for use in an IN clause. Replaces a single "?" character with a parenthesized list of rendered values.

Example:

query c "select * from whatever where id in ?" (Only (In [3,4,5]))

Constructors

In a 
Instances
Functor In # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

fmap :: (a -> b) -> In a -> In b #

(<$) :: a -> In b -> In a #

Eq a => Eq (In a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

(==) :: In a -> In a -> Bool #

(/=) :: In a -> In a -> Bool #

Ord a => Ord (In a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

compare :: In a -> In a -> Ordering #

(<) :: In a -> In a -> Bool #

(<=) :: In a -> In a -> Bool #

(>) :: In a -> In a -> Bool #

(>=) :: In a -> In a -> Bool #

max :: In a -> In a -> In a #

min :: In a -> In a -> In a #

Read a => Read (In a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Show a => Show (In a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

showsPrec :: Int -> In a -> ShowS #

show :: In a -> String #

showList :: [In a] -> ShowS #

Param a => Param (In [a]) # 
Instance details

Defined in Database.MySQL.Simple.Param

Methods

render :: In [a] -> Action #

Param a => Param (In (Set a)) # 
Instance details

Defined in Database.MySQL.Simple.Param

Methods

render :: In (Set a) -> Action #

newtype VaArgs a #

Wrap a list of values for use in a function with variable arguments. Replaces a single "?" character with a non-parenthesized list of rendered values.

Example:

query conn
  "SELECT * FROM example_table ORDER BY field(f,?)"
  (Only (VaArgs [3,2,1]))

Constructors

VaArgs a 
Instances
Functor VaArgs # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

fmap :: (a -> b) -> VaArgs a -> VaArgs b #

(<$) :: a -> VaArgs b -> VaArgs a #

Eq a => Eq (VaArgs a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

(==) :: VaArgs a -> VaArgs a -> Bool #

(/=) :: VaArgs a -> VaArgs a -> Bool #

Ord a => Ord (VaArgs a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

compare :: VaArgs a -> VaArgs a -> Ordering #

(<) :: VaArgs a -> VaArgs a -> Bool #

(<=) :: VaArgs a -> VaArgs a -> Bool #

(>) :: VaArgs a -> VaArgs a -> Bool #

(>=) :: VaArgs a -> VaArgs a -> Bool #

max :: VaArgs a -> VaArgs a -> VaArgs a #

min :: VaArgs a -> VaArgs a -> VaArgs a #

Read a => Read (VaArgs a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Show a => Show (VaArgs a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

showsPrec :: Int -> VaArgs a -> ShowS #

show :: VaArgs a -> String #

showList :: [VaArgs a] -> ShowS #

Param a => Param (VaArgs [a]) # 
Instance details

Defined in Database.MySQL.Simple.Param

Methods

render :: VaArgs [a] -> Action #

newtype Binary a #

Wrap a mostly-binary string to be escaped in hexadecimal.

Constructors

Binary a 
Instances
Functor Binary # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

fmap :: (a -> b) -> Binary a -> Binary b #

(<$) :: a -> Binary b -> Binary a #

Eq a => Eq (Binary a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

(==) :: Binary a -> Binary a -> Bool #

(/=) :: Binary a -> Binary a -> Bool #

Ord a => Ord (Binary a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

compare :: Binary a -> Binary a -> Ordering #

(<) :: Binary a -> Binary a -> Bool #

(<=) :: Binary a -> Binary a -> Bool #

(>) :: Binary a -> Binary a -> Bool #

(>=) :: Binary a -> Binary a -> Bool #

max :: Binary a -> Binary a -> Binary a #

min :: Binary a -> Binary a -> Binary a #

Read a => Read (Binary a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Show a => Show (Binary a) # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

showsPrec :: Int -> Binary a -> ShowS #

show :: Binary a -> String #

showList :: [Binary a] -> ShowS #

Param (Binary ByteString) # 
Instance details

Defined in Database.MySQL.Simple.Param

Param (Binary ByteString) # 
Instance details

Defined in Database.MySQL.Simple.Param

newtype Query #

A query string. This type is intended to make it difficult to construct a SQL query by concatenating string fragments, as that is an extremely common way to accidentally introduce SQL injection vulnerabilities into an application.

This type is an instance of IsString, so the easiest way to construct a query is to enable the OverloadedStrings language extension and then simply write the query in double quotes.

{-# LANGUAGE OverloadedStrings #-}

import Database.MySQL.Simple

q :: Query
q = "select ?"

The underlying type is a ByteString, and literal Haskell strings that contain Unicode characters will be correctly transformed to UTF-8.

Constructors

Query 
Instances
Eq Query # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

(==) :: Query -> Query -> Bool #

(/=) :: Query -> Query -> Bool #

Ord Query # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

compare :: Query -> Query -> Ordering #

(<) :: Query -> Query -> Bool #

(<=) :: Query -> Query -> Bool #

(>) :: Query -> Query -> Bool #

(>=) :: Query -> Query -> Bool #

max :: Query -> Query -> Query #

min :: Query -> Query -> Query #

Read Query # 
Instance details

Defined in Database.MySQL.Simple.Types

Show Query # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

showsPrec :: Int -> Query -> ShowS #

show :: Query -> String #

showList :: [Query] -> ShowS #

IsString Query # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

fromString :: String -> Query #

Semigroup Query # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

(<>) :: Query -> Query -> Query #

sconcat :: NonEmpty Query -> Query #

stimes :: Integral b => b -> Query -> Query #

Monoid Query # 
Instance details

Defined in Database.MySQL.Simple.Types

Methods

mempty :: Query #

mappend :: Query -> Query -> Query #

mconcat :: [Query] -> Query #