Struct MySqlCdcSource 

pub struct MySqlCdcSource { /* private fields */ }

MySQL binlog CDC source connector.

Reads change events from MySQL binary log using replication protocol. Supports both GTID-based and file/position-based replication.

Example

use laminar_connectors::cdc::mysql::{MySqlCdcSource, MySqlCdcConfig};

let config = MySqlCdcConfig {
    host: "localhost".to_string(),
    port: 3306,
    username: "replicator".to_string(),
    password: "secret".to_string(),
    server_id: 12345,
    ..Default::default()
};

let mut source = MySqlCdcSource::new(config);
source.open(&ConnectorConfig::default()).await?;

while let Some(batch) = source.poll_batch(1000).await? {
    println!("Received {} rows", batch.num_rows());
}

Implementations

impl MySqlCdcSource

pub fn new(config: MySqlCdcConfig) -> Self

Creates a new MySQL CDC source with the given configuration.

pub fn from_config(config: &ConnectorConfig) -> Result<Self, ConnectorError>

Creates a MySQL CDC source from a generic connector config.

Errors

Returns error if required configuration keys are missing.

pub fn cached_table_count(&self) -> usize

Returns the number of cached table schemas.

pub fn position(&self) -> Option<&BinlogPosition>

Returns the current binlog position.

pub fn gtid_set(&self) -> Option<&GtidSet>

Returns the current GTID set.

pub fn table_cache(&self) -> &TableCache

Returns a reference to the table cache.

pub fn cdc_metrics(&self) -> &MySqlCdcMetrics

Returns a reference to the metrics.

pub fn should_include_table(&self, database: &str, table: &str) -> bool

Checks if a table should be included based on filters.

pub fn config(&self) -> &MySqlCdcConfig

Returns the configuration.

pub fn is_connected(&self) -> bool

Returns whether the source is connected.

pub fn restore_position(&mut self, checkpoint: &SourceCheckpoint)

Restores the position from a checkpoint.

Parses the checkpoint offset to extract GTID set or file/position.

pub fn create_checkpoint(&self) -> SourceCheckpoint

Creates a checkpoint representing the current position.

pub fn flush_events( &mut self, table_info: &TableInfo, ) -> Result<Option<RecordBatch>, ConnectorError>

Flushes buffered events to a RecordBatch.

Errors

Returns error if batch conversion fails.

Trait Implementations

impl Debug for MySqlCdcSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SourceConnector for MySqlCdcSource

fn open<'life0, 'life1, 'async_trait>( &'life0 mut self, config: &'life1 ConnectorConfig, ) -> Pin<Box<dyn Future<Output = Result<(), ConnectorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Opens the connector and initializes the connection.

fn poll_batch<'life0, 'async_trait>( &'life0 mut self, max_records: usize, ) -> Pin<Box<dyn Future<Output = Result<Option<SourceBatch>, ConnectorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Polls for the next batch of records.

fn schema(&self) -> SchemaRef

Returns the schema of records produced by this source.

fn checkpoint(&self) -> SourceCheckpoint

Creates a checkpoint of the current source position.

fn restore<'life0, 'life1, 'async_trait>( &'life0 mut self, checkpoint: &'life1 SourceCheckpoint, ) -> Pin<Box<dyn Future<Output = Result<(), ConnectorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Restores the source to a previously checkpointed position.

fn health_check(&self) -> HealthStatus

Returns the current health status of the connector.

fn metrics(&self) -> ConnectorMetrics

Returns current metrics from the connector.

fn data_ready_notify(&self) -> Option<Arc<Notify>>

Returns a [Notify] handle that is signalled when new data is available.

fn close<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), ConnectorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Closes the connector and releases all resources.

fn as_schema_provider(&self) -> Option<&dyn SchemaProvider>

Returns this connector as a SchemaProvider, if supported.

fn as_schema_inferable(&self) -> Option<&dyn SchemaInferable>

Returns this connector as a SchemaInferable, if supported.

fn as_schema_registry_aware(&self) -> Option<&dyn SchemaRegistryAware>

Returns this connector as a SchemaRegistryAware, if supported.

fn as_schema_evolvable(&self) -> Option<&dyn SchemaEvolvable>

Returns this connector as a SchemaEvolvable, if supported.

fn supports_replay(&self) -> bool

Whether this source supports replay from a checkpointed position.

fn checkpoint_requested(&self) -> Option<Arc<AtomicBool>>

Returns a shared flag that the source sets to true when it requests an immediate checkpoint.