Merge pull request #15 from Jagdish-J-P/main

Added New Options

Author: Andrey Helldar

.github/workflows/lint-check.yml

@@ -11,4 +11,4 @@ jobs:
                 uses: actions/checkout@v2
 
             -   name: Checking PHP Syntax
-                uses: TheDragonCode/[email protected].5
+                uses: TheDragonCode/[email protected].7

.github/workflows/lint-fixer.yml

@@ -13,6 +13,6 @@ jobs:
                 uses: actions/checkout@v2
 
             -   name: Checking PHP Syntax
-                uses: TheDragonCode/[email protected].6
+                uses: TheDragonCode/[email protected].7
                 with:
                     fix: true

README.md

@@ -15,7 +15,7 @@
 To get the latest version of `Migrate DB`, simply require the project using [Composer](https://getcomposer.org):
 
 ```bash
-$ composer require dragon-code/migrate-db --dev
+composer require dragon-code/migrate-db --dev
 ```
 
 Or manually update `require-dev` block of `composer.json` and run `composer update`.
@@ -49,15 +49,27 @@ the [config/database.php](https://github.com/laravel/laravel/blob/master/config/
 parameters:
 
 ```bash
-$ php artisan db:migrate --schema-from=foo --schema-to=bar
+php artisan db:migrate --schema-from=foo --schema-to=bar
+```
+
+### Only Specific Tables
+
+```bash
+php artisan db:migrate --schema-from=foo --schema-to=bar --tables=table1 --tables=table2 --tables=table3
+```
+
+### Exclude Specific Tables
+
+```bash
+php artisan db:migrate --schema-from=foo --schema-to=bar --exclude=table1 --exclude=table2 --exclude=table3
 ```
 
 where:
 
 * `foo` - Source [connection](https://github.com/laravel/laravel/blob/master/config/database.php) name
 * `bar` - Target [connection](https://github.com/laravel/laravel/blob/master/config/database.php) name
 
-The command will perform all migrations on the source and destination databases and transfer all records from the old to the new one.
+Follow on screen instructions and then command will perform all migrations on the source and destination databases and transfer all records from the old to the new one.
 
 Enjoy 😊
 

composer.json

@@ -26,6 +26,7 @@
     "require": {
         "php": "^7.3 || ^8.0",
         "ext-pdo": "*",
+        "doctrine/dbal": "^2.6 || ^3.0",
         "dragon-code/contracts": "^2.15",
         "dragon-code/support": "^5.6",
         "illuminate/contracts": "^8.0 || ^9.0",

src/Console/Migrate.php

@@ -10,12 +10,16 @@
 use Illuminate\Database\Query\Builder as QueryBuilder;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Schema;
 
 class Migrate extends Command
 {
     protected $signature = 'db:migrate'
-    . ' {--schema-from= : Source connection name}'
-    . ' {--schema-to= : Target connection name}';
+        . ' {--schema-from= : Source connection name}'
+        . ' {--schema-to= : Target connection name}'
+        . ' {--exclude=* : Comma separated table names to exclude}'
+        . ' {--tables=* : Comma separated table names to migrate only}';
 
     protected $description = 'Data transfer from one database to another';
 
@@ -25,56 +29,198 @@ class Migrate extends Command
     /** @var \DragonCode\Contracts\MigrateDB\Builder */
     protected $target;
 
+    /** @var array */
+    protected $tables;
+
+    /** @var array */
+    protected $excludes;
+
+    /** @var bool */
+    protected $retrieve_tables_from_target = false;
+
+    /** @var bool */
+    protected $drop_target = false;
+
+    /** @var bool */
+    protected $truncate = false;
+
+    /** @var string */
+    protected $target_connection = 'target';
+
+    /** @var string */
+    protected $source_connection = 'source';
+
+    /** @var string */
+    protected $none = 'none';
+
+    /** @var array */
+    protected $choices = ['target', 'source', 'none'];
+
+    /** @var array */
+    protected $migrated = [];
+
+    /** @var array */
+    protected $tables_not_exists = [];
+
+    /** @var array */
+    protected $excluded = [];
+
     public function handle()
     {
         $this->validateOptions();
         $this->resolveBuilders();
+        $this->resolveOptions();
         $this->cleanTargetDatabase();
         $this->runMigrations();
 
         $this->disableForeign();
         $this->runTransfer();
         $this->enableForeign();
+
+        $this->showStatus();
+    }
+
+    protected function showStatus(): void
+    {
+        $this->displayMessage('Migrated Tables', $this->migrated);
+        $this->displayMessage('Excluded Tables', $this->excluded);
+        $this->displayMessage('Tables does not exist in source connection', $this->tables_not_exists);
+    }
+
+    protected function displayMessage(string $message, array $context = []): void
+    {
+        $this->info($message);
+
+        if ($context) {
+            $this->info(implode(',', $context));
+        }
     }
 
     protected function runTransfer(): void
     {
-        $this->info('Transferring data...');
+        $this->displayMessage('Transferring data...' . PHP_EOL);
 
         $this->withProgressBar($this->tables(), function (string $table) {
+            if (in_array($table, $this->excludes)) {
+                $this->excluded[] = $table;
+
+                return;
+            }
+
+            if ($this->doesntHasTable($this->source(), $table)) {
+                $this->tables_not_exists[] = $table;
+
+                return;
+            }
+
+            $this->truncateTable($table);
             $this->migrateTable($table, $this->source->getPrimaryKey($table));
         });
+
+        $this->displayMessage(PHP_EOL);
+    }
+
+    protected function truncateTable(string $table): void
+    {
+        if ($this->truncate) {
+            $this->builder($this->target(), $table)->truncate();
+        }
     }
 
     protected function migrateTable(string $table, string $column): void
     {
+        Log::info('Transferring data from: ' . $table);
+
         $this->builder($this->source(), $table)
+            ->when(
+                $this->isSkippable($table, $column),
+                function ($query) use ($table, $column) {
+                    $lastRecord = $this->builder($this->target(), $table)->max($column) ?: 0;
+
+                    Log::info('last record: ' . $lastRecord);
+
+                    return $query->where($column, '>', $lastRecord);
+                }
+            )
             ->orderBy($column)
             ->chunk(1000, function (Collection $items) use ($table) {
                 $items = Arr::toArray($items);
 
                 $this->builder($this->target(), $table)->insert($items);
             });
+
+        $this->migrated[] = $table;
+    }
+
+    protected function isSkippable(string $table, string $column): bool
+    {
+        return ! $this->truncate && $this->isNumericColumn($table, $column);
+    }
+
+    protected function isNumericColumn(string $table, string $column): bool
+    {
+        return $this->getPrimaryKeyType($this->source(), $table, $column) !== 'string';
     }
 
     protected function tables(): array
     {
-        return $this->source->getAllTables();
+        if ($this->tables) {
+            return $this->tables;
+        }
+
+        return $this->retrieve_tables_from_target
+            ? $this->target->getAllTables()
+            : $this->source->getAllTables();
     }
 
     protected function cleanTargetDatabase(): void
     {
-        $this->info('Clearing the target database...');
+        if (! $this->drop_target) {
+            return;
+        }
+
+        $this->displayMessage('Clearing the target database...');
 
         $this->target->dropAllTables();
     }
 
     protected function runMigrations(): void
     {
-        $this->info('Run migrations on the databases...');
+        $on = $this->getMigrationOption();
+
+        if ($this->isMigrationNotRequired($on)) {
+            return;
+        }
+
+        $this->displayMessage('Run migrations on the databases...');
 
-        $this->call('migrate', ['--database' => $this->source()]);
-        $this->call('migrate', ['--database' => $this->target()]);
+        if ($this->shouldRunOnSource($on)) {
+            $this->migrate($this->source());
+        }
+
+        if ($this->drop_target || $this->shouldRunOnSource($on) || $this->shouldRunOnTarget($on)) {
+            $this->migrate($this->target());
+        }
+    }
+
+    protected function isMigrationNotRequired(string $on): bool
+    {
+        return $on === $this->none;
+    }
+
+    protected function shouldRunOnTarget(string $on): bool
+    {
+        return $on === $this->target_connection;
+    }
+
+    protected function shouldRunOnSource(string $on): bool
+    {
+        return $on === $this->source_connection;
+    }
+
+    protected function migrate(string $connection): void
+    {
+        $this->call('migrate', ['--database' => $connection]);
     }
 
     protected function disableForeign(): void
@@ -97,6 +243,36 @@ protected function target(): string
         return $this->validatedOption('schema-to');
     }
 
+    protected function getTablesOption(): array
+    {
+        return $this->option('tables');
+    }
+
+    protected function getExcludeOption(): array
+    {
+        return $this->option('exclude');
+    }
+
+    protected function getMigrationOption(): string
+    {
+        return $this->choice('Please choose option to run migration on which connection?', $this->choices, 0);
+    }
+
+    protected function confirmTableListOption(): bool
+    {
+        return $this->confirm('Please confirm table list should be retrieved from target connection? (incase if source connection does not support it)', false);
+    }
+
+    protected function confirmTruncateTableOption(): bool
+    {
+        return $this->confirm('Please confirm whether to truncate target table before transfer?', false);
+    }
+
+    protected function confirmDropOption(): bool
+    {
+        return $this->confirm('Please choose whether to drop target tables before migration?', false);
+    }
+
     protected function validatedOption(string $key): string
     {
         if ($schema = $this->option($key)) {
@@ -123,8 +299,36 @@ protected function resolveBuilders(): void
         $this->target = $this->resolveBuilder($this->target());
     }
 
+    protected function resolveOptions(): void
+    {
+        $this->tables   = $this->getTablesOption();
+        $this->excludes = $this->getExcludeOption();
+
+        if (empty($this->tables) && $this->confirmTableListOption()) {
+            $this->retrieve_tables_from_target = true;
+        }
+
+        if ($this->confirmTruncateTableOption()) {
+            $this->truncate = true;
+        }
+
+        if (empty($this->tables) && empty($this->excludes) && $this->truncate && $this->confirmDropOption()) {
+            $this->drop_target = true;
+        }
+    }
+
     protected function builder(string $connection, string $table): QueryBuilder
     {
         return DB::connection($connection)->table($table);
     }
+
+    protected function doesntHasTable(string $connection, string $table): bool
+    {
+        return ! Schema::connection($connection)->hasTable($table);
+    }
+
+    protected function getPrimaryKeyType(string $connection, string $table, string $column): string
+    {
+        return DB::connection($connection)->getDoctrineColumn($table, $column)->getType()->getName();
+    }
 }

tests/Concerns/Database.php

@@ -27,6 +27,16 @@ trait Database
 
     protected $table_baz = 'baz';
 
+    protected $choice_target = 'target';
+
+    protected $choice_source = 'source';
+
+    protected $choices = [
+        'target',
+        'source',
+        'none',
+    ];
+
     protected function setDatabases($app): void
     {
         $this->setDatabaseConnections($app);