Merge pull request #5431 from morozov/deprecate-keyword-validator

Deprecate checking keywords in schema object names

UPGRADE.md

@@ -8,6 +8,11 @@ awareness about deprecated code.
 
 # Upgrade to 3.4
 
+## Deprecated the functionality of checking schema for the usage of reserved keywords.
+
+The `dbal:reserved-words` console command and the `ReservedWordsCommand` and `ReservedKeywordsValidator` classes
+have been deprecated. Use the documentation on the used database platform(s) instead.
+
 ## Deprecated `CreateSchemaSqlCollector` and `DropSchemaSqlCollector`.
 
 The `CreateSchemaSqlCollector` and `DropSchemaSqlCollector` classes have been deprecated in favor of

psalm.xml.dist

@@ -81,6 +81,11 @@
                 -->
                 <referencedClass name="Doctrine\DBAL\Schema\Visitor\CreateSchemaSqlCollector"/>
                 <referencedClass name="Doctrine\DBAL\Schema\Visitor\DropSchemaSqlCollector"/>
+                <!--
+                    TODO: remove in 4.0.0
+                -->
+                <referencedClass name="Doctrine\DBAL\Platforms\Keywords\ReservedKeywordsValidator"/>
+                <referencedClass name="Doctrine\DBAL\Tools\Console\Command\ReservedWordsCommand"/>
             </errorLevel>
         </DeprecatedClass>
         <DeprecatedInterface>

src/Platforms/Keywords/ReservedKeywordsValidator.php

@@ -9,11 +9,15 @@
 use Doctrine\DBAL\Schema\Sequence;
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Schema\Visitor\Visitor;
+use Doctrine\Deprecations\Deprecation;
 
 use function count;
 use function implode;
 use function str_replace;
 
+/**
+ * @deprecated Use database documentation instead.
+ */
 class ReservedKeywordsValidator implements Visitor
 {
     /** @var KeywordList[] */
@@ -27,6 +31,12 @@ class ReservedKeywordsValidator implements Visitor
      */
     public function __construct(array $keywordLists)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5431',
+            'ReservedKeywordsValidator is deprecated. Use database documentation instead.'
+        );
+
         $this->keywordLists = $keywordLists;
     }
 

src/Tools/Console/Command/ReservedWordsCommand.php

@@ -31,6 +31,9 @@
 use function is_array;
 use function is_string;
 
+/**
+ * @deprecated Use database documentation instead.
+ */
 class ReservedWordsCommand extends Command
 {
     /** @var array<string,KeywordList> */
@@ -41,6 +44,12 @@ class ReservedWordsCommand extends Command
 
     public function __construct(ConnectionProvider $connectionProvider)
     {
+        Deprecation::triggerIfCalledFromOutside(
+            'doctrine/dbal',
+            'https://github.com/doctrine/dbal/pull/5431',
+            'ReservedWordsCommand is deprecated. Use database documentation instead.'
+        );
+
         parent::__construct();
         $this->connectionProvider = $connectionProvider;
 
@@ -139,6 +148,12 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        $output->writeln(
+            '<comment>The <info>dbal:reserved-words</info> command is deprecated.</comment>'
+                . ' Use the documentation on the used database platform(s) instead.'
+        );
+        $output->writeln('');
+
         $conn = $this->getConnection($input);
 
         $keywordLists = $input->getOption('list');