Sanitize the database by removing or obfuscating user data.
Commandfiles may add custom operations by implementing:
@hook on-event sql-sanitize-confirms. Display summary to user before confirmation.
@hook post-command sql-sanitize. Run queries or call APIs to perform sanitizing
Several working commandfiles may be found at https://github.com/drush-ops/drush/tree/11.x/src/Drupal/Commands/sql
drush sql:sanitize --sanitize-password=no. Sanitize database without modifying any passwords.
drush sql:sanitize --allowlist-fields=field_biography,field_phone_number. Sanitizes database but exempts two user fields from modification.
- --whitelist-fields[=WHITELIST-FIELDS]. Deprecated. Use allowlist-fields instead.
- --allowlist-fields[=ALLOWLIST-FIELDS]. A comma delimited list of fields exempt from sanitization.
- --sanitize-email[=SANITIZE-EMAIL]. The pattern for test email addresses in the sanitization operation, or no to keep email addresses unchanged. May contain replacement patterns %uid, %mail or %name. [default: email@example.com]
- --sanitize-password[=SANITIZE-PASSWORD]. By default, passwords are randomized. Specify no to disable that. Specify any other value to set all passwords to that value.
- -v|vv|vvv, --verbose. Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
- -y, --yes. Auto-accept the default for all user prompts. Equivalent to --no-interaction.
- -l, --uri=URI. A base URL for building links and selecting a multi-site. Defaults to https://default.
- To see all global options, run
drush topicand pick the first choice.
- Drush hooks. (docs:hooks)
- An argument or option with square brackets is optional.
- Any default value is listed at end of arg/option description.
- An ellipsis indicates that an argument accepts multiple values separated by a space.