add doNotDumpData() for MySQL and Postgres (#208)

* add doNotDumpData() for MySQL and Postgres

* Update README.md

---------

Co-authored-by: Freek Van der Herten <[email protected]>

README.md

@@ -207,7 +207,7 @@ Spatie\DbDumper\Databases\MySql::create()
 
 ### Excluding tables from the dump
 
-Using an array:
+You can exclude tables from the dump by using an array:
 
 ```php
 Spatie\DbDumper\Databases\MySql::create()
@@ -218,7 +218,7 @@ Spatie\DbDumper\Databases\MySql::create()
     ->dumpToFile('dump.sql');
 ```
 
-Using a string:
+Or by using a string:
 
 ```php
 Spatie\DbDumper\Databases\MySql::create()
@@ -229,7 +229,9 @@ Spatie\DbDumper\Databases\MySql::create()
     ->dumpToFile('dump.sql');
 ```
 
-### Do not write CREATE TABLE statements that create each dumped table.
+### Do not write CREATE TABLE statements that create each dumped table
+
+You can use `doNotCreateTables` to prevent writing create statements.
 
 ```php
 $dumpCommand = MySql::create()
@@ -240,6 +242,20 @@ $dumpCommand = MySql::create()
     ->getDumpCommand('dump.sql', 'credentials.txt');
 ```
 
+### Do not write row data
+
+You can use `doNotDumpData` to prevent writing row data.
+
+
+```php
+$dumpCommand = MySql::create()
+    ->setDbName('dbname')
+    ->setUserName('username')
+    ->setPassword('password')
+    ->doNotDumpData()
+    ->getDumpCommand('dump.sql', 'credentials.txt');
+```
+
 ### Adding extra options
 
 If you want to add an arbitrary option to the dump command you can use `addExtraOption`

src/Databases/MySql.php

@@ -32,6 +32,8 @@ class MySql extends DbDumper
 
     protected bool $createTables = true;
 
+    protected bool $includeData = true;
+
     /** @var false|resource */
     private $tempFileHandle;
 
@@ -181,6 +183,13 @@ public function doNotCreateTables(): self
         return $this;
     }
 
+    public function doNotDumpData(): self
+    {
+        $this->includeData = false;
+
+        return $this;
+    }
+
     public function getDumpCommand(string $dumpFile, string $temporaryCredentialsFile): string
     {
         $quote = $this->determineQuote();
@@ -194,6 +203,10 @@ public function getDumpCommand(string $dumpFile, string $temporaryCredentialsFil
             $command[] = '--no-create-info';
         }
 
+        if (!$this->includeData) {
+            $command[] = '--no-data';
+        }
+
         if ($this->skipComments) {
             $command[] = '--skip-comments';
         }

src/Databases/PostgreSql.php

@@ -12,6 +12,8 @@ class PostgreSql extends DbDumper
 
     protected bool $createTables = true;
 
+    protected bool $includeData = true;
+
     /** @var false|resource */
     private $tempFileHandle;
 
@@ -60,6 +62,10 @@ public function getDumpCommand(string $dumpFile): string
             $command[] = '--data-only';
         }
 
+        if (!$this->includeData) {
+            $command[] = '--schema-only';
+        }
+
         foreach ($this->extraOptions as $extraOption) {
             $command[] = $extraOption;
         }
@@ -120,6 +126,13 @@ public function doNotCreateTables(): self
         return $this;
     }
 
+    public function doNotDumpData(): self
+    {
+        $this->includeData = false;
+
+        return $this;
+    }
+
     public function getProcess(string $dumpFile): Process
     {
         $command = $this->getDumpCommand($dumpFile);

tests/MySqlTest.php

@@ -448,3 +448,17 @@
         '\'mysqldump\' --defaults-extra-file="credentials.txt" --no-create-info --skip-comments --extended-insert dbname > "dump.sql"'
     );
 });
+
+
+it('can generate a dump command with no data', function () {
+    $dumpCommand = MySQL::create()
+        ->setDbName('dbname')
+        ->setUserName('username')
+        ->setPassword('password')
+        ->doNotDumpData()
+        ->getDumpCommand('dump.sql', 'credentials.txt');
+
+    expect($dumpCommand)->toEqual(
+        '\'mysqldump\' --defaults-extra-file="credentials.txt" --no-data --skip-comments --extended-insert dbname > "dump.sql"'
+    );
+});

tests/PostgreSqlTest.php

@@ -231,3 +231,14 @@
 
     expect($dumpCommand)->toEqual('\'pg_dump\' -U "username" -h localhost -p 5432 --data-only > "dump.sql"');
 });
+
+it('can generate a dump command with no data', function () {
+    $dumpCommand = PostgreSql::create()
+        ->setDbName('dbname')
+        ->setUserName('username')
+        ->setPassword('password')
+        ->doNotDumpData()
+        ->getDumpCommand('dump.sql');
+
+    expect($dumpCommand)->toEqual('\'pg_dump\' -U "username" -h localhost -p 5432 --schema-only > "dump.sql"');
+});