allow toek replacement in filenames for sql execution

Author: Gaetano Giunta

README.md

@@ -68,6 +68,13 @@ to a file and then execute it in parallel on all databases:
 
 *NB* to share files between the host computer and the container, put them in the `shared` folder.  
 
+*NB* you can also execute different sql commands based on database type by saving them to separate files. The `sql:execute`
+command does replace some tokens in the values of the `--file` option. Eg:
+
+    php bin/console sql:execute --file='./shared/test_{dbtype}.sql'
+
+   will look for files `test_mariadb.sql`, `test_mssql.sql`, `test_mysql.sql`, `test_`
+    
 From within the worker container, you can also list all available databases: 
 
         php bin/console db3v4l:instance:list

TODO.md

@@ -1,5 +1,4 @@
 - worker: improve sql execution cmd:
-  + allow it to pick a set of desired instances
   + allow it to pick an existing db/user
   + disallow execution of commands that are part of the db client instead of being sent to the server, such as eg. 'use db'
     - ok for mysql? (to be tested)

WHATSNEW.md

@@ -3,6 +3,12 @@ Version 0.5
 
 - New: added Microsoft SQL Server 2017 and 2017
 
+- New: added the possibility to run sql commands against a subset of all available databases 
+
+- New: when running `db3v4l:sql:execute --file`, it is now possible to use placeholder tokens in the path/name of the
+  sql file to execute. This allows to run a different set of commands based on the database type.
+  Accepted tokens are at the moment `{dbtype}` and `{instancename}` (including the curly braces) 
+
 - Fixed: allow possibility of settings custom configs for the new  PostgreSQL versions added in release 0.4
 
 

app/config/services.yaml

@@ -7,6 +7,7 @@ parameters:
 
     db3v4l.database_instances:
         # Same format as the connection options used by doctrine
+        # Please use the 'database type' as initial part of the name, followed by an underscore
         mariadb_5_5:
             host: mariadb_5_5
             port: 3306

app/src/Command/SqlExecute.php

@@ -17,7 +17,7 @@ protected function configure()
         $this
             ->setDescription('Executes an SQL command in parallel on all configured database instances, creating a dedicated temporary database (and user)')
             ->addOption('sql', null, InputOption::VALUE_REQUIRED, 'The sql command(s) string to execute')
-            ->addOption('file', null, InputOption::VALUE_REQUIRED, 'A file with sql commands to execute')
+            ->addOption('file', null, InputOption::VALUE_REQUIRED, "A file with sql commands to execute. The tokens '{dbtype}' and '{instancename}' will be replaced with actual values")
             ->addCommonOptions()
         ;
     }
@@ -114,13 +114,18 @@ protected function executeSQL(array $dbConnectionSpecs, $sql, $file = null, $for
         /** @var Process[] $processes */
         $processes = [];
         $executors = [];
-        foreach ($dbConnectionSpecs as $dbName => $dbConnectionSpec) {
+        $filePattern = $file;
+        foreach ($dbConnectionSpecs as $instanceName => $dbConnectionSpec) {
 
             $executor = $this->executorFactory->createForkedExecutor($dbConnectionSpec);
 
             if ($sql != null) {
                 $process = $executor->getExecuteCommandProcess($sql);
             } else {
+                $file = $this->replaceDBSpecTokens($filePattern, $instanceName, $dbConnectionSpec);
+                if (!is_file($file)) {
+                    throw new \RuntimeException("Can not find sql file for execution: '$file'");
+                }
                 $process = $executor->getExecuteFileProcess($file);
             }
 
@@ -130,8 +135,8 @@ protected function executeSQL(array $dbConnectionSpecs, $sql, $file = null, $for
 
             $process->setTimeout($timeout);
 
-            $executors[$dbName] = $executor;
-            $processes[$dbName] = $process;
+            $executors[$instanceName] = $executor;
+            $processes[$instanceName] = $process;
         }
 
         if ($format === 'text') {
@@ -143,22 +148,22 @@ protected function executeSQL(array $dbConnectionSpecs, $sql, $file = null, $for
         $succeeded = 0;
         $failed = 0;
         $results = array();
-        foreach ($processes as $dbName => $process) {
-            $results[$dbName] = array(
+        foreach ($processes as $instanceName => $process) {
+            $results[$instanceName] = array(
                 'stdout' => rtrim($process->getOutput()),
                 'stderr' => trim($process->getErrorOutput()),
                 'exitcode' => $process->getExitCode()
             );
 
-            if ($executors[$dbName] instanceof TimedExecutor) {
-                $timingData = $executors[$dbName]->getTimingData();
-                $results[$dbName] = array_merge($results[$dbName], $timingData);
+            if ($executors[$instanceName] instanceof TimedExecutor) {
+                $timingData = $executors[$instanceName]->getTimingData();
+                $results[$instanceName] = array_merge($results[$instanceName], $timingData);
             }
 
             if ($process->isSuccessful()) {
                 $succeeded++;
             } else {
-                $this->writeErrorln("\n<error>Execution on database '$dbName' failed! Reason: " . $process->getErrorOutput() . "</error>\n", OutputInterface::VERBOSITY_NORMAL);
+                $this->writeErrorln("\n<error>Execution on database '$instanceName' failed! Reason: " . $process->getErrorOutput() . "</error>\n", OutputInterface::VERBOSITY_NORMAL);
                 $failed++;
             }
         }
@@ -207,4 +212,17 @@ public function onSubProcessOutput($type, $buffer, $processIndex, $process = nul
             }
         }
     }
+
+    /**
+     * Replaces tokens
+     * @param string $instanceName
+     * @aparam string[] $dbConnectionSpec
+     * @param $string
+     * @return string
+     */
+    protected function replaceDBSpecTokens($string, $instanceName, $dbConnectionSpec)
+    {
+        $dbType = explode('_', $instanceName, 2)[0];
+        return str_replace(array('{dbtype}', '{instancename}'), array($dbType, $instanceName), $string);
+    }
 }