| Copyright | (c) Winterland, 2016 |
|---|---|
| License | BSD |
| Maintainer | [email protected] |
| Stability | experimental |
| Portability | PORTABLE |
| Safe Haskell | None |
| Language | Haskell2010 |
Database.MySQL.Base
Description
This module provide common MySQL operations,
NOTEs on Exceptions: This package use Exception to deal with unexpected situations,
but you shouldn't try to catch them if you don't have a recovery plan,
for example: there's no meaning to catch a ERRException during authentication unless you want to try different passwords.
By using this library you will meet:
NetworkException: underline network is broken.UnconsumedResultSet: you should consume previous resultset before sending new command.ERRException: you receive aERRpacket when you shouldn't.UnexpectedPacket: you receive a unexpected packet when you shouldn't.DecodePacketException: there's a packet we can't decode.WrongParamsCount: you're giving wrong number of params torenderParams.
Both UnexpectedPacket and DecodePacketException may indicate a bug of this library rather your code, so please report!
- data MySQLConn
- data ConnectInfo = ConnectInfo {}
- defaultConnectInfo :: ConnectInfo
- connect :: ConnectInfo -> IO MySQLConn
- connectDetail :: ConnectInfo -> IO (Greeting, MySQLConn)
- close :: MySQLConn -> IO ()
- ping :: MySQLConn -> IO OK
- execute :: MySQLConn -> Query -> [MySQLValue] -> IO OK
- executeMany :: MySQLConn -> Query -> [[MySQLValue]] -> IO [OK]
- execute_ :: MySQLConn -> Query -> IO OK
- query_ :: MySQLConn -> Query -> IO ([ColumnDef], InputStream [MySQLValue])
- query :: MySQLConn -> Query -> [MySQLValue] -> IO ([ColumnDef], InputStream [MySQLValue])
- prepareStmt :: MySQLConn -> Query -> IO StmtID
- prepareStmtDetail :: MySQLConn -> Query -> IO (StmtPrepareOK, [ColumnDef], [ColumnDef])
- executeStmt :: MySQLConn -> StmtID -> [MySQLValue] -> IO OK
- queryStmt :: MySQLConn -> StmtID -> [MySQLValue] -> IO ([ColumnDef], InputStream [MySQLValue])
- closeStmt :: MySQLConn -> StmtID -> IO ()
- resetStmt :: MySQLConn -> StmtID -> IO ()
- withTransaction :: MySQLConn -> IO a -> IO a
- newtype Query = Query {}
- renderParams :: Query -> [MySQLValue] -> Query
- command :: MySQLConn -> Command -> IO OK
- skipToEof :: InputStream a -> IO ()
- module Database.MySQL.Protocol.Auth
- module Database.MySQL.Protocol.Command
- module Database.MySQL.Protocol.ColumnDef
- module Database.MySQL.Protocol.Packet
- module Database.MySQL.Protocol.MySQLValue
Setting up and control connection
data ConnectInfo Source #
Everything you need to establish a MySQL connection.
You may want some helpers in System.IO.Streams.TLS to setup TLS connection.
Constructors
| ConnectInfo | |
Fields
| |
Instances
defaultConnectInfo :: ConnectInfo Source #
A simple ConnectInfo targeting localhost with user=root and empty password.
connectDetail :: ConnectInfo -> IO (Greeting, MySQLConn) Source #
Establish a MySQL connection with Greeting back, so you can find server's version .etc.
direct query
execute :: MySQLConn -> Query -> [MySQLValue] -> IO OK Source #
Execute a MySQL query with parameters which don't return a result-set.
The query may contain placeholders ?, for filling up parameters, the parameters
will be escaped before get filled into the query, please DO NOT enable NO_BACKSLASH_ESCAPES,
and you should consider using prepared statement if this's not an one shot query.
executeMany :: MySQLConn -> Query -> [[MySQLValue]] -> IO [OK] Source #
Execute a multi-row query which don't return result-set.
Leverage MySQL's multi-statement support to do batch insert/update/delete,
you may want to use withTransaction to make sure it's atomic, and
use sum . map okAffectedRows to get all affected rows count.
Since: 0.2.0.0
execute_ :: MySQLConn -> Query -> IO OK Source #
Execute a MySQL query which don't return a result-set.
query_ :: MySQLConn -> Query -> IO ([ColumnDef], InputStream [MySQLValue]) Source #
Execute a MySQL query which return a result-set.
query :: MySQLConn -> Query -> [MySQLValue] -> IO ([ColumnDef], InputStream [MySQLValue]) Source #
prepared query statement
prepareStmtDetail :: MySQLConn -> Query -> IO (StmtPrepareOK, [ColumnDef], [ColumnDef]) Source #
Ask MySQL to prepare a query statement.
All details from COM_STMT_PREPARE Response are returned: the StmtPrepareOK packet,
params's ColumnDef, table's ColumnDef.
executeStmt :: MySQLConn -> StmtID -> [MySQLValue] -> IO OK Source #
Execute prepared query statement with parameters, expecting no resultset.
queryStmt :: MySQLConn -> StmtID -> [MySQLValue] -> IO ([ColumnDef], InputStream [MySQLValue]) Source #
Execute prepared query statement with parameters, expecting resultset.
Rules about UnconsumedResultSet applied here too.
resetStmt :: MySQLConn -> StmtID -> IO () Source #
Ask MySQL to reset a query statement, all previous resultset will be cleared.
helpers
withTransaction :: MySQLConn -> IO a -> IO a Source #
Run querys inside a transaction, querys will be rolled back if exception arise.
Since: 0.2.0.0
Query string type borrowed from mysql-simple.
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.
The underlying type is a ByteString, and literal Haskell strings
that contain Unicode characters will be correctly transformed to
UTF-8.
Constructors
| Query | |
Fields | |
renderParams :: Query -> [MySQLValue] -> Query Source #
skipToEof :: InputStream a -> IO () #
Drives an InputStream to end-of-stream, discarding all of the yielded
values.
MySQL protocol
module Database.MySQL.Protocol.Auth