smile/gdpr-dump

A utility to create anonymized database dumps

5.0.5 2025-04-05 12:27 UTC

Requires

• php: ^8.1
• composer-runtime-api: ^2.0
• ext-json: *
• ext-pdo: *
• doctrine/dbal: ^3.1
• druidfi/mysqldump-php: ^1.1
• fakerphp/faker: ^1.17
• justinrainbow/json-schema: ^5.3
• symfony/config: ^6.1
• symfony/console: ^6.1
• symfony/dependency-injection: ^6.1
• symfony/event-dispatcher: ^6.1
• symfony/finder: ^6.1
• symfony/yaml: ^6.1
• theseer/tokenizer: ^1.2

Requires (Dev)

• php-parallel-lint/php-parallel-lint: ^1.4
• phpstan/phpstan: ^2.0
• phpstan/phpstan-phpunit: ^2.0
• phpunit/phpunit: ^10.5
• slevomat/coding-standard: ^8.15
• squizlabs/php_codesniffer: ^3.11

GPL-3.0-or-later

• Smile Technical Direction

README

This tool provides a command that dumps the contents of a MySQL database.

It is the equivalent of mysqldump, with additional features, at the cost of performance (PHP implementation). The main purpose of this tool is to create anonymized dumps, in order to comply with GDPR regulations.

Features:

• Data converters (transform the data before it is dumped to the file).
• Recursive table filtering.
• Tables whitelist (only these tables will be included in the dump).
• Tables blacklist (not included in the dump).
• Dump options (compression, output type...).
• Predefined configuration templates (Magento, Drupal, OroCommerce).

Documentation

The documentation (including installation instructions) is available in the wiki.

Community Templates

While it is not the aim of this project to cover each framework, you are encouraged to publish your templates on GitHub under the topic smile-sa-gdpr-dump-template.

Contributing

You can contribute to this module by submitting issues or pull requests.

For more details, please take a look at the contribution guidelines.

License

This project is licensed under the GPLv3 License.

Changelog

All notable changes are recorded in this changelog.