Download the PHP package spatie/db-dumper without Composer

Dump the contents of a database

This repo contains an easy to use class to dump a database using PHP. Currently MySQL, PostgreSQL, SQLite and MongoDB are supported. Behind the scenes mysqldump, pg_dump, sqlite3 and mongodump are used.

Here are simple examples of how to create a database dump with different drivers:

MySQL

PostgreSQL

SQLite

⚠️ Sqlite version 3.32.0 is required when using the includeTables option.

MongoDB

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Requirements

For dumping MySQL-db's mysqldump should be installed.

For dumping PostgreSQL-db's pg_dump should be installed.

For dumping SQLite-db's sqlite3 should be installed.

For dumping MongoDB-db's mongodump should be installed.

For compressing dump files, gzip and/or bzip2 should be installed.

Installation

You can install the package via composer:

Usage

This is the simplest way to create a dump of a MySql db:

If you're working with PostgreSQL just use that dumper, most methods are available on both the MySql. and PostgreSql-dumper.

If the mysqldump (or pg_dump) binary is installed in a non default location you can let the package know by using thesetDumpBinaryPath()-function:

If your application is deployed and you need to change the host (default is 127.0.0.1), you can add the setHost()-function:

Handling AUTO_INCREMENT Values in Dumps

When creating a database dump, you might need to control the inclusion of AUTO_INCREMENT values. This can be crucial for avoiding primary key conflicts or for maintaining ID consistency when transferring data across environments.

Skipping AUTO_INCREMENT Values

To omit the AUTO_INCREMENT values from the tables in your dump, use the skipAutoIncrement method. This is particularly useful to prevent conflicts when importing the dump into another database where those specific AUTO_INCREMENT values might already exist, or when the exact values are not relevant.

Including AUTO_INCREMENT values in the dump

By default, the AUTO_INCREMENT values are included in the dump. However, if you previously used the skipAutoIncrement method and wish to ensure that the AUTO_INCREMENT values are included in a subsequent dump, use the dontSkipAutoIncrement method to explicitly include them.

Use a Database URL

In some applications or environments, database credentials are provided as URLs instead of individual components. In this case, you can use the setDatabaseUrl method instead of the individual methods.

When providing a URL, the package will automatically parse it and provide the individual components to the applicable dumper.

For example, if you provide the URL mysql://username:password@hostname:3306/dbname, the dumper will use the hostname host, running on port 3306, and will connect to dbname with username and password.

Dump specific tables

Using an array:

Using a string:

Don't use column_statics table with some old version of MySql service.

In order to use "--column-statistics=0" as option in mysqldump command you can use doNotUseColumnStatistics() method.

If you have installed mysqldump 8, it queries by default _columnstatics table in _informationschema database. In some old version of MySql (service) like 5.7, this table doesn't exist. So you could have an exception during the execution of mysqldump. To avoid this, you could use doNotUseColumnStatistics() method.

Excluding tables from the dump

You can exclude tables from the dump by using an array:

Or by using a string:

Do not write CREATE TABLE statements that create each dumped table

You can use doNotCreateTables to prevent writing create statements.

Do not write row data

You can use doNotDumpData to prevent writing row data.

Adding extra options

If you want to add an arbitrary option to the dump command you can use addExtraOption

If you're working with MySql you can set the database name using --databases as an extra option. This is particularly useful when used in conjunction with the --add-drop-database mysqldump option (see the mysqldump docs).

With MySql, you also have the option to use the --all-databases extra option. This is useful when you want to run a full backup of all the databases in the specified MySQL connection.

Please note that using the ->addExtraOption('--databases dbname') or ->addExtraOption('--all-databases') will override the database name set on a previous ->setDbName() call.

Using compression

If you want the output file to be compressed, you can use a compressor class.

There are two compressors that come out of the box:

• GzipCompressor - This will compress your db dump with gzip. Make sure gzip is installed on your system before using this.
• Bzip2Compressor - This will compress your db dump with bzip2. Make sure bzip2 is installed on your system before using this.

Creating your own compressor

You can create you own compressor implementing the Compressor interface. Here's how that interface looks like:

The useCommand should simply return the compression command the db dump will get pumped to. Here's the implementation of GzipCompression.

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Freek Van der Herten
• All Contributors

Initial PostgreSQL support was contributed by Adriano Machado. SQlite support was contributed by Peter Matseykanets.

License

The MIT License (MIT). Please see License File for more information.