Copyright	(c) 2011 MailRank Inc.
License	BSD3
Maintainer	Paul Rouse <[email protected]>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Database.MySQL.Base.Types

Contents

Types
High-level types
Low-level types
Field flags
Connect flags

Description

Types for working with the direct bindings to the C mysqlclient API.

Synopsis

data Type
- = Decimal
- | Tiny
- | Short
- | Long
- | Float
- | Double
- | Null
- | Timestamp
- | LongLong
- | Int24
- | Date
- | Time
- | DateTime
- | Year
- | NewDate
- | VarChar
- | Bit
- | NewDecimal
- | Enum
- | Set
- | TinyBlob
- | MediumBlob
- | LongBlob
- | Blob
- | VarString
- | String
- | Geometry
- | Json
type Seconds = Word
data Protocol
- = TCP
- | Socket
- | Pipe
- | Memory
data Option
- = ConnectTimeout Seconds
- | Compress
- | NamedPipe
- | InitCommand ByteString
- | ReadDefaultFile FilePath
- | ReadDefaultGroup ByteString
- | CharsetDir FilePath
- | CharsetName String
- | LocalInFile Bool
- | Protocol Protocol
- | SharedMemoryBaseName ByteString
- | ReadTimeout Seconds
- | WriteTimeout Seconds
- | UseRemoteConnection
- | UseEmbeddedConnection
- | GuessConnection
- | ClientIP ByteString
- | SecureAuth Bool
- | ReportDataTruncation Bool
- | Reconnect Bool
- | SSLVerifyServerCert Bool
- | FoundRows
- | IgnoreSIGPIPE
- | IgnoreSpace
- | Interactive
- | LocalFiles
- | MultiResults
- | MultiStatements
- | NoSchema
data Field = Field {
- fieldName :: ByteString
- fieldOrigName :: ByteString
- fieldTable :: ByteString
- fieldOrigTable :: ByteString
- fieldDB :: ByteString
- fieldCatalog :: ByteString
- fieldLength :: Word
- fieldMaxLength :: Word
- fieldFlags :: FieldFlags
- fieldDecimals :: Word
- fieldCharSet :: Word
- fieldType :: Type
}
type FieldFlag = FieldFlags
data FieldFlags
data MYSQL
data MYSQL_RES
type MYSQL_ROW = Ptr (Ptr CChar)
data MYSQL_ROWS
type MYSQL_ROW_OFFSET = Ptr MYSQL_ROWS
type MyBool = CChar
hasAllFlags :: FieldFlags -> FieldFlags -> Bool
flagNotNull :: FieldFlag
flagPrimaryKey :: FieldFlag
flagUniqueKey :: FieldFlag
flagMultipleKey :: FieldFlag
flagUnsigned :: FieldFlag
flagZeroFill :: FieldFlag
flagBinary :: FieldFlag
flagAutoIncrement :: FieldFlag
flagNumeric :: FieldFlag
flagNoDefaultValue :: FieldFlag
toConnectFlag :: Option -> CULong

Types

High-level types

data Type Source #

Column types supported by MySQL.

Instances

Instances details

Enum Type Source #
Instance details Defined in Database.MySQL.Base.Types Methods succ :: Type -> Type # pred :: Type -> Type # toEnum :: Int -> Type # fromEnum :: Type -> Int # enumFrom :: Type -> [Type] # enumFromThen :: Type -> Type -> [Type] # enumFromTo :: Type -> Type -> [Type] # enumFromThenTo :: Type -> Type -> Type -> [Type] #
Eq Type Source #
Instance details Defined in Database.MySQL.Base.Types Methods (==) :: Type -> Type -> Bool # (/=) :: Type -> Type -> Bool #
Show Type Source #
Instance details Defined in Database.MySQL.Base.Types Methods showsPrec :: Int -> Type -> ShowS # show :: Type -> String # showList :: [Type] -> ShowS #

type Seconds = Word Source #

data Protocol Source #

Constructors

TCP
Socket
Pipe
Memory

Instances

Instances details

Enum Protocol Source #
Instance details Defined in Database.MySQL.Base.Types Methods succ :: Protocol -> Protocol # pred :: Protocol -> Protocol # toEnum :: Int -> Protocol # fromEnum :: Protocol -> Int # enumFrom :: Protocol -> [Protocol] # enumFromThen :: Protocol -> Protocol -> [Protocol] # enumFromTo :: Protocol -> Protocol -> [Protocol] # enumFromThenTo :: Protocol -> Protocol -> Protocol -> [Protocol] #
Eq Protocol Source #
Instance details Defined in Database.MySQL.Base.Types Methods (==) :: Protocol -> Protocol -> Bool # (/=) :: Protocol -> Protocol -> Bool #
Read Protocol Source #
Instance details Defined in Database.MySQL.Base.Types Methods readsPrec :: Int -> ReadS Protocol # readList :: ReadS [Protocol] # readPrec :: ReadPrec Protocol # readListPrec :: ReadPrec [Protocol] #
Show Protocol Source #
Instance details Defined in Database.MySQL.Base.Types Methods showsPrec :: Int -> Protocol -> ShowS # show :: Protocol -> String # showList :: [Protocol] -> ShowS #

data Option Source #

Instances

Instances details

Eq Option Source #
Instance details Defined in Database.MySQL.Base.Types Methods (==) :: Option -> Option -> Bool # (/=) :: Option -> Option -> Bool #
Read Option Source #
Instance details Defined in Database.MySQL.Base.Types Methods readsPrec :: Int -> ReadS Option # readList :: ReadS [Option] # readPrec :: ReadPrec Option # readListPrec :: ReadPrec [Option] #
Show Option Source #
Instance details Defined in Database.MySQL.Base.Types Methods showsPrec :: Int -> Option -> ShowS # show :: Option -> String # showList :: [Option] -> ShowS #

data Field Source #

A description of a field (column) of a table.

Constructors

Field

Fields

fieldName :: ByteString
Name of column.
fieldOrigName :: ByteString
Original column name, if an alias.
fieldTable :: ByteString
Table of column, if column was a field.
fieldOrigTable :: ByteString
Original table name, if table was an alias.
fieldDB :: ByteString
Database for table.
fieldCatalog :: ByteString
Catalog for table.
fieldLength :: Word
Width of column (create length).
fieldMaxLength :: Word
Maximum width for selected set.
fieldFlags :: FieldFlags
Div flags.
fieldDecimals :: Word
Number of decimals in field.
fieldCharSet :: Word
Character set number.
fieldType :: Type

Instances

Instances details

Eq Field Source #
Instance details Defined in Database.MySQL.Base.Types Methods (==) :: Field -> Field -> Bool # (/=) :: Field -> Field -> Bool #
Show Field Source #
Instance details Defined in Database.MySQL.Base.Types Methods showsPrec :: Int -> Field -> ShowS # show :: Field -> String # showList :: [Field] -> ShowS #
Storable Field Source #
Instance details Defined in Database.MySQL.Base.Types Methods sizeOf :: Field -> Int # alignment :: Field -> Int # peekElemOff :: Ptr Field -> Int -> IO Field # pokeElemOff :: Ptr Field -> Int -> Field -> IO () # peekByteOff :: Ptr b -> Int -> IO Field # pokeByteOff :: Ptr b -> Int -> Field -> IO () # peek :: Ptr Field -> IO Field # poke :: Ptr Field -> Field -> IO () #

type FieldFlag = FieldFlags Source #

data FieldFlags Source #

Instances

Instances details

Eq FieldFlags Source #
Instance details Defined in Database.MySQL.Base.Types Methods (==) :: FieldFlags -> FieldFlags -> Bool # (/=) :: FieldFlags -> FieldFlags -> Bool #
Show FieldFlags Source #
Instance details Defined in Database.MySQL.Base.Types Methods showsPrec :: Int -> FieldFlags -> ShowS # show :: FieldFlags -> String # showList :: [FieldFlags] -> ShowS #
Semigroup FieldFlags Source #
Instance details Defined in Database.MySQL.Base.Types Methods (<>) :: FieldFlags -> FieldFlags -> FieldFlags # sconcat :: NonEmpty FieldFlags -> FieldFlags # stimes :: Integral b => b -> FieldFlags -> FieldFlags #
Monoid FieldFlags Source #
Instance details Defined in Database.MySQL.Base.Types Methods mempty :: FieldFlags # mappend :: FieldFlags -> FieldFlags -> FieldFlags # mconcat :: [FieldFlags] -> FieldFlags #

Low-level types

data MYSQL Source #

data MYSQL_RES Source #

type MYSQL_ROW = Ptr (Ptr CChar) Source #

data MYSQL_ROWS Source #

type MYSQL_ROW_OFFSET = Ptr MYSQL_ROWS Source #

type MyBool = CChar Source #

Field flags

hasAllFlags :: FieldFlags -> FieldFlags -> Bool Source #

flagNotNull :: FieldFlag Source #

flagPrimaryKey :: FieldFlag Source #

flagUniqueKey :: FieldFlag Source #

flagMultipleKey :: FieldFlag Source #

flagUnsigned :: FieldFlag Source #

flagZeroFill :: FieldFlag Source #

flagBinary :: FieldFlag Source #

flagAutoIncrement :: FieldFlag Source #

flagNumeric :: FieldFlag Source #

flagNoDefaultValue :: FieldFlag Source #

Connect flags

toConnectFlag :: Option -> CULong Source #

Decimal
Tiny
Short
Long
Float
Double
Null
Timestamp
LongLong
Int24
Date
Time
DateTime
Year
NewDate
VarChar
Bit
NewDecimal
Enum
Set
TinyBlob
MediumBlob
LongBlob
Blob
VarString
String
Geometry
Json

ConnectTimeout Seconds
Compress
NamedPipe
InitCommand ByteString
ReadDefaultFile FilePath
ReadDefaultGroup ByteString
CharsetDir FilePath
CharsetName String
LocalInFile Bool
Protocol Protocol
SharedMemoryBaseName ByteString
ReadTimeout Seconds
WriteTimeout Seconds
UseRemoteConnection
UseEmbeddedConnection
GuessConnection
ClientIP ByteString
SecureAuth Bool
ReportDataTruncation Bool
Reconnect Bool
SSLVerifyServerCert Bool
FoundRows
IgnoreSIGPIPE
IgnoreSpace
Interactive
LocalFiles
MultiResults
MultiStatements
NoSchema