Merge pull request #279 from bemanuel

Features/pgdump njobs

Author: sebastianfeldmann

doc/config/source/pgdump.json

@@ -3,6 +3,7 @@
   "options": {
     "host": "localhost",
     "port": "1234",
+    "jobs": "4",
     "user": "myUserName",
     "password": "topSecret",
     "database": "myDatabaseName",

doc/config/source/pgdump.xml

@@ -6,6 +6,9 @@
   <!-- optional, default none -->
   <option name="port" value="1234" />
 
+  <!-- optional, default none -->
+  <option name="jobs" value="4" />
+
   <!-- optional, default none -->
   <option name="user" value="myUserName" />
 

src/Backup/Source/Pgdump.php

@@ -50,6 +50,15 @@ class Pgdump extends SimulatorExecutable implements Simulator
      */
     private $port;
 
+    /**
+     * Run the dump in parallel by dumping njobs tables simultaneously.
+     * Reduces the time of the dump but it also increases the load on the database server.
+     * --jobs=<NJobs>
+     *
+     * @var int
+     */
+    private $jobs;
+
     /**
      * User to connect with
      * --user=<username>
@@ -236,6 +245,7 @@ private function setupDumpOptions(array $conf)
         $this->noOwner      = Util\Str::toBoolean(Util\Arr::getValue($conf, 'noOwner', ''), false);
         $this->encoding     = Util\Arr::getValue($conf, 'encoding', '');
         $this->format       = Util\Arr::getValue($conf, 'format', self::DEFAULT_FORMAT);
+        $this->jobs         = Util\Arr::getValue($conf, 'jobs', 0);
     }
 
 
@@ -285,6 +295,7 @@ protected function createExecutable(Target $target) : Executable
                    ->dumpNoPrivileges($this->noPrivileges)
                    ->dumpNoOwner($this->noOwner)
                    ->dumpFormat($this->format)
+                   ->dumpJobs($this->jobs)
                    ->dumpTo($target->getPathnamePlain());
         return $executable;
     }

src/Cli/Executable/Pgdump.php

@@ -36,6 +36,13 @@ class Pgdump extends Abstraction implements Executable
      * @var int
      */
     private $port;
+    
+    /**
+    * Run the dump in parallel by dumping njobs tables simultaneously.
+    * --jobs=njobs
+    * @var int
+    */
+    private $jobs;
 
     /**
      * Set SSL mode
@@ -180,7 +187,7 @@ class Pgdump extends Abstraction implements Executable
      * @var string
      */
     private $file;
-
+    
     /**
      * List of available output formats
      *
@@ -260,6 +267,21 @@ public function usePort(int $port) : Pgdump
         return $this;
     }
 
+    /**
+     * Define njobs tables simultaneously..
+     *
+     * @param  int $jobs
+     * @return \phpbu\App\Cli\Executable\Pgdump
+     */
+    public function dumpJobs(int $jobs): Pgdump
+    {
+        if ($jobs < 0) {
+            throw new Exception('invalid jobs value');
+        }
+        $this->jobs = $jobs;
+        return $this;
+    }
+
     /**
      * Set the sslmode
      *
@@ -501,6 +523,7 @@ protected function createCommandLine() : CommandLine
         $cmd->addOptionIfNotEmpty('--username', $this->user);
         $cmd->addOptionIfNotEmpty('--host', $this->host);
         $cmd->addOptionIfNotEmpty('--port', $this->port);
+        $cmd->addOptionIfNotEmpty('--jobs', $this->jobs);
         $cmd->addOptionIfNotEmpty('--dbname', $this->databaseToDump);
         $cmd->addOptionIfNotEmpty('--schema-only', $this->schemaOnly, false);
         $cmd->addOptionIfNotEmpty('--data-only', $this->dataOnly, false);
@@ -509,6 +532,7 @@ protected function createCommandLine() : CommandLine
         $cmd->addOptionIfNotEmpty('--encoding', $this->encoding);
         $cmd->addOptionIfNotEmpty('--no-tablespaces', $this->noTablespaces, false);
         $cmd->addOptionIfNotEmpty('--no-acl', $this->noPrivileges, false);
+        
 
         $this->handleSchemas($cmd);
         $this->handleTables($cmd);

tests/phpbu/Cli/Executable/PgdumpTest.php

@@ -251,6 +251,33 @@ public function testEncoding()
         );
     }
 
+    /**
+     * Tests Pgdump::getCommand
+     */
+    public function testJobs()
+    {
+        $file   = '/tmp/foo';
+        $pgdump = new Pgdump(PHPBU_TEST_BIN);
+        $pgdump->dumpDatabase('phpbu')->dumpJobs(4)->dumpTo($file);
+
+        $this->assertEquals(
+            PHPBU_TEST_BIN . '/pg_dump -w --jobs=\'4\' --dbname=\'phpbu\' --file=\'/tmp/foo\'',
+            $pgdump->getCommand()
+        );
+    }
+
+    /**
+     * Tests Pgdump::getCommand
+     */
+    public function testInvalidJobs()
+    {
+        $this->expectException('phpbu\App\Exception');
+        $file   = '/tmp/foo';
+        $pgdump = new Pgdump(PHPBU_TEST_BIN);
+        $pgdump->dumpDatabase('phpbu')->dumpJobs(-1)->dumpTo($file);
+    }
+
+
     /**
      * Tests Pgdump::getCommand
      */