mysql-replication
English | 简体中文
The bottom library in mysql-cdc: synchronous MySQL binlog subscription, protocol parsing and BinlogEvent generation. Raw insert/update/delete images can be decoded on demand; normalized CDC events, transaction delivery and checkpoints belong to mysql-canal.
Read a local binlog
To integrate from local source, use the dependency below; replace /path/to/mysql-cdc-rs with your checkout path.
[]
= { = "2.2.1", = "/path/to/mysql-cdc-rs/crates/mysql-replication" }
use ;
use ;
next_event() returns original bytes, the common header and an EventData body, borrowed until the next read. Use into_owned() only when retaining an event. Event::dump prints field diagnostics. Files must retain their initial FDE.
Subscribe to MySQL
use ;
Credentials come from MYSQL_URL. row_image validates the upstream setting without changing MySQL; callers supply the file and position. next_frame() returns a validated raw frame, while network next_view() borrows the driver body directly.
Fix the mode at construction
use ;
use ;
Minimal / Full propagate through parser, reader, BinlogEvent and RowsEvent; every typed constructor requires an explicit mode. ReplicationStream::<Full>::connect(connection, config) validates type/config agreement before connecting. Use FrameReader for raw files and ReplicationConnection for raw network frames/views; typed readers expose only next_event().
Decode row images
See the concrete MINIMAL / FULL contents for the new events: the same UPDATE expanded into event types, before/after images, column definitions, values, and absent/NULL access results.
BinlogFile<_, M> / ReplicationStream<M> automatically bind shared column definitions from TABLE_MAP, so RowsEvent<M>::rows() needs no external decoder. The same Full / Minimal markers select types through static dispatch, without runtime mode checks in row loops. Row.operation uses RowOperation::Insert { after }, Update { before, after }, or Delete { before }, preventing missing required images.
Minimal yields SparseImage, whose field(index) returns Result<Option<Field>>; a valid but unlogged column is None. Full yields CompleteImage, returns Result<Field> and rejects incomplete images. Both reject out-of-range indices. Each Field provides column: &ColumnInfo and a borrowed value: RowValue; SQL NULL is Field.value = RowValue::Null. fields() iterates present fields, while columns() exposes every table column definition.
Definitions include ordinals, available names, wire types, nullability, signedness, collations and key metadata. Metadata availability is independent of image completeness: binlog_row_image=FULL does not guarantee names. Missing optional attributes stay None; decoding never queries the current server schema. into_owned() / view() preserve historical column plans and the actual checksum. Parser mappings are source-local, replaced on remaps and cleared at file/statement boundaries. The sentinel has its own EventData::RowsStatementEnd variant. Select the mode before the first read.
Custom protocol parsers use file::FrameReader / stream::ReplicationConnection. Explicit RowsDecoder<M> decoding shares the same generic events and images as automatic binding. Raw decoding requires no primary key or transaction buffering; canal retains its own adapters and lightweight change output.
Run examples from the workspace root. See the event reference for field definitions, NULL/absent-column distinctions and mode-specific accessors.