vendor/doctrine/dbal/lib/Doctrine/DBAL/Tools/Console/Command/RunSqlCommand.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\DBAL\Tools\Console\Command;
  21
  22 use Symfony\Component\Console\Input\InputArgument,
  23     Symfony\Component\Console\Input\InputOption,
  24     Symfony\Component\Console;
  25
  26 /**
  27  * Task for executing arbitrary SQL that can come from a file or directly from
  28  * the command line.
  29  *
  30  *
  31  * @link    www.doctrine-project.org
  32  * @since   2.0
  33  * @author  Benjamin Eberlei <kontakt@beberlei.de>
  34  * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
  35  * @author  Jonathan Wage <jonwage@gmail.com>
  36  * @author  Roman Borschel <roman@code-factory.org>
  37  */
  38 class RunSqlCommand extends Console\Command\Command
  39 {
  40     /**
  41      * @see Console\Command\Command
  42      */
  43     protected function configure()
  44     {
  45         $this
  46         ->setName('dbal:run-sql')
  47         ->setDescription('Executes arbitrary SQL directly from the command line.')
  48         ->setDefinition(array(
  49             new InputArgument('sql', InputArgument::REQUIRED, 'The SQL statement to execute.'),
  50             new InputOption('depth', null, InputOption::VALUE_REQUIRED, 'Dumping depth of result set.', 7)
  51         ))
  52         ->setHelp(<<<EOT
  53 Executes arbitrary SQL directly from the command line.
  54 EOT
  55         );
  56     }
  57
  58     /**
  59      * @see Console\Command\Command
  60      */
  61     protected function execute(Console\Input\InputInterface $input, Console\Output\OutputInterface $output)
  62     {
  63         $conn = $this->getHelper('db')->getConnection();
  64
  65         if (($sql = $input->getArgument('sql')) === null) {
  66             throw new \RuntimeException("Argument 'SQL' is required in order to execute this command correctly.");
  67         }
  68
  69         $depth = $input->getOption('depth');
  70
  71         if ( ! is_numeric($depth)) {
  72             throw new \LogicException("Option 'depth' must contains an integer value");
  73         }
  74
  75         if (stripos($sql, 'select') === 0) {
  76             $resultSet = $conn->fetchAll($sql);
  77         } else {
  78             $resultSet = $conn->executeUpdate($sql);
  79         }
  80
  81         ob_start();
  82         \Doctrine\Common\Util\Debug::dump($resultSet, (int) $depth);
  83         $message = ob_get_clean();
  84
  85         $output->write($message);
  86     }
  87 }