gem-hunter

MyDuck Server unlocks serious power for your MySQL & Postgres analytics. Imagine the simplicity of (MySQL|Postgres)’s familiar interface fused with the raw analytical speed of DuckDB. Now you can supercharge your analytical queries with DuckDB’s lightning-fast OLAP engine, all while using the tools and dialect you know.

• Why MyDuck
• Key Features
• Performance
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Replicating Data
  • Connecting to Cloud MySQL & Postgres
  • HTAP Setup
  • Customizing the Docker Container
  • Query Parquet Files
  • Already Using DuckDB?
  • Backup and Restore with Object Storage
  • LLM Integration
  • Access from Python
• Connect examples
• Roadmap
• Contributing
• Acknowledgements
• License

While MySQL and Postgres are the most popular open-source databases for OLTP, their performance in analytics often falls short. DuckDB, on the other hand, is built for fast, embedded analytical processing. MyDuck Server lets you enjoy DuckDB's high-speed analytics without leaving the (MySQL|Postgres) ecosystem.

With MyDuck Server, you can:

• Set up an isolated, fast, and real-time replica dedicated to ad-hoc analytics, batch jobs, and LLM-generated queries, without exhausting or corrupting your primary database 🔥
• Accelerate existing MySQL & Postgres analytics to new heights through DuckDB's high-speed engine with minimal changes 🚀
• Enable richer & faster connectivity between modern data manipulation & analysis tools and your MySQL & Postgres data 🛠️
• Go beyond MySQL & Postgres syntax with DuckDB's advanced SQL features to expand your analytics potential 🦆
• Run DuckDB in server mode to share a DuckDB instance with your team or among your applications 🌩️
• Build HTAP systems by combining (MySQL|Postgres) for transactions with MyDuck for analytics 🔄
• and much more! See below for a full list of feature highlights.

MyDuck Server isn't here to replace MySQL & Postgres — it's here to help MySQL & Postgres users do more with their data. This open-source project provides a convenient way to integrate high-speed analytics into your workflow while embracing the flexibility and efficiency of DuckDB.

• Blazing Fast OLAP with DuckDB: MyDuck stores data in DuckDB, an OLAP-optimized database known for lightning-fast analytical queries. DuckDB enables MyDuck to execute queries up to 1000x faster than traditional MySQL & Postgres setups, making complex analytics practical that were previously unfeasible.

• MySQL-Compatible Interface: MyDuck implements the MySQL wire protocol and understands MySQL syntax, allowing you to connect with any MySQL client and run MySQL-style SQL. MyDuck automatically translates your queries and executes them in DuckDB.

• Postgres-Compatible Interface: MyDuck implements the Postgres wire protocol, enabling you to send DuckDB SQL directly using any Postgres client. Since DuckDB's SQL dialect closely resembles PostgreSQL, you can speed up existing Postgres queries with minimal changes.

• Raw DuckDB Power: MyDuck provides full access to DuckDB's analytical capabilities through raw DuckDB SQL, including friendly SQL syntax, advanced aggregates, remote data source access, nested data types, and more.

• Zero-ETL: Simply start replication and begin querying! MyDuck can function as a MySQL replica or Postgres standby, replicating data from your primary server in real-time. It works like standard MySQL & Postgres replication - using MySQL's START REPLICA or Postgres' CREATE SUBSCRIPTION commands, eliminating the need for complex ETL pipelines.

• Consistent and Efficient Replication: Thanks to DuckDB's solid ACID support, we've carefully managed transaction boundaries in the replication stream to ensure a consistent data view — you'll never see dirty data mid-transaction. Plus, MyDuck's transaction batching collects updates from multiple transactions and applies them to DuckDB in batches, significantly reducing write overhead (since DuckDB isn’t designed for high-frequency OLTP writes).

• HTAP Architecture Support: MyDuck works well with database proxy tools to enable hybrid transactional/analytical processing setups. You can route DML operations to (MySQL|Postgres) and analytical queries to MyDuck, creating a powerful HTAP architecture that combines the best of both worlds.

• Bulk Upload & Download: MyDuck supports fast bulk data loading from the client side with the standard MySQL LOAD DATA LOCAL INFILE command or the PostgreSQL COPY FROM STDIN command. You can also extract data from MyDuck using the PostgreSQL COPY TO STDOUT command.

• End-to-End Columnar IO: In addition to the traditional row-oriented data transfer in MySQL & Postgres protocol, MyDuck can also send query results and receive data uploads in columnar format, which can be significantly faster for high-volume data. This is implemented on top of the standard Postgres COPY protocol with extended columnar format support, e.g., COPY ... TO STDOUT (FORMAT parquet | arrow), allowing you to use the standard Postgres client library to interact with MyDuck in an optimized way.

• Standalone Mode: MyDuck can run in standalone mode without replication. In this mode, it is a drop-in replacement for (MySQL|Postgres), but with a DuckDB heart. You can CREATE TABLE, transactionally INSERT, UPDATE, and DELETE data, and run blazingly fast SELECT queries.

• DuckDB in Server Mode: If you aren't interested in MySQL & Postgres but just want to share a DuckDB instance with your team or among your applications, MyDuck is also a great solution. You can deploy MyDuck to a server, connect to it with the Postgres client library in your favorite programming language, and start running DuckDB SQL queries directly.

• Seamless Integration with Dump & Copy Utilities: MyDuck plays well with modern MySQL & Postgres data migration tools, especially the MySQL Shell and pg_dump. For MySQL, you can load data into MyDuck in parallel from a MySQL Shell dump, or leverage the Shell’s copy-instance utility to copy a consistent snapshot of your running MySQL server to MyDuck. For Postgres, MyDuck can load data from a pg_dump archive.

Typical OLAP queries can run up to 1000x faster with MyDuck Server compared to MySQL & Postgres alone, especially on large datasets. Under the hood, it's just DuckDB doing what it does best: processing analytical queries at lightning speed. You are welcome to run your own benchmarks and prepare to be amazed! Alternatively, you can refer to well-known benchmarks like the ClickBench and H2O.ai db-benchmark to see how DuckDB performs against other databases and data science tools. Also remember that DuckDB has robust support for transactions, JOINs, and larger-than-memory query processing, which are unavailable in many competing systems and tools.

• Docker (recommended) for setting up MyDuck Server quickly.
• MySQL or PostgreSQL CLI clients for connecting and testing your setup.

Get a standalone MyDuck Server up and running in minutes using Docker:

docker run -p 13306:3306 -p 15432:5432 apecloud/myduckserver:latest

This setup exposes:

• Port 13306 for MySQL wire protocol connections.
• Port 15432 for PostgreSQL wire protocol connections, allowing direct DuckDB SQL.

Connect using any MySQL client to run MySQL-style SQL queries:

mysql -h127.0.0.1 -P13306 -uroot

For full analytical power, connect to the Postgres port and run DuckDB SQL queries directly:

psql -h 127.0.0.1 -p 15432 -U postgres

We have integrated a setup tool in the Docker image that helps replicate data from your primary (MySQL|Postgres) server to MyDuck Server. The tool is available via the SETUP_MODE environment variable. In REPLICA mode, the container will start MyDuck Server, dump a snapshot of your primary (MySQL|Postgres) server, and start replicating data in real-time.

docker run -d --name myduck \
  -p 13306:3306 \ 
  -p 15432:5432 \
  --env=SETUP_MODE=REPLICA \
  --env=SOURCE_DSN="<postgres|mysql>://<user>:<password>@<host>:<port>/<dbname>"
  apecloud/myduckserver:latest

SOURCE_DSN specifies the connection string to the primary database server, which can be either MySQL or PostgreSQL.

• MySQL Primary: Use the mysql URI scheme, e.g.,
  --env=SOURCE_DSN=mysql://root:password@example.com:3306

• PostgreSQL Primary: Use the postgres URI scheme, e.g.,
  --env=SOURCE_DSN=postgres://postgres:password@example.com:5432/db01

MyDuck Server supports setting up replicas from common cloud-based MySQL & Postgres offerings. For more information, please refer to the replica setup guide.

With MyDuck's powerful analytics capabilities, you can create an hybrid transactional/analytical processing system where high-frequency data writes are directed to a standard MySQL or Postgres instance, while analytical queries are handled by a MyDuck Server instance. Follow our HTAP setup instructions to easily set up an HTAP demonstration:

• Provisioning a MySQL HTAP cluster based on ProxySQL or MariaDB MaxScale.
• Provisioning a PostgreSQL HTAP cluster based on PGPool-II

To rename the default database, pass the DEFAULT_DB environment variable to the Docker container:

docker run -d -p 13306:3306 -p 15432:5432 \
    --env=DEFAULT_DB=mydbname \
    apecloud/myduckserver:latest

To set the superuser password, pass the SUPERUSER_PASSWORD environment variable to the Docker container:

docker run -d -p 13306:3306 -p 15432:5432 \
    --env=SUPERUSER_PASSWORD=mysecretpassword \
    apecloud/myduckserver:latest

To initialize MyDuck Server with custom SQL statements, mount your .sql file to either /docker-entrypoint-initdb.d/mysql/ or /docker-entrypoint-initdb.d/postgres/ inside the Docker container, depending on the SQL dialect you're using.

For example:

# Execute `init.sql` via MySQL protocol
docker run -d -p 13306:3306 --name=myduck \
    -v ./init.sql:/docker-entrypoint-initdb.d/mysql/init.sql \
    apecloud/myduckserver:latest

# Execute `init.sql` via PostgreSQL protocol
docker run -d -p 15432:5432 --name=myduck \
    -v ./init.sql:/docker-entrypoint-initdb.d/postgres/init.sql \
    apecloud/myduckserver:latest

Looking to load Parquet files into MyDuck Server and start querying? Follow our Parquet file loading guide for easy setup.

Already have a DuckDB file? You can seamlessly bootstrap MyDuck Server with it. See our DuckDB file bootstrapping guide for more details.

Easily manage multiple databases in MyDuck Server, same as Postgres. For step-by-step instructions and detailed guidance, check out our Database Management Guide.

To back up and restore your databases inside MyDuck Server using object storage, refer to our backup and restore guide for detailed instructions.

MyDuck Server can be integrated with LLM applications via the Model Context Protocol (MCP). Follow the MCP integration guide to set up MyDuck Server as an external data source for LLMs.

MyDuck Server can be seamlessly accessed from the Python data science ecosystem. Follow the Python integration guide to connect to MyDuck Server from Python and export data to PyArrow, pandas, and Polars. Additionally, check out the Ibis integration guide for using the Ibis dataframe API to query MyDuck Server directly.

Short connect snippets for MySQL/Postgres CLI, Python, Node.js, Go, Java, and R are in connect-examples.md.

We have big plans for MyDuck Server! Here are some of the features we’re working on:

• Arrow Flight SQL.
• Multiple DB.
• Authentication.
• ...and more! We’re always looking for ways to make MyDuck Server better. If you have a feature request, please let us know by opening an issue.

Let's connect on Discord to discuss requirements, address issues, and share user experiences.

MyDuck Server is open-source, and we’d love your help to keep it growing! Check out our CONTRIBUTING.md for ways to get involved. From bug reports to feature requests, all contributions are welcome!

MyDuck Server is built on top of a collection of amazing open-source projects, notably:

• DuckDB - The fast in-process analytical database that powers MyDuck Server.
• go-mysql-server - The outstanding MySQL server implementation in Go maintained by DoltHub that MyDuck Server is bulit on. We also draw significant inspiration from Dolt and Doltgres.
• Vitess - Provides the MySQL replication stream used in MyDuck Server.
• duckdb-go: The official Go driver for DuckDB.
• SQLGlot - The ultimate SQL transpiler.

We are grateful to the developers and contributors of these projects for their hard work and dedication to open-source software.

MyDuck Server is released under the Apache License 2.0.