DBdeployer is a tool that deploys MySQL database servers easily. This is a port of MySQL-Sandbox, originally written in Perl, and re-designed from the ground up in Go. See the features comparison for more detail.
Documentation migrated from the original wiki and updated for the ProxySQL maintainership.
New in 2026: ProxySQL provider support — see ProxySQL Integration Guide
- Installation
- Prerequisites
- Initializing the environment
- Updating dbdeployer
- Main operations
- Database users
- Database server flavors
- Getting remote tarballs
- Practical examples
- Standard and non-standard basedir names
- Using short version numbers
- Multiple sandboxes, same version and type
- Using the direct path to the expanded tarball
- Ports management
- Concurrent deployment and deletion
- Replication topologies
- Skip server start
- MySQL Document store, mysqlsh, and defaults.
- Installing MySQL shell
- Database logs management.
- dbdeployer operations logging
- Sandbox customization
- Sandbox management
- Sandbox macro operations
- Sandbox deletion
- Default sandbox
- Using the latest sandbox
- Sandbox upgrade
- Dedicated admin address
- Loading sample data into sandboxes
- Running sysbench
- Obtaining sandbox metadata
- Replication between sandboxes
- Using dbdeployer in scripts
- Importing databases into sandboxes
- Cloning databases
- Compiling dbdeployer
- Generating additional documentation
- Command line completion
- Using dbdeployer source for other projects
- Exporting dbdeployer structure
- Semantic versioning
- Do not edit