Database.MySQL.BinLog

This module provide tools for binlog listening and row based binlog decoding.

binlog utilities

type SlaveID = Word32

data BinLogTracker

binlog filename and position to start listening.

Constructors

BinLogTracker

Fields

btFileName :: !ByteString

btNextPos :: !Word32

Instances

Eq BinLogTracker

Show BinLogTracker

registerPesudoSlave :: MySQLConn -> SlaveID -> IO OK

Register a pesudo slave to master, although MySQL document suggests you should call this before calling dumpBinLog, but it seems it's not really necessary.

dumpBinLog

Arguments

:: MySQLConn

connection to be listened

-> SlaveID

a number for our pesudo slave.

-> BinLogTracker

binlog position

-> Bool

if master support semi-ack, do we want to enable it? if master doesn't support, this parameter will be ignored.

-> IO (FormatDescription, IORef ByteString, InputStream BinLogPacket)

FormatDescription, IORef contains current binlog filename, BinLogPacket stream.

Setup binlog listening on given connection, during listening the connection CAN NOT be used to do query, or an UnconsumedResultSet will be thrown.

data RowBinLogEvent

Row based biblog event type.

It's recommended to enable row query event before dumpBinLog, so that you can get RowQueryEvent in row based binlog(it's important for detect a table change for example), more information please refer sysvar_binlog_rows_query_log_events

a BinLogTracker is included so that you can roll up your own HA solutions, for example, writing the tracker to zookeeper when you done with an event.

Constructors

RowQueryEvent !BinLogTracker !QueryEvent'

RowDeleteEvent !BinLogTracker !TableMapEvent !DeleteRowsEvent

RowWriteEvent !BinLogTracker !TableMapEvent !WriteRowsEvent

RowUpdateEvent !BinLogTracker !TableMapEvent !UpdateRowsEvent

Instances

Eq RowBinLogEvent

Show RowBinLogEvent

decodeRowBinLogEvent :: (FormatDescription, IORef ByteString, InputStream BinLogPacket) -> IO (InputStream RowBinLogEvent)

decode row based event from BinLogPacket stream.

helpers

getLastBinLogTracker :: MySQLConn -> IO (Maybe BinLogTracker)

Get latest master's binlog filename and position.

isCheckSumEnabled :: MySQLConn -> IO Bool

Return True if binlog_checksum = CRC32. Only for MySQL > 5.6

isSemiSyncEnabled :: MySQLConn -> IO Bool

Return True if rpl_semi_sync_master_enabled = ON. Only for MySQL > 5.5

re-export

module Database.MySQL.BinLogProtocol.BinLogEvent

module Database.MySQL.BinLogProtocol.BinLogValue