PHP MySQLDump: Dump MySQL database contents like mysqldump tool

Recommend this page to a friend!
  Info   Documentation   View files (16)   Download .zip   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 170 All time: 8,610 This week: 257
Version License PHP version Categories
mysqldump-php 1.0.0Custom (specified...5PHP 5, Databases
Description Author

This package can dump MySQL database contents like mysqldump tool.

It can access a give MySQL database using PDO and generate a file with SQL statements to recreate that database when those statements are executed by the mysql command.

The package provides several types of options to control the MySQL dump output like:

- Specify the list of tables to include or exclude from the database dump
- Compress the output by generating optimized SQL
- Add statements to drop the database, tables, or triggers or add locks before recreating the database
- Generate complete INSERT statements
- Output blobs in hexadecimal for faster output
- Avoid generating create table statements
- Lock tables
- Use a single transaction
- Defining a condition to match the rows of the tables to output
- Etc.

Picture of Niko
  Performance   Level  
Name: Niko <contact>
Classes: 7 packages by
Country: Finland Finland
Age: ???
All time rank: 31526 in Finland Finland
Week rank: 713 2 in Finland Finland
Innovation award
Innovation award
Nominee: 4x

Winner: 1x


PHP: Mysql Dumper

Mysql Dumper is the only library that supports: * Output binary blobs as hex. * Resolves view dependencies (using Stand-In tables). * Dumps stored procedures. * Dumps events. * Does extended-insert and/or complete-insert. * Supports virtual columns from MySQL 5.7.


  • PHP 7.0.0 or newer
  • MySQL 5.4.0 or newer
  • PDO


Using Composer:

$ composer require niko9911/mysqldump-php:1.*

Or via json file:

"require": {

Using Curl to always download and decompress the latest release:

$ curl --silent --location | grep -i tarball_url | head -n 1 | cut -d '"' -f 4 | xargs curl --location --silent | tar xvz

Getting started

With Autoloader/Composer:


use Niko9911\MysqlDump\Dump;

try {
    $dump = new Dump('mysql:host=localhost;dbname=testdb', 'username', 'password');
} catch (\Exception $e) {
    echo 'Error: ' . $e->getMessage();

Refer to the wiki for some examples and a comparision between mysqldump and mysqldump-php dumps.

Constructor and default parameters

 * Constructor of Mysqldump. Note that in the case of an SQLite database
 * connection, the filename must be in the $db parameter.
 * @param string $dsn        PDO DSN connection string
 * @param string $user       SQL account username
 * @param string $pass       SQL account password
 * @param array  $dumpSettings SQL database settings
 * @param array  $pdoSettings  PDO configured attributes
public function __construct(
    $dsn = '',
    $user = '',
    $pass = '',
    $dumpSettings = array(),
    $pdoSettings = array()

$dumpSettingsDefault = array(
    'include-tables' => array(),
    'exclude-tables' => array(),
    'compress' => Mysqldump::NONE,
    'init_commands' => array(),
    'no-data' => array(),
    'reset-auto-increment' => false,
    'add-drop-database' => false,
    'add-drop-table' => false,
    'add-drop-trigger' => true,
    'add-locks' => true,
    'complete-insert' => false,
    'databases' => false,
    'default-character-set' => Mysqldump::UTF8,
    'disable-keys' => true,
    'extended-insert' => true,
    'events' => false,
    'hex-blob' => true, /faster than escaped content/
    'net_buffer_length' => self::MAXLINESIZE,
    'no-autocommit' => true,
    'no-create-info' => false,
    'lock-tables' => true,
    'routines' => false,
    'single-transaction' => true,
    'skip-triggers' => false,
    'skip-tz-utc' => false,
    'skip-comments' => false,
    'skip-dump-date' => false,
    'skip-definer' => false,
    'where' => '',
    'disable-foreign-keys-check' => true

$pdoSettingsDefaults = array(

// missing settings in constructor will be replaced by default options
$this->_pdoSettings = self::array_replace_recursive($pdoSettingsDefault, $pdoSettings);
$this->_dumpSettings = self::array_replace_recursive($dumpSettingsDefault, $dumpSettings);

Dump Settings

  • include-tables - Only include these tables (array of table names), include all if empty
  • exclude-tables - Exclude these tables (array of table names), include all if empty, supports regexps
  • compress - Gzip, Bzip2, None. - Could be specified using the declared consts: IMysqldump\Mysqldump::GZIP, IMysqldump\Mysqldump::BZIP2 or IMysqldump\Mysqldump::NONE
  • reset-auto-increment - Removes the AUTO_INCREMENT option from the database definition - Useful when used with no-data, so when db is recreated, it will start from 1 instead of using an old value
  • add-drop-database -
  • add-drop-table -
  • add-drop-triggers -
  • add-locks -
  • complete-insert -
  • databases -
  • default-character-set - utf8 (default, compatible option), utf8mb4 (for full utf8 compliance) - Could be specified using the declared consts: IMysqldump\Mysqldump::UTF8 or IMysqldump\Mysqldump::UTF8MB4BZIP2 - -
  • disable-keys -
  • events -
  • extended-insert -
  • hex-blob -
  • lock-tables -
  • net_buffer_length -
  • no-autocommit - Option to disable autocommit (faster inserts, no problems with index keys) -
  • no-create-info -
  • no-data - - Do not dump data for these tables (array of table names), support regexps, `true` to ignore all tables
  • routines -
  • single-transaction -
  • skip-comments -
  • skip-dump-date -
  • skip-triggers -
  • skip-tz-utc -
  • skip-definer -
  • where -

The following options are now enabled by default, and there is no way to disable them since they should always be used.

  • disable-foreign-keys-check -

PDO Settings



To dump a database, you need the following privileges :

  • SELECT - In order to dump table structures and data.
  • SHOW VIEW - If any databases has views, else you will get an error.
  • TRIGGER - If any table has one or more triggers.
  • LOCK TABLES - If "lock tables" option was enabled.

Use SHOW GRANTS FOR user@host; to know what privileges user has. See the following link for more information:

Which are the minimum privileges required to get a backup of a MySQL database schema?


GitLab CI & Automatic Deployment to Composer


Format all code to PHP-FIG standards.


This project is open-sourced software licensed under the GPL license For commercial licenses, please contact niko-at-ironlions-dot-fi.


After more than 8 years, there is barely anything left from the original source code, but:

Originally based on James Elliott's script from 2009.

Adapted and extended by Michael J. Calkins.

Rewrite based on from Diego Torres.

Currently maintained, developed and improved by Niko Granö.

File Role Description
src (1 file, 2 directories)
.php_cs Data Auxiliary data Data Auxiliary data
composer.json Data Auxiliary data
LICENSE Lic. License text Doc. Read me

  Files  /  src  
File Role Description
Compress (5 files)
TypeAdapter (5 files)
   Dump.php Class Class source

  Files  /  src  /  Compress  
File Role Description
   Bzip2.php Class Class source
   Gzip.php Class Class source
   ManagerFactory.php Class Class source
   Method.php Class Class source
   None.php Class Class source

  Files  /  src  /  TypeAdapter  
File Role Description
   AbstractTypeAdapter.php Class Class source
   Factory.php Class Class source
   Mysql.php Class Class source
   Type.php Class Class source
   TypeAdapter.php Class Class source

 Version Control Unique User Downloads Download Rankings  
This week:0
All time:8,610
This week:257

For more information send a message to info at phpclasses dot org.