dbdeployer

dbdeployer

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.

New Maintainer

As of 2026, dbdeployer is actively maintained by the ProxySQL team, with the blessing of the original creator Giuseppe Maxia. We are grateful for Giuseppe's years of work on this project.

Roadmap:

• Modern MySQL support (8.4 LTS, 9.x Innovation releases)
• ProxySQL and Orchestrator integration as deployment providers
• Provider-based architecture for extensibility
• PostgreSQL support (long-term)

See the Phase 1 milestone for current progress.

Documentation updated for version 1.74.0 (23-Mar-2026)

• Installation
  • Manual installation
  • Installation via script
• Prerequisites
• Initializing the environment
• Updating dbdeployer
• Main operations
  • Overview
  • Unpack
  • Deploy single
  • Deploy multiple
  • Deploy replication
  • Re-deploy a sandbox
• Database users
• Database server flavors
• Getting remote tarballs
  • Looking at the available tarballs
  • Getting a tarball
  • Customizing the tarball list
  • Changing the tarball list permanently
  • From remote tarball to ready to use in one step
  • Guessing the latest MySQL version
• 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
  • dbdeployer global exec
  • dbdeployer global use
• 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
  • a. NDB to NDB
  • b. Group replication to group replication
  • c. Master/slave to master/slave.
  • d. Hybrid replication
  • e. Cloning
• 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