Merge pull request #3 from wysiwyg-software-design/master

new Mysql-Database Dump Step

Author: breadlesscode

Classes/Step/MysqlDatabaseExportStep.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Breadlesscode\Backups\Step;
+
+use Neos\Flow\Annotations as Flow;
+
+class MysqlDatabaseExportStep extends StepAbstract
+{
+    /**
+     * Folder name in backup file
+     *
+     * @var string
+     */
+    protected $name = 'MySqlDatabaseExport';
+
+    /**
+     * @Flow\InjectConfiguration(path="persistence.backendOptions", package="Neos.Flow")
+     * @var array
+     */
+    protected $dbConfig;
+
+    public function backup(): bool
+    {
+        $mysqlDumpPath = $this->config['mysqlDumpBinPath'] ?? 'mysqldump';
+        $mysqlDumpOptions = $this->config['mysqlDumpOptions'] ?? [];
+
+        $command = vsprintf('%s -h %s -u %s -p%s %s %s 2>/dev/null 1> %s', [
+            $mysqlDumpPath,
+            escapeshellarg($this->dbConfig['host']),
+            escapeshellarg($this->dbConfig['user']),
+            escapeshellarg($this->dbConfig['password']),
+            escapeshellarg($this->dbConfig['dbname']),
+            implode(' ', $mysqlDumpOptions),
+            $this->getFilenameForBackup()
+        ]);
+
+        exec($command);
+
+        return true;
+    }
+
+    public function restore(): bool
+    {
+        $mysqlPath = $this->config['mysqlBinPath'] ?? 'mysql';
+
+        $command = vsprintf('%s -h %s -u %s -p%s %s 2>/dev/null < %s', [
+            $mysqlPath,
+            escapeshellarg($this->dbConfig['host']),
+            escapeshellarg($this->dbConfig['user']),
+            escapeshellarg($this->dbConfig['password']),
+            escapeshellarg($this->dbConfig['dbname']),
+            $this->getFilenameForBackup()
+        ]);
+
+        exec($command);
+
+        return true;
+    }
+
+    public function getRestoreWarning(): ?string
+    {
+        return 'The database "' . $this->dbConfig['dbname'] . '" will be overwritten:' . PHP_EOL;
+    }
+
+    protected function getFilenameForBackup(): string
+    {
+        $backupPath = $this->getBackupStepPath();
+        return $backupPath . '/' . $this->dbConfig['dbname'] . '.sql';
+    }
+}

Classes/Step/MysqlTableExportStep.php

@@ -21,17 +21,19 @@ class MysqlTableExportStep extends StepAbstract
     public function backup(): bool
     {
         $mysqlDumpPath = $this->config['mysqlDumpBinPath'] ?? 'mysqldump';
+        $mysqlDumpOptions = $this->config['mysqlDumpOptions'] ?? [];
         $backupPath = $this->getBackupStepPath();
 
         foreach ($this->config['tables'] as $table) {
             $outputFileName = $backupPath.'/'.$table.'.sql';
-            $command = vsprintf('%s -h %s -u %s -p%s %s %s 2>/dev/null 1> %s', [
+            $command = vsprintf('%s -h %s -u %s -p%s %s %s %s 2>/dev/null 1> %s', [
                 $mysqlDumpPath,
                 escapeshellarg($this->dbConfig['host']),
                 escapeshellarg($this->dbConfig['user']),
                 escapeshellarg($this->dbConfig['password']),
                 escapeshellarg($this->dbConfig['dbname']),
                 $table,
+                implode(' ', $mysqlDumpOptions),
                 $outputFileName
             ]);
             exec($command);

Documentation/steps.md

@@ -3,6 +3,7 @@
 * [File/Directory copy step](#file-directory-copy-step)
 * [Site export step](#site-export-step)
 * [MySQL table export step](#mysql-table-export-step)
+* [MySQL database export step](#mysql-database-export-step)
 
 
 ## File export step
@@ -45,3 +46,20 @@ Breadlesscode:
         tables:
           - neos_flow_security_account
 ```
+
+## MySQL database export step
+
+This step exports a whole MySql-Database via the `mysqldump`-Binary.
+
+Example configuration:
+```yaml
+Breadlesscode:
+  Backups:
+    steps:
+      'Breadlesscode\Backups\Step\MysqlDatabaseExportStep':
+        mysqlDumpBinPath: 'mysqldump'
+        mysqlBinPath: 'mysql'
+        mysqlDumpOptions:
+          - --single-transaction
+          - --skip-extended-insert
+```