Database.MySQL.Simple.Param

The Param typeclass, for rendering a parameter to a SQL query.

Documentation

data Action

How to render an element when substituting it into a query.

Constructors

Plain Builder

Render without escaping or quoting. Use for non-text types such as numbers, when you are certain that they will not introduce formatting vulnerabilities via use of characters such as spaces or "'".

Escape ByteString

Escape and enclose in quotes before substituting. Use for all text-like types, and anything else that may contain unsafe characters when rendered.

Many [Action]

Concatenate a series of rendering actions.

Instances

Show Action

Defined in Database.MySQL.Simple.Param

Methods

showsPrec :: Int -> Action -> ShowS

show :: Action -> String

showList :: [Action] -> ShowS

Param Action

Defined in Database.MySQL.Simple.Param

Methods

render :: Action -> Action

class ToField a where

A type that can be converted to a ByteString for use as a parameter to an SQL query.

Any type which is an instance of this class can use the default implementation of Param, which will wrap encodings with Escape.

Since: 0.4.8

Methods

toField :: a -> ByteString

class Param a where

A type that may be used as a single parameter to a SQL query.

A default implementation is provided for any type which is an instance of ToField, providing a simple mechanism for user-defined encoding to text- or blob-like fields (including JSON).

Minimal complete definition

Nothing

Methods

render :: a -> Action

Prepare a value for substitution into a query string.

default render :: ToField a => a -> Action

Instances

Param Int16

Defined in Database.MySQL.Simple.Param

Methods

render :: Int16 -> Action

Param Int32

Defined in Database.MySQL.Simple.Param

Methods

render :: Int32 -> Action

Param Int64

Defined in Database.MySQL.Simple.Param

Methods

render :: Int64 -> Action

Param Int8

Defined in Database.MySQL.Simple.Param

Methods

render :: Int8 -> Action

Param Word16

Defined in Database.MySQL.Simple.Param

Methods

render :: Word16 -> Action

Param Word32

Defined in Database.MySQL.Simple.Param

Methods

render :: Word32 -> Action

Param Word64

Defined in Database.MySQL.Simple.Param

Methods

render :: Word64 -> Action

Param ByteString

Defined in Database.MySQL.Simple.Param

Methods

render :: ByteString -> Action

Param ByteString

Defined in Database.MySQL.Simple.Param

Methods

render :: ByteString -> Action

Param Action

Defined in Database.MySQL.Simple.Param

Methods

render :: Action -> Action

Param Null

Defined in Database.MySQL.Simple.Param

Methods

render :: Null -> Action

Param Text

Defined in Database.MySQL.Simple.Param

Methods

render :: Text -> Action

Param Text

Defined in Database.MySQL.Simple.Param

Methods

render :: Text -> Action

Param Day

Defined in Database.MySQL.Simple.Param

Methods

render :: Day -> Action

Param UTCTime

Defined in Database.MySQL.Simple.Param

Methods

render :: UTCTime -> Action

Param TimeOfDay

Defined in Database.MySQL.Simple.Param

Methods

render :: TimeOfDay -> Action

Param Word8

Defined in Database.MySQL.Simple.Param

Methods

render :: Word8 -> Action

Param Integer

Defined in Database.MySQL.Simple.Param

Methods

render :: Integer -> Action

Param Bool

Defined in Database.MySQL.Simple.Param

Methods

render :: Bool -> Action

Param Double

Defined in Database.MySQL.Simple.Param

Methods

render :: Double -> Action

Param Float

Defined in Database.MySQL.Simple.Param

Methods

render :: Float -> Action

Param Int

Defined in Database.MySQL.Simple.Param

Methods

render :: Int -> Action

Param Word

Defined in Database.MySQL.Simple.Param

Methods

render :: Word -> Action

Param (Binary ByteString)

Defined in Database.MySQL.Simple.Param

Methods

render :: Binary ByteString -> Action

Param (Binary ByteString)

Defined in Database.MySQL.Simple.Param

Methods

render :: Binary ByteString -> Action

Param a => Param (In (Set a))

Defined in Database.MySQL.Simple.Param

Methods

render :: In (Set a) -> Action

Param a => Param (In [a])

Defined in Database.MySQL.Simple.Param

Methods

render :: In [a] -> Action

Param a => Param (VaArgs [a])

Defined in Database.MySQL.Simple.Param

Methods

render :: VaArgs [a] -> Action

Param a => Param (Maybe a)

Defined in Database.MySQL.Simple.Param

Methods

render :: Maybe a -> Action

Param [Char]

Defined in Database.MySQL.Simple.Param

Methods

render :: [Char] -> Action

inQuotes :: Builder -> Builder

Surround a string with single-quote characters: "'"

This function does not perform any other escaping.