RetailCRM-Mirror/doctrine2
1
0
Fork 0
mirror of synced 2025-04-03 13:23:37 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #65 from weaverryan/update_command

Browse source 
[Tools][Console] Refactoring the UpdateCommand
This commit is contained in:
Benjamin Eberlei 2011-06-11 01:16:25 -07:00
commit 037daff891
1 changed files with 59 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
lib/Doctrine/ORM/Tools/Console/Command/SchemaTool/UpdateCommand.php
View file

@ -28,7 +28,8 @@ use Symfony\Component\Console\Input\InputArgument,
Doctrine\ORM\Tools\SchemaTool; Doctrine\ORM\Tools\SchemaTool;
/** /**
* Command to update the database schema for a set of classes based on their mappings. * Command to generate the SQL needed to update the database schema to match
* the current mapping information.
* *
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.org * @link www.doctrine-project.org
@ -38,37 +39,58 @@ use Symfony\Component\Console\Input\InputArgument,
* @author Guilherme Blanco <guilhermeblanco@hotmail.com> * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com> * @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org> * @author Roman Borschel <roman@code-factory.org>
* @author Ryan Weaver <ryan@thatsquality.com>
*/ */
class UpdateCommand extends AbstractCommand class UpdateCommand extends AbstractCommand
{ {
protected $name = 'orm:schema-tool:update';
/** /**
* @see Console\Command\Command * @see Console\Command\Command
*/ */
protected function configure() protected function configure()
{ {
$this $this
->setName('orm:schema-tool:update') ->setName($this->name)
->setDescription( ->setDescription(
'Processes the schema and either update the database schema of EntityManager Storage Connection or generate the SQL output.' 'Executes (or dumps) the SQL needed to update the database schema to match the current mapping metadata.'
) )
->setDefinition(array( ->setDefinition(array(
new InputOption( new InputOption(
'complete', null, InputOption::VALUE_NONE, 'complete', null, InputOption::VALUE_NONE,
'If defined, all assets of the database which are not relevant to the current metadata will be dropped.' 'If defined, all assets of the database which are not relevant to the current metadata will be dropped.'
), ),
new InputOption( new InputOption(
'dump-sql', null, InputOption::VALUE_NONE, 'dump-sql', null, InputOption::VALUE_NONE,
'Instead of try to apply generated SQLs into EntityManager Storage Connection, output them.' 'Dumps the generated SQL statements to the screen (does not execute them).'
), ),
new InputOption( new InputOption(
'force', null, InputOption::VALUE_NONE, 'force', null, InputOption::VALUE_NONE,
"Don't ask for the incremental update of the database, but force the operation to run." 'Causes the generated SQL statements to be physically executed against your database.'
), ),
)) ));
->setHelp(<<<EOT
Processes the schema and either update the database schema of EntityManager Storage Connection or generate the SQL output. $fullName = $this->getFullName();
Beware that if --complete is not defined, it will do a save update, which does not delete any tables, sequences or affected foreign keys. $this->setHelp(<<<EOT
If defined, all assets of the database which are not relevant to the current metadata are dropped by this command. The <info>$fullName</info> command generates the SQL needed to
synchronize the database schema with the current mapping metadata of the
default entity manager.
For example, if you add metadata for a new column to an entity, this command
would generate and output the SQL needed to add the new column to the database:
<info>$fullName --dump-sql</info>
Alternatively, you can execute the generated queries:
<info>$fullName --force</info>
Finally, be aware that if the <info>--complete</info> option is passed, this
task will drop all database assets (e.g. tables, etc) that are *not* described
by the current metadata. In other words, without this option, this task leaves
untouched any "extra" tables that exist in the database, but which aren't
described by any metadata.
EOT EOT
); );
} }
@ -78,26 +100,36 @@ EOT
// Defining if update is complete or not (--complete not defined means $saveMode = true) // Defining if update is complete or not (--complete not defined means $saveMode = true)
$saveMode = ($input->getOption('complete') !== true); $saveMode = ($input->getOption('complete') !== true);
if ($input->getOption('dump-sql') === true) { $sqls = $schemaTool->getUpdateSchemaSql($metadatas, $saveMode);
$sqls = $schemaTool->getUpdateSchemaSql($metadatas, $saveMode); if (0 == count($sqls)) {
$output->write(implode(';' . PHP_EOL, $sqls) . PHP_EOL); $output->writeln('Nothing to update - your database is already in sync with the current entity metadata.');
} else if ($input->getOption('force') === true) {
$output->write('Updating database schema...' . PHP_EOL); return;
}
$dumpSql = (true === $input->getOption('dump-sql'));
$force = (true === $input->getOption('force'));
if ($dumpSql && $force) {
throw new \InvalidArgumentException('You can pass either the --dump-sql or the --force option (but not both simultaneously).');
}
if ($dumpSql) {
$output->writeln(implode(';' . PHP_EOL, $sqls));
} else if ($force) {
$output->writeln('Updating database schema...');
$schemaTool->updateSchema($metadatas, $saveMode); $schemaTool->updateSchema($metadatas, $saveMode);
$output->write('Database schema updated successfully!' . PHP_EOL); $output->writeln(sprintf('Database schema updated successfully! "<info>%s</info>" queries were executed', count($sqls)));
} else { } else {
$output->write('ATTENTION: This operation should not be executed in a production environment.' . PHP_EOL); $output->writeln('<comment>ATTENTION</comment>: This operation should not be executed in a production environment.');
$output->write('Use the incremental update to detect changes during development and use' . PHP_EOL); $output->writeln(' Use the incremental update to detect changes during development and use');
$output->write('this SQL DDL to manually update your database in production.' . PHP_EOL . PHP_EOL); $output->writeln(' the SQL DDL provided to manually update your database in production.');
$output->writeln('');
$sqls = $schemaTool->getUpdateSchemaSql($metadatas, $saveMode); $output->writeln(sprintf('The Schema-Tool would execute <info>"%s"</info> queries to update the database.', count($sqls)));
$output->writeln('Please run the operation by passing one of the following options:');
if (count($sqls)) {
$output->write('Schema-Tool would execute ' . count($sqls) . ' queries to update the database.' . PHP_EOL); $output->writeln(sprintf(' <info>%s --force</info> to execute the command', $this->getFullName()));
$output->write('Please run the operation with --force to execute these queries or use --dump-sql to see them.' . PHP_EOL); $output->writeln(sprintf(' <info>%s --dump-sql</info> to dump the SQL statements to the screen', $this->getFullName()));
} else {
$output->write('Nothing to update. The database is in sync with the current entity metadata.' . PHP_EOL);
}
} }
} }
} }