wgzhao/addax repository overview

⁠What is Addax?

Addax⁠ is an open-source, universal ETL (Extract, Transform, Load) tool, enabling seamless data synchronization across multiple data sources such as Cassandra, ClickHouse, DBF, Hive, InfluxDB, Kudu, MySQL, Oracle, Presto (Trino), PostgreSQL, and SQL Server.

⁠Getting the Image

The recommended way to use Addax is to pull its prebuilt Docker image from the Docker Hub Registry⁠.

⁠Pull the Latest Image

docker pull wgzhao/addax:latest

⁠How to Use This Image

⁠Start a Job

Run a predefined job available in the container:

docker run -it --rm --name addax wgzhao/addax:latest \
  /opt/addax/bin/addax.sh /opt/addax/job/job.json

⁠Run Your Custom Job

Mount your job configuration file into the container and execute it:

docker run -it --rm --name addax \
  -v <your_job_path>:/opt/addax/job \
  wgzhao/addax:latest \
  /opt/addax/bin/addax.sh /opt/addax/job/<your_job_filename>

⁠Lite vs Full Images

Addax offers two Docker image variants:

• Full Image (latest): Contains all plugins and supports a wide range of SQL and NoSQL data sources.
• Lite Image (latest-lite): Contains only essential plugins, optimized for smaller size and common use cases.

⁠Pull the Lite Image

docker pull wgzhao/addax:latest-lite

⁠Plugins Included in the Lite Image

⁠Reader Plugins

• datareader
• hdfsreader
• hivereader
• mysqlreader
• oraclereader
• postgresqlreader
• rdbmsreader
• sqlitereader
• sqlserverreader
• streamreader
• txtfilereader

⁠Writer Plugins

• hdfswriter
• mysqlwriter
• oraclewriter
• postgresqlwriter
• rdbmswriter
• sqlserverwriter
• streamwriter
• txtfilewriter

⁠Resources

• GitHub Repository: Addax on GitHub⁠
• Offical Documentation: Addax Documentaion⁠

⁠Notes

Replace <your_job_path> and <your_job_filename> with the path and file name of your job configuration file. The lite image is intended for situations where a smaller image is preferred, while the full image provides comprehensive plugin support.