MySQL Driver

The MySQL Driver enables data synchronization from MySQL to your desired destination.

Below is an overview of the supported modes and writers for MySQL data replication, along with tables summarizing the details.

Supported Modes

Our replication process supports various modes to fit different data ingestion needs.

The Full Refresh mode retrieves the entire dataset from MySQL and is ideal for initial data loads or when a complete dataset copy is required.

In contrast, CDC (Change Data Capture) continuously tracks and synchronizes incremental changes in real time, making sure that your destination remains updated with minimal latency.

The Incremental mode is currently under development (WIP).

Mode	Description
Full Refresh	Fetches the complete dataset from MySQL.
CDC (Change Data Capture)	Tracks and syncs incremental changes from MySQL in real time.
Incremental	No, WIP

Supported Writers

OLake replicates data to multiple destinations to cater to a variety of deployment scenarios.

Whether you're storing data locally for quick access or using cloud storage services like S3 for scalability, our system is designed to integrate seamlessly.

We are also working on adding support for Iceberg to facilitate advanced analytics and data lake management.

Destination	Supported	Docs
Local Filesystem	Yes	Link
S3	Yes	Link
Iceberg	WIP	Link

Setup and Configuration

To run the MySQL Driver, configure the following files with your specific credentials and settings:

• config.json: MySQL connection details.
• catalog.json: List of collections and fields to sync (generated using the Discover command).
• write.json: Configuration for the destination where the data will be written.

Place these files in your project directory before running the commands.

Config File

Add MySQL credentials in following format in config.json file as shown here.

Commands

Discover Command

The Discover command generates json content for catalog.json file, which defines the schema of the collections to be synced.

Usage

To run the Discover command, use the following syntax

OLake Docker

macOS / Linux

docker run \
  -v "$HOME/PATH_TO_OLAKE_DIRECTORY:/mnt/config" \
  olakego/source-mysql:latest \
  discover \
  --config /mnt/config/config.json

CMD

docker run ^
  -v "%USERPROFILE%\PATH_TO_OLAKE_DIRECTORY:/mnt/config" ^
  olakego/source-mysql:latest ^
  discover ^
  --config /mnt/config/config.json

Powershell

docker run `
  -v "$env:USERPROFILE\PATH_TO_OLAKE_DIRECTORY:/mnt/config" `
  olakego/source-mysql:latest `
  discover `
  --config /mnt/config/config.json

Locally run OLake

macOS / Linux

OLAKE_BASE_PATH="$HOME/PATH_TO_OLAKE_DIRECTORY/olake/drivers/mysql/config" && \
./build.sh driver-mysql discover \
  --config "$OLAKE_BASE_PATH/config.json"

CMD

set "OLAKE_BASE_PATH=%USERPROFILE%\PATH_TO_OLAKE_DIRECTORY\olake\drivers\mysql\config" && ^
./build.sh driver-mysql discover ^
  --config "%OLAKE_BASE_PATH%\config.json"

Powershell

$OLAKE_BASE_PATH = "$env:USERPROFILE\PATH_TO_OLAKE_DIRECTORY\olake\drivers\mysql\config"; `
./build.sh driver-mysql discover `
  --config "$OLAKE_BASE_PATH\config.json"

info

PATH_TO_OLAKE_DIRECTORY is the absolute path where you have created the directory [as discussed above]. -v "$HOME/PATH_TO_OLAKE_DIRECTORY:/mnt/config" \ maps to -v /Users/JOHN_DOE_USERNAME/Desktop/projects/olake-docker:/mnt/config \ in macOS and Linux systems. Follow the same pattern in other systems.

Catalog File

After executing the Discover command, a catalog.json file is created. Read more about Catalog File here.

Writer File

Read about about

1. Apache Iceberg Writer config
2. S3 writer here
3. local writer

Sync Command

The Sync command fetches data from MySQL and ingests it into the destination.

OLake Docker

macOS / Linux

docker run \
  -v "$HOME/PATH_TO_OLAKE_DIRECTORY:/mnt/config" \
  olakego/source-mysql:latest \
  sync \
  --config /mnt/config/config.json \
  --catalog /mnt/config/catalog.json \
  --destination /mnt/config/writer.json

CMD

docker run ^
  -v "%USERPROFILE%\PATH_TO_OLAKE_DIRECTORY:/mnt/config" ^
  olakego/source-mysql:latest ^
  sync ^
  --config /mnt/config/config.json ^
  --catalog /mnt/config/catalog.json ^
  --destination /mnt/config/writer.json

Powershell

docker run `
  -v "$env:USERPROFILE\PATH_TO_OLAKE_DIRECTORY:/mnt/config" `
  olakego/source-mysql:latest `
  sync `
  --config /mnt/config/config.json `
  --catalog /mnt/config/catalog.json `
  --destination /mnt/config/writer.json

Locally run OLake

macOS / Linux

OLAKE_BASE_PATH="$HOME/PATH_TO_OLAKE_DIRECTORY/olake/drivers/mysql/config" && \
./build.sh driver-mysql sync \
  --config "$OLAKE_BASE_PATH/config.json" \
  --catalog "$OLAKE_BASE_PATH/catalog.json" \
  --destination "$OLAKE_BASE_PATH/writer.json"

CMD

set "OLAKE_BASE_PATH=%USERPROFILE%\PATH_TO_OLAKE_DIRECTORY\olake\drivers\mysql\config" && ^
./build.sh driver-mysql sync ^
  --config "%OLAKE_BASE_PATH%\config.json" ^
  --catalog "%OLAKE_BASE_PATH%\catalog.json" ^
  --destination "%OLAKE_BASE_PATH%\writer.json"

Powershell

$OLAKE_BASE_PATH = "$env:USERPROFILE\PATH_TO_OLAKE_DIRECTORY\olake\drivers\mysql\config"; `
./build.sh driver-mysql sync `
  --config "$OLAKE_BASE_PATH\config.json" `
  --catalog "$OLAKE_BASE_PATH\catalog.json" `
  --destination "$OLAKE_BASE_PATH\writer.json"

To run sync with state:

OLake Docker

macOS / Linux

docker run \
  -v "$HOME/PATH_TO_OLAKE_DIRECTORY:/mnt/config" \
  olakego/source-mysql:latest \
  sync \
  --config /mnt/config/config.json \
  --catalog /mnt/config/catalog.json \
  --destination /mnt/config/writer.json \
  --state /mnt/config/state.json

CMD

docker run ^
  -v "%USERPROFILE%\PATH_TO_OLAKE_DIRECTORY:/mnt/config" ^
  olakego/source-mysql:latest ^
  sync ^
  --config /mnt/config/config.json ^
  --catalog /mnt/config/catalog.json ^
  --destination /mnt/config/writer.json ^
  --state /mnt/config/state.json

Powershell

docker run `
  -v "$env:USERPROFILE\PATH_TO_OLAKE_DIRECTORY:/mnt/config" `
  olakego/source-mysql:latest `
  sync `
  --config /mnt/config/config.json `
  --catalog /mnt/config/catalog.json `
  --destination /mnt/config/writer.json `
  --state /mnt/config/state.json

Locally run OLake

macOS / Linux

OLAKE_BASE_PATH="$HOME/PATH_TO_OLAKE_DIRECTORY/olake/drivers/mysql/config" && \
./build.sh driver-mysql sync \
  --config "$OLAKE_BASE_PATH/config.json" \
  --catalog "$OLAKE_BASE_PATH/catalog.json" \
  --destination "$OLAKE_BASE_PATH/writer.json" \
  --state "$OLAKE_BASE_PATH/state.json"

CMD

set "OLAKE_BASE_PATH=%USERPROFILE%\PATH_TO_OLAKE_DIRECTORY\olake\drivers\mysql\config" && ^
./build.sh driver-mysql sync ^
  --config "%OLAKE_BASE_PATH%\config.json" ^
  --catalog "%OLAKE_BASE_PATH%\catalog.json" ^
  --destination "%OLAKE_BASE_PATH%\writer.json" ^
  --state "%OLAKE_BASE_PATH%\state.json"

Powershell

$OLAKE_BASE_PATH = "$env:USERPROFILE\PATH_TO_OLAKE_DIRECTORY\olake\drivers\mysql\config"; `
./build.sh driver-mysql sync `
  --config "$OLAKE_BASE_PATH\config.json" `
  --catalog "$OLAKE_BASE_PATH\catalog.json" `
  --destination "$OLAKE_BASE_PATH\writer.json" `
  --state "$OLAKE_BASE_PATH\state.json"

Find more about state file and its configuration here.

Changelog

Expand to review

Version	Date	Pull Request	Subject