Merge pull request #149 from JekaKey/mysqlRoutines

Allow dumping procedures and functions with mysqldump

Author: sebastianfeldmann

doc/config/source/mysqldump.json

@@ -15,6 +15,7 @@
     "compress": true,
     "extendedInsert": true,
     "hexBlob": true,
+    "routines": true,
     "gtidPurged": "AUTO",
     "pathToMysqldump": "/path/to/custom/bin"
   }

doc/config/source/mysqldump.xml

@@ -42,6 +42,9 @@
   <!-- optional, default=false -->
   <option name="hexBlob" value="true" />
 
+  <!-- optional, default=false -->
+  <option name="routines" value="true" />
+
   <!-- optional, default=none, accepted=ON,OFF,AUTO -->
   <option name="gtidPurged" value="ON" />
 

src/Backup/Source/Mysqldump.php

@@ -161,6 +161,14 @@ class Mysqldump extends SimulatorExecutable implements Simulator
      */
     private $gtidPurged;
 
+    /**
+     * Dump procedures and functions.
+     * --routines
+     *
+     * @var string
+     */
+    private $routines;
+
     /**
      * Setup.
      *
@@ -186,6 +194,7 @@ public function setup(array $conf = [])
         $this->extendedInsert    = Util\Str::toBoolean(Util\Arr::getValue($conf, 'extendedInsert', ''), false);
         $this->noData            = Util\Str::toBoolean(Util\Arr::getValue($conf, 'noData', ''), false);
         $this->filePerTable      = Util\Str::toBoolean(Util\Arr::getValue($conf, 'filePerTable', ''), false);
+        $this->routines          = Util\Str::toBoolean(Util\Arr::getValue($conf, 'routines', ''), false);
 
         // this doesn't fail, but it doesn't work, so throw an exception so the user understands
         if ($this->filePerTable && count($this->structureOnly)) {
@@ -259,6 +268,7 @@ protected function createExecutable(Target $target) : Executable
                    ->ignoreTables($this->ignoreTables)
                    ->produceFilePerTable($this->filePerTable)
                    ->dumpNoData($this->noData)
+                   ->dumpRoutines($this->routines)
                    ->dumpStructureOnly($this->structureOnly)
                    ->dumpTo($this->getDumpTarget($target));
         // if compression is active and commands can be piped

src/Cli/Executable/Mysqldump.php

@@ -156,6 +156,14 @@ class Mysqldump extends Abstraction implements Executable
      */
     private $hexBlob = false;
 
+    /**
+     * Dump routines.
+     * --routines
+     *
+     * @var boolean
+     */
+    private $routines = false;
+
     /**
      * Path to dump file
      *
@@ -375,6 +383,18 @@ public function produceFilePerTable(bool $bool) : Mysqldump
         return $this;
     }
 
+    /**
+     * Dump procedures and functions.
+     *
+     * @param  bool $bool
+     * @return \phpbu\App\Cli\Executable\Mysqldump
+     */
+    public function dumpRoutines(bool $bool) : Mysqldump
+    {
+        $this->routines = $bool;
+        return $this;
+    }
+
     /**
      * Pipe compressor.
      *
@@ -421,6 +441,7 @@ protected function createCommandLine() : CommandLine
         $cmd->addOptionIfNotEmpty('-e', $this->extendedInsert, false);
         $cmd->addOptionIfNotEmpty('--hex-blob', $this->hexBlob, false);
         $cmd->addOptionIfNotEmpty('--set-gtid-purged', $this->gtidPurged);
+        $cmd->addOptionIfNotEmpty('--routines', $this->routines, false);
 
         $this->configureSourceData($cmd);
         $this->configureIgnoredTables($cmd);