Remove support for primary indexes

Author: morozov

UPGRADE.md

@@ -8,6 +8,19 @@ awareness about deprecated code.
 
 # Upgrade to 5.0
 
+## BC BREAK: Changes in features related to primary key constraints
+
+1. The `Index` class can no longer represent a primary key constraint. As a result:
+    1. The `Table::getIndexes()` and `AbstractSchemaManager::listTableIndexes()` methods no longer return the index that  
+       backs the primary key constraint.
+    2. The index that backs the primary key constraint is no longer considered during implicit index management.
+2. The `Table::getPrimaryKey()` and `Table::setPrimaryKey()` methods have been removed.
+3. The `Table::renameIndex()` method can no longer be used to rename a primary key constraint.
+4. The `AbstractPlatform::getCreatePrimaryKeySQL()` method has been removed.
+5. The `PostgreSQLPlatform::getDropIndexSQL()` method no longer builds SQL for dropping a primary key constraint. As a
+   result, dropping a primary key constraint on Postgres is now only possible if the constraint name is known (e.g. in
+   the result of database schema introspection).
+
 ## BC BREAK: `INTEGER PRIMARY KEY` columns are no longer introspected as auto-incremented on SQLite
 
 Even though `INTEGER PRIMARY KEY` columns are effectively auto-incremented on SQLite, DBAL no longer introspects them as

src/Platforms/AbstractMySQLPlatform.php

@@ -392,10 +392,6 @@ protected function getPreAlterTableIndexForeignKeySQL(TableDiff $diff): array
 
                 $indexClause = 'INDEX ' . $addedIndex->getObjectName()->toSQL($this);
 
-                if ($addedIndex->isPrimary()) {
-                    continue;
-                }
-
                 if ($addedIndex->isUnique()) {
                     $indexClause = 'UNIQUE ' . $indexClause;
                 }

src/Platforms/AbstractPlatform.php

@@ -44,7 +44,6 @@
 use Doctrine\DBAL\Types\Exception\TypeNotFound;
 use Doctrine\DBAL\Types\Exception\TypesException;
 use Doctrine\DBAL\Types\Type;
-use Doctrine\Deprecations\Deprecation;
 
 use function addcslashes;
 use function array_map;
@@ -842,10 +841,6 @@ private function buildCreateTableSQL(Table $table, bool $createForeignKeys): arr
         $parameters['foreignKeys']       = [];
 
         foreach ($table->getIndexes() as $index) {
-            if ($index->isPrimary()) {
-                continue;
-            }
-
             $parameters['indexes'][] = $index;
         }
 
@@ -1112,10 +1107,6 @@ public function getCreateIndexSQL(Index $index, string $table): string
             ));
         }
 
-        if ($index->isPrimary()) {
-            return $this->getCreatePrimaryKeySQL($index, $table);
-        }
-
         $query  = 'CREATE ' . $this->getCreateIndexSQLFlags($index) . 'INDEX ' . $name . ' ON ' . $table;
         $query .= ' (' . implode(', ', $index->getQuotedColumns($this)) . ')' . $this->getPartialIndexSQL($index);
 
@@ -1142,23 +1133,6 @@ protected function getCreateIndexSQLFlags(Index $index): string
         return $index->isUnique() ? 'UNIQUE ' : '';
     }
 
-    /**
-     * Returns the SQL to create an unnamed primary key constraint.
-     *
-     * @deprecated
-     */
-    public function getCreatePrimaryKeySQL(Index $index, string $table): string
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/6867',
-            '%s() is deprecated.',
-            __METHOD__,
-        );
-
-        return 'ALTER TABLE ' . $table . ' ADD PRIMARY KEY (' . implode(', ', $index->getQuotedColumns($this)) . ')';
-    }
-
     /**
      * Returns the SQL to create a named schema.
      */

src/Platforms/OraclePlatform.php

@@ -24,7 +24,6 @@
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types\BinaryType;
 use Doctrine\DBAL\Types\Types;
-use Doctrine\Deprecations\Deprecation;
 use InvalidArgumentException;
 
 use function array_merge;
@@ -134,20 +133,6 @@ public function getBitOrComparisonExpression(string $value1, string $value2): st
                 . '+' . $value2 . ')';
     }
 
-    /** @deprecated */
-    public function getCreatePrimaryKeySQL(Index $index, string $table): string
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/6867',
-            '%s() is deprecated.',
-            __METHOD__,
-        );
-
-        return 'ALTER TABLE ' . $table . ' ADD CONSTRAINT ' . $index->getObjectName()->toSQL($this)
-            . ' PRIMARY KEY (' . implode(', ', $index->getQuotedColumns($this)) . ')';
-    }
-
     /**
      * {@inheritDoc}
      *

src/Platforms/PostgreSQLPlatform.php

@@ -19,7 +19,6 @@
 use Doctrine\DBAL\Schema\TableDiff;
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types\Types;
-use Doctrine\Deprecations\Deprecation;
 use UnexpectedValueException;
 
 use function array_merge;
@@ -32,9 +31,7 @@
 use function is_string;
 use function sprintf;
 use function str_contains;
-use function str_ends_with;
 use function strtolower;
-use function substr;
 use function trim;
 
 /**
@@ -385,24 +382,6 @@ public function getDropForeignKeySQL(string $foreignKey, string $table): string
 
     public function getDropIndexSQL(string $name, string $table): string
     {
-        if (str_ends_with($table, '"')) {
-            $primaryKeyName = substr($table, 0, -1) . '_pkey"';
-        } else {
-            $primaryKeyName = $table . '_pkey';
-        }
-
-        if ($name === '"primary"' || $name === $primaryKeyName) {
-            Deprecation::triggerIfCalledFromOutside(
-                'doctrine/dbal',
-                'https://github.com/doctrine/dbal/pull/6867',
-                'Building the SQL for dropping primary key constraint via %s() is deprecated. Use'
-                    . ' getDropConstraintSQL() instead.',
-                __METHOD__,
-            );
-
-            return $this->getDropConstraintSQL($primaryKeyName, $table);
-        }
-
         if (str_contains($table, '.')) {
             [$schema] = explode('.', $table);
             $name     = $schema . '.' . $name;

src/Platforms/SQLServerPlatform.php

@@ -23,7 +23,6 @@
 use Doctrine\DBAL\SQL\Builder\SelectSQLBuilder;
 use Doctrine\DBAL\TransactionIsolationLevel;
 use Doctrine\DBAL\Types\Types;
-use Doctrine\Deprecations\Deprecation;
 use InvalidArgumentException;
 
 use function array_map;
@@ -240,25 +239,6 @@ protected function _getCreateTableSQL(OptionallyQualifiedName $tableName, array
         return array_merge($sql, $commentsSql, $defaultConstraintsSql);
     }
 
-    /** @deprecated */
-    public function getCreatePrimaryKeySQL(Index $index, string $table): string
-    {
-        Deprecation::triggerIfCalledFromOutside(
-            'doctrine/dbal',
-            'https://github.com/doctrine/dbal/pull/6867',
-            '%s() is deprecated.',
-            __METHOD__,
-        );
-
-        $sql = 'ALTER TABLE ' . $table . ' ADD PRIMARY KEY';
-
-        if ($index->hasFlag('nonclustered')) {
-            $sql .= ' NONCLUSTERED';
-        }
-
-        return $sql . ' (' . implode(', ', $index->getQuotedColumns($this)) . ')';
-    }
-
     private function unquoteSingleIdentifier(string $possiblyQuotedName): string
     {
         return str_starts_with($possiblyQuotedName, '[') && str_ends_with($possiblyQuotedName, ']')

src/Platforms/SQLitePlatform.php

@@ -502,10 +502,6 @@ protected function getPostAlterTableIndexForeignKeySQL(TableDiff $diff): array
         $sql = [];
 
         foreach ($this->getIndexesInAlteredTable($diff) as $index) {
-            if ($index->isPrimary()) {
-                continue;
-            }
-
             $sql[] = $this->getCreateIndexSQL($index, $table->getObjectName()->toSQL($this));
         }
 
@@ -562,10 +558,6 @@ public function getCreateIndexSQL(Index $index, string $table): string
             ));
         }
 
-        if ($index->isPrimary()) {
-            return $this->getCreatePrimaryKeySQL($index, $table);
-        }
-
         if (strpos($table, '.') !== false) {
             [$schema, $table] = explode('.', $table);
             $name             = $schema . '.' . $name;
@@ -591,12 +583,6 @@ public function getDropTablesSQL(array $tables): array
         return $sql;
     }
 
-    /** @deprecated */
-    public function getCreatePrimaryKeySQL(Index $index, string $table): string
-    {
-        throw NotSupported::new(__METHOD__);
-    }
-
     public function getCreateForeignKeySQL(ForeignKeyConstraint $foreignKey, string $table): string
     {
         throw NotSupported::new(__METHOD__);
@@ -850,7 +836,7 @@ private function getIndexesInAlteredTable(TableDiff $diff): array
                 $index->getName(),
                 $indexColumns,
                 $index->isUnique(),
-                $index->isPrimary(),
+                false,
                 $index->getFlags(),
             );
         }

src/Schema/Comparator.php

@@ -208,10 +208,6 @@ public function compareTables(Table $oldTable, Table $newTable): TableDiff
 
         // See if all the indexes from the old table exist in the new one
         foreach ($newIndexes as $newIndexName => $newIndex) {
-            if ($newIndex->isPrimary()) {
-                continue;
-            }
-
             if ($oldTable->hasIndex($newIndexName)) {
                 continue;
             }
@@ -221,10 +217,6 @@ public function compareTables(Table $oldTable, Table $newTable): TableDiff
 
         // See if there are any removed indexes in the new table
         foreach ($oldIndexes as $oldIndexName => $oldIndex) {
-            if ($oldIndex->isPrimary()) {
-                continue;
-            }
-
             if (! $newTable->hasIndex($oldIndexName)) {
                 $droppedIndexes[$oldIndexName] = $oldIndex;
 

src/Schema/Exception/InvalidIndexDefinition.php

@@ -4,7 +4,6 @@
 
 namespace Doctrine\DBAL\Schema\Exception;
 
-use Doctrine\DBAL\Schema\Name\UnqualifiedName;
 use Doctrine\DBAL\Schema\SchemaException;
 use LogicException;
 
@@ -19,24 +18,16 @@ public static function columnNamesNotSet(): self
         return new self('Index column names are not set.');
     }
 
-    public static function primaryKeyIndexHasColumnLengths(): self
-    {
-        return new self('Primary key index cannot have column lengths.');
-    }
-
-    public static function primaryKeyIndexOnANullableColumn(UnqualifiedName $columnName): self
-    {
-        return new self(sprintf(
-            'Primary key index cannot use nullable column %s.',
-            $columnName->toString(),
-        ));
-    }
-
     public static function invalidColumnLength(mixed $length): self
     {
         return new self(sprintf(
             'Indexed column length must be an integer, %s given.',
             is_object($length) ? $length::class : gettype($length),
         ));
     }
+
+    public static function fromPrimaryIndex(): self
+    {
+        return new self('Primary indexes are not supported.');
+    }
 }