feat: add support for some direct mysqldump options

Author: rafaucau

README.md

@@ -22,6 +22,9 @@ php flarum db:dump ../backups/forum.sql
 # Dump with compression (based on extension)
 php flarum db:dump /backups/dump.sql.gz   # gzip compression
 php flarum db:dump /backups/dump.sql.bz2  # bzip2 compression
+
+# Create backup on live site without locking tables
+php flarum db:dump --all-tablespaces --single-transaction --quick --lock-tables=false
 ```
 
 ### Options
@@ -35,6 +38,9 @@ php flarum db:dump /backups/dump.sql.bz2  # bzip2 compression
 - `--no-column-statistics`: Disable column statistics (for MySQL 8 compatibility)
 - `--binary-path=/path/to/binary`: Custom mysqldump binary location
 
+Additionally, most of the standard mysqldump options are supported (like `--single-transaction`, `--quick`, `--lock-tables`, etc).
+Check mysqldump documentation for available options.
+
 ## Requirements
 
 - `mysqldump` binary

src/DumbDbCommand.php

@@ -18,14 +18,91 @@ class DumbDbCommand extends AbstractCommand
         'bz2' => Bzip2Compressor::class,
     ];
 
+    /**
+     * Inspired by WP-CLI's DB_Command
+     * @see https://github.com/wp-cli/db-command/blob/e9c4e8ab61e99f7fa7e31e584c2b2b5d54d071db/src/DB_Command.php#L1937
+     */
+    private const ALLOWED_MYSQLDUMP_OPTIONS = [
+        'add-drop-table',
+        'add-locks',
+        'allow-keywords',
+        'apply-slave-statements',
+        'bind-address',
+        'character-sets-dir',
+        'comments',
+        'compatible',
+        'compact',
+        'complete-insert',
+        'create-options',
+        'databases',
+        'debug',
+        'debug-check',
+        'debug-info',
+        'default-character-set',
+        'delete-master-logs',
+        'disable-keys',
+        'dump-slave',
+        'events',
+        'extended-insert',
+        'fields-terminated-by',
+        'fields-enclosed-by',
+        'fields-optionally-enclosed-by',
+        'fields-escaped-by',
+        'flush-logs',
+        'flush-privileges',
+        'force',
+        'hex-blob',
+        'host',
+        'insert-ignore',
+        'lines-terminated-by',
+        'lock-all-tables',
+        'lock-tables',
+        'log-error',
+        'master-data',
+        'max-allowed-packet',
+        'net-buffer-length',
+        'no-autocommit',
+        'no-create-db',
+        'no-create-info',
+        'no-set-names',
+        'no-tablespaces',
+        'opt',
+        'order-by-primary',
+        'port',
+        'protocol',
+        'quick',
+        'quote-names',
+        'replace',
+        'routines',
+        'set-charset',
+        'single-transaction',
+        'dump-date',
+        'skip-comments',
+        'skip-opt',
+        'socket',
+        'ssl',
+        'ssl-ca',
+        'ssl-capath',
+        'ssl-cert',
+        'ssl-cipher',
+        'ssl-key',
+        'ssl-verify-server-cert',
+        'tab',
+        'triggers',
+        'tz-utc',
+        'user',
+        'where',
+        'xml',
+    ];
+
     public function __construct(protected Config $config, protected Paths $paths)
     {
         parent::__construct();
     }
 
     protected function configure(): void
     {
-        $this
+        $command = $this
             ->setName('db:dump')
             ->setDescription('Dump the contents of a database')
             ->addArgument(
@@ -81,6 +158,15 @@ protected function configure(): void
                 InputOption::VALUE_NONE,
                 'Do not use column statistics (for MySQL 8 compatibility with older versions)',
             );
+
+        foreach (self::ALLOWED_MYSQLDUMP_OPTIONS as $option) {
+            $command->addOption(
+                $option,
+                null,
+                InputOption::VALUE_OPTIONAL,
+                "Pass --$option to mysqldump",
+            );
+        }
     }
 
     /**
@@ -150,6 +236,17 @@ protected function fire(): int
             $dumper->doNotUseColumnStatistics();
         }
 
+        foreach (self::ALLOWED_MYSQLDUMP_OPTIONS as $option) {
+            $value = $this->input->getOption($option);
+            if ($value !== null) {
+                if ($value === true || $value === '') {
+                    $dumper->addExtraOption("--$option");
+                } else {
+                    $dumper->addExtraOption("--$option=".$value);
+                }
+            }
+        }
+
         try {
             $dumper->dumpToFile($path);
             $this->info("Database dumped successfully to: $path");