Portability	portable
Stability	experimental
Maintainer	Bryan O'Sullivan <bos@mailrank.com>

Database.MySQL.Base.C

Contents

Connection management
- Connection information
Querying
- Escaping
- Results
Working with results
- Multiple results
Transactions
General information
Error handling
Support functions

Description

Direct bindings to the C mysqlclient API.

Synopsis

Connection management

mysql_init Source

Arguments

:: Ptr MYSQL	should usually be `nullPtr`
-> IO (Ptr MYSQL)

mysql_options :: Ptr MYSQL -> Option -> IO CInt Source

mysql_ssl_set Source

Arguments

:: Ptr MYSQL
-> CString	Key.
-> CString	Cert.
-> CString	CA.
-> CString	CA path.
-> CString	Ciphers.
-> IO MyBool

mysql_real_connect Source

Arguments

:: Ptr MYSQL	Context (from `mysql_init`).
-> CString	Host name.
-> CString	User name.
-> CString	Password.
-> CString	Database.
-> CInt	Port.
-> CString	Unix socket.
-> CULong	Flags.
-> IO (Ptr MYSQL)

mysql_close :: Ptr MYSQL -> IO ()Source

mysql_ping :: Ptr MYSQL -> IO CInt Source

mysql_autocommit :: Ptr MYSQL -> MyBool -> IO MyBool Source

mysql_change_user Source

Arguments

:: Ptr MYSQL
-> CString	user
-> CString	password
-> CString	database
-> IO MyBool

mysql_select_db :: Ptr MYSQL -> CString -> IO CInt Source

mysql_set_character_set :: Ptr MYSQL -> CString -> IO CInt Source

Connection information

mysql_thread_id :: Ptr MYSQL -> IO CULong Source

mysql_get_server_info :: Ptr MYSQL -> IO CString Source

mysql_get_host_info :: Ptr MYSQL -> IO CString Source

mysql_get_proto_info :: Ptr MYSQL -> IO CUInt Source

mysql_character_set_name :: Ptr MYSQL -> IO CString Source

mysql_get_ssl_cipher :: Ptr MYSQL -> IO CString Source

mysql_stat :: Ptr MYSQL -> IO CString Source

Querying

mysql_real_query :: Ptr MYSQL -> CString -> CULong -> IO CInt Source

Escaping

mysql_real_escape_string :: Ptr MYSQL -> CString -> CString -> CULong -> IO CULong Source

Results

mysql_field_count :: Ptr MYSQL -> IO CUInt Source

mysql_affected_rows :: Ptr MYSQL -> IO CULLong Source

mysql_store_result :: Ptr MYSQL -> IO (Ptr MYSQL_RES)Source

mysql_use_result :: Ptr MYSQL -> IO (Ptr MYSQL_RES)Source

mysql_fetch_lengths :: Ptr MYSQL_RES -> IO (Ptr CULong)Source

mysql_fetch_lengths_nonblock :: Ptr MYSQL_RES -> IO (Ptr CULong)Source

mysql_fetch_row :: Ptr MYSQL_RES -> IO MYSQL_ROW Source

mysql_fetch_row_nonblock :: Ptr MYSQL_RES -> IO MYSQL_ROW Source

Working with results

mysql_free_result :: Ptr MYSQL_RES -> IO ()Source

mysql_fetch_fields :: Ptr MYSQL_RES -> IO (Ptr Field)Source

mysql_fetch_fields_nonblock :: Ptr MYSQL_RES -> IO (Ptr Field)Source

mysql_data_seek :: Ptr MYSQL_RES -> CULLong -> IO ()Source

mysql_row_seek :: Ptr MYSQL_RES -> MYSQL_ROW_OFFSET -> IO MYSQL_ROW_OFFSET Source

mysql_row_tell :: Ptr MYSQL_RES -> IO MYSQL_ROW_OFFSET Source

Multiple results

mysql_next_result :: Ptr MYSQL -> IO CInt Source

Transactions

mysql_commit :: Ptr MYSQL -> IO MyBool Source

mysql_rollback :: Ptr MYSQL -> IO MyBool Source

General information

mysql_get_client_info :: CString Source

mysql_get_client_version :: CULong Source

Error handling

mysql_errno :: Ptr MYSQL -> IO CInt Source

mysql_error :: Ptr MYSQL -> IO CString Source

Support functions

withRTSSignalsBlocked :: IO a -> IO aSource

Execute an IO action with signals used by GHC's runtime signals blocked. The mysqlclient C library does not correctly restart system calls if they are interrupted by signals, so many MySQL API calls can unexpectedly fail when called from a Haskell application. This is most likely to occur if you are linking against GHC's threaded runtime (using the -threaded option).

This function blocks SIGALRM and SIGVTALRM, runs your action, then unblocks those signals. If you have a series of HDBC calls that may block for a period of time, it may be wise to wrap them in this action. Blocking and unblocking signals is cheap, but not free.

Here is an example of an exception that could be avoided by temporarily blocking GHC's runtime signals:

  SqlError {
    seState = "", 
    seNativeError = 2003, 
    seErrorMsg = "Can't connect to MySQL server on 'localhost' (4)"
  }