Replication API Function Reference

All functions in the Binlog/Replication API are defined in include/mariadb_rpl.h

The Binlog/Replication API provides a low‑level interface for consuming and processing binary log events from a MariaDB server. It allows applications to configure replication handles, open streams, fetch and decode events, and manage errors.

Together, these functions enable developers to build custom replication clients and event processing tools.

Function Overview

Function

Description

mariadb_rpl_init()

Allocates and initializes a replication handle

mariadb_rpl_optionsv()

Sets options on a replication handle

mariadb_rpl_get_optionsv()

Retrieves the current value of a replication handle option

mariadb_rpl_open()

Opens a binary log stream and registers the client as a replica

mariadb_rpl_fetch()

Fetches the next event from a binary log stream

mariadb_free_rpl_event()

Frees memory allocated for an event

mariadb_rpl_extract_rows()

Extracts a list of rows from a row event

mariadb_rpl_errno()

Returns the error number for the last Binlog API call

mariadb_rpl_error()

Returns the error message for the last Binlog API call

mariadb_rpl_close()

Closes a binary log stream and frees the replication handle