Database.MySQL.Connection

This is an internal module, the MySQLConn type should not directly acessed to user.

Documentation

data MySQLConn

MySQLConn wrap both InputStream and OutputStream for MySQL Packet.

You shouldn't use one MySQLConn in different thread, if you do that, consider protecting it with a MVar.

Constructors

MySQLConn

Fields

• mysqlRead :: !(InputStream Packet)
• mysqlWrite :: Packet -> IO ()
• mysqlCloseSocket :: IO ()
• isConsumed :: !(IORef Bool)

data ConnectInfo

Everything you need to establish a MySQL connection.

To setup a TLS connection, use module Database.MySQL.TLS or Database.MySQL.OpenSSL.

Constructors

ConnectInfo

Fields

• ciHost :: HostName
• ciPort :: PortNumber
• ciDatabase :: ByteString
• ciUser :: ByteString
• ciPassword :: ByteString
• ciCharset :: Word8

Instances

Show ConnectInfo

Defined in Database.MySQL.Connection

Methods

showsPrec :: Int -> ConnectInfo -> ShowS

show :: ConnectInfo -> String

showList :: [ConnectInfo] -> ShowS

defaultConnectInfo :: ConnectInfo

A simple ConnectInfo targeting localhost with user=root and empty password.

Default charset is set to utf8_general_ci to support older(< 5.5.3) MySQL versions, but be aware this is a partial utf8 encoding, you may want to use defaultConnectInfoMB4 instead to support full utf8 charset(emoji, etc.). You can query your server's support with SELECT id, collation_name FROM information_schema.collations ORDER BY id;

defaultConnectInfoMB4 :: ConnectInfo

defaultConnectInfo with charset set to utf8mb4_unicode_ci

This is recommanded on any MySQL server version >= 5.5.3.

utf8_general_ci :: Word8

utf8mb4_unicode_ci :: Word8

bUFSIZE :: Int

Socket buffer size.

maybe exposed to ConnectInfo laster?

connect :: ConnectInfo -> IO MySQLConn

Establish a MySQL connection.

connectDetail :: ConnectInfo -> IO (Greeting, MySQLConn)

Establish a MySQL connection with Greeting back, so you can find server's version .etc.

mkAuth :: ByteString -> ByteString -> ByteString -> Word8 -> Greeting -> Auth

decodeInputStream :: InputStream ByteString -> IO (InputStream Packet)

A specialized decodeInputStream here for speed

close :: MySQLConn -> IO ()

Close a MySQL connection.

ping :: MySQLConn -> IO OK

Send a COM_PING.

command :: MySQLConn -> Command -> IO OK

Send a Command which don't return a resultSet.

waitCommandReply :: InputStream Packet -> IO OK

waitCommandReplys :: InputStream Packet -> IO [OK]

readPacket :: InputStream Packet -> IO Packet

writeCommand :: Command -> (Packet -> IO ()) -> IO ()

guardUnconsumed :: MySQLConn -> IO ()

writeIORef' :: IORef a -> a -> IO ()

data NetworkException

Constructors

NetworkException

Instances

Exception NetworkException

Defined in Database.MySQL.Connection

Methods

toException :: NetworkException -> SomeException

fromException :: SomeException -> Maybe NetworkException

displayException :: NetworkException -> String

Show NetworkException

Defined in Database.MySQL.Connection

Methods

showsPrec :: Int -> NetworkException -> ShowS

show :: NetworkException -> String

showList :: [NetworkException] -> ShowS

data UnconsumedResultSet

Constructors

UnconsumedResultSet

Instances

Exception UnconsumedResultSet

Defined in Database.MySQL.Connection

Methods

toException :: UnconsumedResultSet -> SomeException

fromException :: SomeException -> Maybe UnconsumedResultSet

displayException :: UnconsumedResultSet -> String

Show UnconsumedResultSet

Defined in Database.MySQL.Connection

Methods

showsPrec :: Int -> UnconsumedResultSet -> ShowS

show :: UnconsumedResultSet -> String

showList :: [UnconsumedResultSet] -> ShowS

data ERRException

Constructors

ERRException ERR

Instances

Exception ERRException

Defined in Database.MySQL.Connection

Methods

toException :: ERRException -> SomeException

fromException :: SomeException -> Maybe ERRException

displayException :: ERRException -> String

Show ERRException

Defined in Database.MySQL.Connection

Methods

showsPrec :: Int -> ERRException -> ShowS

show :: ERRException -> String

showList :: [ERRException] -> ShowS

data UnexpectedPacket

Constructors

UnexpectedPacket Packet

Instances

Exception UnexpectedPacket

Defined in Database.MySQL.Connection

Methods

toException :: UnexpectedPacket -> SomeException

fromException :: SomeException -> Maybe UnexpectedPacket

displayException :: UnexpectedPacket -> String

Show UnexpectedPacket

Defined in Database.MySQL.Connection

Methods

showsPrec :: Int -> UnexpectedPacket -> ShowS

show :: UnexpectedPacket -> String

showList :: [UnexpectedPacket] -> ShowS