. */ namespace Doctrine\DBAL\Migrations\Tools\Console\Command; use Doctrine\DBAL\Migrations\Configuration\Configuration; use Doctrine\DBAL\Migrations\Migration; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputOption; /** * Command for executing a migration to a specified version or the latest available version. * * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @link www.doctrine-project.org * @since 2.0 * @author Jonathan Wage */ class MigrateCommand extends AbstractCommand { protected function configure() { $this ->setName('migrations:migrate') ->setDescription('Execute a migration to a specified version or the latest available version.') ->addArgument('version', InputArgument::OPTIONAL, 'The version number (YYYYMMDDHHMMSS) or alias (first, prev, next, latest) to migrate to.', 'latest') ->addOption('write-sql', null, InputOption::VALUE_NONE, 'The path to output the migration SQL file instead of executing it.') ->addOption('dry-run', null, InputOption::VALUE_NONE, 'Execute the migration as a dry run.') ->addOption('query-time', null, InputOption::VALUE_NONE, 'Time all the queries individually.') ->addOption('allow-no-migration', null, InputOption::VALUE_NONE, 'Don\'t throw an exception if no migration is available (CI).') ->setHelp(<<%command.name% command executes a migration to a specified version or the latest available version: %command.full_name% You can optionally manually specify the version you wish to migrate to: %command.full_name% YYYYMMDDHHMMSS You can specify the version you wish to migrate to using an alias: %command.full_name% prev You can also execute the migration as a --dry-run: %command.full_name% YYYYMMDDHHMMSS --dry-run You can output the would be executed SQL statements to a file with --write-sql: %command.full_name% YYYYMMDDHHMMSS --write-sql Or you can also execute the migration without a warning message which you need to interact with: %command.full_name% --no-interaction You can also time all the different queries if you wanna know which one is taking so long: %command.full_name% --query-time EOT ); parent::configure(); } public function execute(InputInterface $input, OutputInterface $output) { $configuration = $this->getMigrationConfiguration($input, $output); $migration = $this->createMigration($configuration); $this->outputHeader($configuration, $output); $timeAllqueries = $input->getOption('query-time'); $executedMigrations = $configuration->getMigratedVersions(); $availableMigrations = $configuration->getAvailableVersions(); $version = $this->getVersionNameFromAlias($input->getArgument('version'), $output, $configuration); if ($version === false) { return 1; } $executedUnavailableMigrations = array_diff($executedMigrations, $availableMigrations); if (!empty($executedUnavailableMigrations)) { $output->writeln(sprintf( 'WARNING! You have %s previously executed migrations' . ' in the database that are not registered migrations.', count($executedUnavailableMigrations) )); foreach ($executedUnavailableMigrations as $executedUnavailableMigration) { $output->writeln(sprintf( ' >> %s (%s)', $configuration->getDateTime($executedUnavailableMigration), $executedUnavailableMigration )); } $question = 'Are you sure you wish to continue? (y/n)'; if (! $this->canExecute($question, $input, $output)) { $output->writeln('Migration cancelled!'); return 1; } } if ($path = $input->getOption('write-sql')) { $path = is_bool($path) ? getcwd() : $path; $migration->writeSqlFile($path, $version); return 0; } $dryRun = (boolean) $input->getOption('dry-run'); $cancelled = false; $migration->setNoMigrationException($input->getOption('allow-no-migration')); $result = $migration->migrate($version, $dryRun, $timeAllqueries, function () use ($input, $output, &$cancelled) { $question = 'WARNING! You are about to execute a database migration' . ' that could result in schema changes and data lost.' . ' Are you sure you wish to continue? (y/n)'; $canContinue = $this->canExecute($question, $input, $output); $cancelled = !$canContinue; return $canContinue; }); if ($cancelled) { $output->writeln('Migration cancelled!'); return 1; } } /** * Create a new migration instance to execute the migrations. * * @param $configuration The configuration with which the migrations will be executed * @return Migration a new migration instance */ protected function createMigration(Configuration $configuration) { return new Migration($configuration); } /** * @param string $question * @param InputInterface $input * @param OutputInterface $output * @return bool */ private function canExecute($question, InputInterface $input, OutputInterface $output) { if ($input->isInteractive() && ! $this->askConfirmation($question, $input, $output)) { return false; } return true; } /** * @param string $versionAlias * @param OutputInterface $output * @param Configuration $configuration * @return bool|string */ private function getVersionNameFromAlias($versionAlias, OutputInterface $output, Configuration $configuration) { $version = $configuration->resolveVersionAlias($versionAlias); if ($version === null) { if ($versionAlias == 'prev') { $output->writeln('Already at first version.'); return false; } if ($versionAlias == 'next') { $output->writeln('Already at latest version.'); return false; } $output->writeln(sprintf( 'Unknown version: %s', $output->getFormatter()->escape($versionAlias) )); return false; } return $version; } }