2010-04-08 07:47:42 +04:00
|
|
|
<?php
|
|
|
|
/*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*
|
|
|
|
* This software consists of voluntary contributions made by many individuals
|
2012-05-26 16:37:00 +04:00
|
|
|
* and is licensed under the MIT license. For more information, see
|
2010-04-08 07:47:42 +04:00
|
|
|
* <http://www.doctrine-project.org>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Doctrine\ORM\Tools\Console\Command\SchemaTool;
|
|
|
|
|
2010-08-23 10:21:41 +04:00
|
|
|
use Symfony\Component\Console\Input\InputArgument,
|
|
|
|
Symfony\Component\Console\Input\InputOption,
|
|
|
|
Symfony\Component\Console\Input\InputInterface,
|
|
|
|
Symfony\Component\Console\Output\OutputInterface,
|
2010-04-10 13:09:22 +04:00
|
|
|
Doctrine\ORM\Tools\SchemaTool;
|
2010-04-08 07:47:42 +04:00
|
|
|
|
|
|
|
/**
|
2011-06-03 16:58:49 +04:00
|
|
|
* Command to generate the SQL needed to update the database schema to match
|
|
|
|
* the current mapping information.
|
2010-04-08 07:47:42 +04:00
|
|
|
*
|
2012-07-17 02:55:09 +04:00
|
|
|
*
|
2010-04-08 07:47:42 +04:00
|
|
|
* @link www.doctrine-project.org
|
|
|
|
* @since 2.0
|
|
|
|
* @author Benjamin Eberlei <kontakt@beberlei.de>
|
|
|
|
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
|
|
|
|
* @author Jonathan Wage <jonwage@gmail.com>
|
|
|
|
* @author Roman Borschel <roman@code-factory.org>
|
2011-06-03 16:58:49 +04:00
|
|
|
* @author Ryan Weaver <ryan@thatsquality.com>
|
2010-04-08 07:47:42 +04:00
|
|
|
*/
|
2010-04-10 13:09:22 +04:00
|
|
|
class UpdateCommand extends AbstractCommand
|
2010-04-08 07:47:42 +04:00
|
|
|
{
|
2011-06-04 00:09:18 +04:00
|
|
|
protected $name = 'orm:schema-tool:update';
|
|
|
|
|
2010-04-08 07:47:42 +04:00
|
|
|
/**
|
|
|
|
* @see Console\Command\Command
|
|
|
|
*/
|
|
|
|
protected function configure()
|
|
|
|
{
|
|
|
|
$this
|
2011-06-04 00:09:18 +04:00
|
|
|
->setName($this->name)
|
2010-04-08 07:47:42 +04:00
|
|
|
->setDescription(
|
2011-06-03 16:58:49 +04:00
|
|
|
'Executes (or dumps) the SQL needed to update the database schema to match the current mapping metadata.'
|
2010-04-08 07:47:42 +04:00
|
|
|
)
|
|
|
|
->setDefinition(array(
|
|
|
|
new InputOption(
|
2010-11-28 11:59:23 +03:00
|
|
|
'complete', null, InputOption::VALUE_NONE,
|
2010-04-08 07:47:42 +04:00
|
|
|
'If defined, all assets of the database which are not relevant to the current metadata will be dropped.'
|
|
|
|
),
|
2011-06-04 00:09:18 +04:00
|
|
|
|
|
|
|
new InputOption(
|
|
|
|
'dump-sql', null, InputOption::VALUE_NONE,
|
|
|
|
'Dumps the generated SQL statements to the screen (does not execute them).'
|
|
|
|
),
|
|
|
|
new InputOption(
|
|
|
|
'force', null, InputOption::VALUE_NONE,
|
|
|
|
'Causes the generated SQL statements to be physically executed against your database.'
|
|
|
|
),
|
2011-06-03 16:58:49 +04:00
|
|
|
));
|
|
|
|
|
|
|
|
$this->setHelp(<<<EOT
|
2012-07-17 02:55:09 +04:00
|
|
|
The <info>%command.name%</info> command generates the SQL needed to
|
2011-06-03 16:58:49 +04:00
|
|
|
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:
|
|
|
|
|
2012-07-17 02:55:09 +04:00
|
|
|
<info>%command.name% --dump-sql</info>
|
2011-06-03 16:58:49 +04:00
|
|
|
|
|
|
|
Alternatively, you can execute the generated queries:
|
|
|
|
|
2012-07-17 02:55:09 +04:00
|
|
|
<info>%command.name% --force</info>
|
2011-06-03 16:58:49 +04:00
|
|
|
|
2012-11-17 19:17:09 +04:00
|
|
|
If both options are specified, the queries are output and then executed:
|
|
|
|
|
|
|
|
<info>%command.name% --dump-sql --force</info>
|
|
|
|
|
2011-06-03 16:58:49 +04:00
|
|
|
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.
|
2010-04-08 07:47:42 +04:00
|
|
|
EOT
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2010-04-10 13:09:22 +04:00
|
|
|
protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas)
|
2010-04-08 07:47:42 +04:00
|
|
|
{
|
|
|
|
// Defining if update is complete or not (--complete not defined means $saveMode = true)
|
2012-10-22 03:58:31 +04:00
|
|
|
$saveMode = ! $input->getOption('complete');
|
2010-04-08 07:47:42 +04:00
|
|
|
|
2011-06-03 16:58:49 +04:00
|
|
|
$sqls = $schemaTool->getUpdateSchemaSql($metadatas, $saveMode);
|
2012-10-22 03:58:31 +04:00
|
|
|
|
|
|
|
if (0 === count($sqls)) {
|
2011-06-03 16:58:49 +04:00
|
|
|
$output->writeln('Nothing to update - your database is already in sync with the current entity metadata.');
|
2010-09-25 14:12:19 +04:00
|
|
|
|
2011-06-03 16:58:49 +04:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2012-10-22 03:58:31 +04:00
|
|
|
$dumpSql = true === $input->getOption('dump-sql');
|
|
|
|
$force = true === $input->getOption('force');
|
|
|
|
|
2011-06-04 00:09:18 +04:00
|
|
|
if ($dumpSql) {
|
|
|
|
$output->writeln(implode(';' . PHP_EOL, $sqls));
|
2012-10-22 03:58:31 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
if ($force) {
|
2012-11-17 19:17:09 +04:00
|
|
|
if ($dumpSql) {
|
|
|
|
$output->writeln('');
|
|
|
|
}
|
2011-06-03 16:58:49 +04:00
|
|
|
$output->writeln('Updating database schema...');
|
|
|
|
$schemaTool->updateSchema($metadatas, $saveMode);
|
|
|
|
$output->writeln(sprintf('Database schema updated successfully! "<info>%s</info>" queries were executed', count($sqls)));
|
2012-11-17 19:17:09 +04:00
|
|
|
}
|
2010-09-01 01:42:27 +04:00
|
|
|
|
2012-11-17 19:17:09 +04:00
|
|
|
if ($dumpSql || $force) {
|
2012-10-22 03:58:31 +04:00
|
|
|
return 0;
|
2010-04-08 07:47:42 +04:00
|
|
|
}
|
2012-11-17 19:17:09 +04:00
|
|
|
|
2012-10-22 03:58:31 +04:00
|
|
|
$output->writeln('<comment>ATTENTION</comment>: This operation should not be executed in a production environment.');
|
|
|
|
$output->writeln(' Use the incremental update to detect changes during development and use');
|
|
|
|
$output->writeln(' the SQL DDL provided to manually update your database in production.');
|
|
|
|
$output->writeln('');
|
|
|
|
|
|
|
|
$output->writeln(sprintf('The Schema-Tool would execute <info>"%s"</info> queries to update the database.', count($sqls)));
|
2012-11-17 19:17:09 +04:00
|
|
|
$output->writeln('Please run the operation by passing one - or both - of the following options:');
|
2012-10-22 03:58:31 +04:00
|
|
|
|
|
|
|
$output->writeln(sprintf(' <info>%s --force</info> to execute the command', $this->getName()));
|
|
|
|
$output->writeln(sprintf(' <info>%s --dump-sql</info> to dump the SQL statements to the screen', $this->getName()));
|
|
|
|
|
|
|
|
return 1;
|
2010-04-08 07:47:42 +04:00
|
|
|
}
|
2010-08-23 10:21:41 +04:00
|
|
|
}
|