Command/UpdateSchemaDoctrineCommand.php
author ymh <ymh.work@gmail.com>
Fri, 04 Nov 2011 15:59:49 +0100
changeset 25 11fd79666374
child 42 0e57c730bb18
permissions -rwxr-xr-x
add missing files
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
25
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
/*
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
 * This file is part of the Symfony package.
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
 *
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
 * (c) Fabien Potencier <fabien@symfony.com>
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
 *
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
 * For the full copyright and license information, please view the LICENSE
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
 * file that was distributed with this source code.
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
 */
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
namespace IRI\Bundle\WikiTagBundle\Command;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
use Symfony\Component\DependencyInjection\ContainerInterface;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
use Symfony\Component\Console\Input\InputArgument;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
use Symfony\Component\Console\Input\InputOption;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
use Symfony\Component\Console\Input\InputInterface;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
use Symfony\Component\Console\Output\OutputInterface;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
use Symfony\Component\Console\Output\Output;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
use Doctrine\ORM\Tools\Console\Command\SchemaTool\UpdateCommand;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
use Doctrine\ORM\Tools\SchemaTool;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
use Symfony\Bundle\DoctrineBundle\Command\Proxy\DoctrineCommandHelper;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
/**
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
 * Command to generate the SQL needed to update the database schema to match
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
 * the current mapping information.
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
 *
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
 * This file is a direct adaptation of the Symfony\Bundle\DoctrineBundle\Command\Proxy\UpdateSchemaDoctrineCommand
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
 *
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
 */
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
class UpdateSchemaDoctrineCommand extends UpdateCommand implements ContainerAwareInterface
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
{
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
    protected function configure()
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
    {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
        parent::configure();
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
        $this
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
            ->setName('wikitag:schema:update')
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
            ->setDescription('Executes (or dumps) the SQL needed to update the database schema to match the current mapping metadata')
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
            ->addOption('em', null, InputOption::VALUE_OPTIONAL, 'The entity manager to use for this command')
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
            ->setHelp(<<<EOT
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
The <info>doctrine:schema:update</info> command generates the SQL needed to
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
synchronize the database schema with the current mapping metadata of the
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
default entity manager.
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
For example, if you add metadata for a new column to an entity, this command
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
would generate and output the SQL needed to add the new column to the database:
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
<info>php app/console doctrine:schema:update --dump-sql</info>
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
Alternatively, you can execute the generated queries:
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
<info>php app/console doctrine:schema:update --force</info>
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
You can also update the database schema for a specific entity manager:
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
<info>php app/console doctrine:schema:update --em=default</info>
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
EOT
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
        );
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
    }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
    protected function execute(InputInterface $input, OutputInterface $output)
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
    {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
        DoctrineCommandHelper::setApplicationEntityManager($this->getApplication(), $input->getOption('em'));
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
        parent::execute($input, $output);
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
    }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
   /**
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
    * @var ContainerInterface
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
    */
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
    private $container;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
    protected function getContainer()
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
    {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
        if (null === $this->container) {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
            $this->container = $this->getApplication()->getKernel()->getContainer();
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
        }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
        return $this->container;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
    }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
    /**
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
     * @see ContainerAwareInterface::setContainer()
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
     */
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
    public function setContainer(ContainerInterface $container = null)
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
    {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
        $this->container = $container;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
    }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
    protected function filterUpdateSchema($sqls)
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
    {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
        // get service
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
        $schema_utils = $this->getContainer()->get("wikitag.shema_utils");
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
        $res_sqls = $schema_utils->filter_foreign_key($sqls);
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
        $res_sqls = $schema_utils->filter_index_creation($res_sqls);
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
        return $res_sqls;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
    }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
    protected function executeSchemaCommand(InputInterface $input, OutputInterface $output, SchemaTool $schemaTool, array $metadatas)
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
    {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
        // Defining if update is complete or not (--complete not defined means $saveMode = true)
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
        $saveMode = ($input->getOption('complete') !== true);
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
        $sqls = $schemaTool->getUpdateSchemaSql($metadatas, $saveMode);
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   113
        $sqls = $this->filterUpdateSchema($sqls);
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   114
        if (0 == count($sqls)) {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   115
            $output->writeln('Nothing to update - your database is already in sync with the current entity metadata.');
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   116
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   117
            return;
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   118
        }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   119
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   120
        $dumpSql = (true === $input->getOption('dump-sql'));
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   121
        $force = (true === $input->getOption('force'));
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   122
        if ($dumpSql && $force) {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   123
            throw new \InvalidArgumentException('You can pass either the --dump-sql or the --force option (but not both simultaneously).');
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   124
        }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   125
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   126
        if ($dumpSql) {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   127
            $output->writeln(implode(';' . PHP_EOL, $sqls));
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   128
        } else if ($force) {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   129
            $output->writeln('Updating database schema...');
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   130
            
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   131
            $emHelper = $this->getHelper('em');
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   132
            
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   133
            $conn = $emHelper->getEntityManager()->getConnection();
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   134
            
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   135
            foreach ($sqls as $sql) {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   136
                $conn->executeQuery($sql);
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   137
            }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   138
            $output->writeln(sprintf('Database schema updated successfully! "<info>%s</info>" queries were executed', count($sqls)));
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   139
        } else {
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   140
            $output->writeln('<comment>ATTENTION</comment>: This operation should not be executed in a production environment.');
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   141
            $output->writeln('           Use the incremental update to detect changes during development and use');
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   142
            $output->writeln('           the SQL DDL provided to manually update your database in production.');
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   143
            $output->writeln('');
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   144
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   145
            $output->writeln(sprintf('The Schema-Tool would execute <info>"%s"</info> queries to update the database.', count($sqls)));
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   146
            $output->writeln('Please run the operation by passing one of the following options:');
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   147
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   148
            $output->writeln(sprintf('    <info>%s --force</info> to execute the command', $this->getName()));
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   149
            $output->writeln(sprintf('    <info>%s --dump-sql</info> to dump the SQL statements to the screen', $this->getName()));
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   150
        }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   151
    }
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   152
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   153
    
11fd79666374 add missing files
ymh <ymh.work@gmail.com>
parents:
diff changeset
   154
}