Merge pull request #1231 from doctrine/feature-1179

#1179 Deprecate doctrine:query:sql command
doctrine · Oct 25, 2020 · fb5b10e · fb5b10e
2 parents 9cea714 + 95c9daf
commit fb5b10e
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 3 deletions.
diff --git a/Command/Proxy/RunSqlDoctrineCommand.php b/Command/Proxy/RunSqlDoctrineCommand.php
@@ -9,6 +9,8 @@
 
 /**
  * Execute a SQL query and output the results.
+ *
+ * @deprecated use Doctrine\DBAL\Tools\Console\Command\RunSqlCommand instead
  */
 class RunSqlDoctrineCommand extends RunSqlCommand
 {
@@ -41,6 +43,8 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        @trigger_error(sprintf('The "%s" (doctrine:query:sql) is deprecated, use dbal:run-sql command instead.', self::class), E_USER_DEPRECATED);
+
         DoctrineCommandHelper::setApplicationConnection($this->getApplication(), $input->getOption('connection'));
 
         // compatibility with doctrine/dbal 2.11+

diff --git a/Dbal/ManagerRegistryAwareConnectionProvider.php b/Dbal/ManagerRegistryAwareConnectionProvider.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Doctrine\Bundle\DoctrineBundle\Dbal;
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Tools\Console\ConnectionProvider;
+use Doctrine\Persistence\AbstractManagerRegistry;
+
+class ManagerRegistryAwareConnectionProvider implements ConnectionProvider
+{
+    /** @var AbstractManagerRegistry */
+    private $managerRegistry;
+
+    public function __construct(AbstractManagerRegistry $managerRegistry)
+    {
+        $this->managerRegistry = $managerRegistry;
+    }
+
+    public function getDefaultConnection() : Connection
+    {
+        return $this->managerRegistry->getConnection();
+    }
+
+    public function getConnection(string $name) : Connection
+    {
+        return $this->managerRegistry->getConnection($name);
+    }
+}
diff --git a/DependencyInjection/DoctrineExtension.php b/DependencyInjection/DoctrineExtension.php
@@ -2,10 +2,12 @@
 
 namespace Doctrine\Bundle\DoctrineBundle\DependencyInjection;
 
+use Doctrine\Bundle\DoctrineBundle\Dbal\ManagerRegistryAwareConnectionProvider;
 use Doctrine\Bundle\DoctrineBundle\Dbal\RegexSchemaAssetFilter;
 use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\ServiceRepositoryCompilerPass;
 use Doctrine\Bundle\DoctrineBundle\EventSubscriber\EventSubscriberInterface;
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepositoryInterface;
+use Doctrine\DBAL\Tools\Console\ConnectionProvider;
 use Doctrine\ORM\Proxy\Autoloader;
 use Doctrine\ORM\UnitOfWork;
 use LogicException;
@@ -197,12 +199,20 @@ protected function loadDbalConnection($name, array $connection, ContainerBuilder
         }
 
         // Create a shard_manager for this connection
-        if (! isset($options['shards'])) {
+        if (isset($options['shards'])) {
+            $shardManagerDefinition = new Definition($options['shardManagerClass'], [new Reference(sprintf('doctrine.dbal.%s_connection', $name))]);
+            $container->setDefinition(sprintf('doctrine.dbal.%s_shard_manager', $name), $shardManagerDefinition);
+        }
+
+        // dbal < 2.11 BC layer
+        if (! interface_exists(ConnectionProvider::class)) {
             return;
         }
 
-        $shardManagerDefinition = new Definition($options['shardManagerClass'], [new Reference(sprintf('doctrine.dbal.%s_connection', $name))]);
-        $container->setDefinition(sprintf('doctrine.dbal.%s_shard_manager', $name), $shardManagerDefinition);
+        $container->setDefinition(
+            ManagerRegistryAwareConnectionProvider::class,
+            new Definition(ManagerRegistryAwareConnectionProvider::class, [$container->getDefinition('doctrine')])
+        );
     }
 
     protected function getConnectionOptions($connection)

diff --git a/Resources/config/dbal.xml b/Resources/config/dbal.xml
@@ -102,5 +102,11 @@
             <tag name="console.command" command="doctrine:query:sql" />
         </service>
 
+        <service id="Doctrine\DBAL\Tools\Console\Command\RunSqlCommand">
+            <argument type="service" id="Doctrine\Bundle\DoctrineBundle\Dbal\ManagerRegistryAwareConnectionProvider" on-invalid="null" />
+
+            <tag name="console.command" command="dbal:run-sql" />
+        </service>
+
     </services>
 </container>
diff --git a/UPGRADE-2.2.md b/UPGRADE-2.2.md
@@ -0,0 +1,7 @@
+UPGRADE FROM 2.1 to 2.2
+=======================
+
+Commands
+--------
+
+ * `doctrine:query:sql` command has been deprecated. Use `dbal:run-sql` command instead.