Merge pull request #6488 from sclubricants/dropPrimaryKey

Create Forge::dropPrimaryKey()

Author: kenjis

system/Database/Forge.php

@@ -456,6 +456,20 @@ public function dropKey(string $table, string $keyName)
         return $this->db->query($sql);
     }
 
+    /**
+     * Drop Primary Key
+     */
+    public function dropPrimaryKey(string $table): bool
+    {
+        $sql = sprintf(
+            'ALTER TABLE %s DROP CONSTRAINT %s',
+            $this->db->escapeIdentifiers($this->db->DBPrefix . $table),
+            $this->db->escapeIdentifiers('pk_' . $this->db->DBPrefix . $table),
+        );
+
+        return $this->db->query($sql);
+    }
+
     /**
      * @throws DatabaseException
      *

system/Database/MySQLi/Forge.php

@@ -236,4 +236,17 @@ public function dropKey(string $table, string $keyName)
 
         return $this->db->query($sql);
     }
+
+    /**
+     * Drop Primary Key
+     */
+    public function dropPrimaryKey(string $table): bool
+    {
+        $sql = sprintf(
+            'ALTER TABLE %s DROP PRIMARY KEY',
+            $this->db->escapeIdentifiers($this->db->DBPrefix . $table)
+        );
+
+        return $this->db->query($sql);
+    }
 }

system/Database/SQLite3/Forge.php

@@ -250,4 +250,16 @@ public function dropForeignKey(string $table, string $foreignName): bool
             ->dropForeignKey($foreignName)
             ->run();
     }
+
+    /**
+     * Drop Primary Key
+     */
+    public function dropPrimaryKey(string $table): bool
+    {
+        $sqlTable = new Table($this->db, $this);
+
+        return $sqlTable->fromTable($this->db->DBPrefix . $table)
+            ->dropPrimaryKey()
+            ->run();
+    }
 }

system/Database/SQLite3/Table.php

@@ -194,6 +194,20 @@ public function modifyColumn(array $field)
         return $this;
     }
 
+    /**
+     * Drops the primary key
+     */
+    public function dropPrimaryKey(): Table
+    {
+        $primaryIndexes = array_filter($this->keys, static fn ($index) => strtolower($index['type']) === 'primary');
+
+        foreach (array_keys($primaryIndexes) as $key) {
+            unset($this->keys[$key]);
+        }
+
+        return $this;
+    }
+
     /**
      * Drops a foreign key from this table so that
      * it won't be recreated in the future.

tests/system/Database/Live/ForgeTest.php

@@ -1372,4 +1372,40 @@ public function testAddTextColumnWithConstraint()
 
         $this->assertFalse($this->db->fieldExists('text_with_constraint', 'user'));
     }
+
+    public function testDropPrimaryKey()
+    {
+        $this->forge->dropTable('forge_test_users', true);
+
+        $this->forge->addField([
+            'id' => [
+                'type'       => 'INTEGER',
+                'constraint' => 11,
+            ],
+            'second_id' => [
+                'type'       => 'VARCHAR',
+                'constraint' => 50,
+            ],
+            'name' => [
+                'type'       => 'VARCHAR',
+                'constraint' => 255,
+            ],
+        ]);
+        $primaryKeys = ['id', 'second_id'];
+        $this->forge->addPrimaryKey($primaryKeys);
+        $this->forge->createTable('forge_test_users', true);
+
+        $indexes = $this->db->getIndexData('forge_test_users');
+
+        $this->assertCount(1, $indexes);
+        $this->assertSame($primaryKeys, current($indexes)->fields);
+
+        $this->forge->dropPrimaryKey('forge_test_users');
+
+        $indexes = $this->db->getIndexData('forge_test_users');
+
+        $this->assertCount(0, $indexes);
+
+        $this->forge->dropTable('forge_test_users', true);
+    }
 }

user_guide_src/source/changelogs/v4.3.0.rst

@@ -72,6 +72,7 @@ Database
 - SQLite :ref:`BaseConnection::getIndexData() <db-metadata-getindexdata>` now can return pseudo index named ``PRIMARY`` for `AUTOINCREMENT` column, and each returned index data has ``type`` property.
 - SQLSRV now automatically drops ``DEFAULT`` constraint when using :ref:`Forge::dropColumn() <db-forge-dropColumn>`.
 - ``BaseConnection::escape()`` now excludes the ``RawSql`` data type. This allows passing SQL strings into data.
+- The new method ``Forge::dropPrimaryKey()`` allows dropping the primary key on a table.
 
 Model
 =====

user_guide_src/source/dbmgmt/forge.rst

@@ -229,6 +229,13 @@ Execute a DROP KEY.
 
 .. literalinclude:: forge/020.php
 
+Dropping a Primary Key
+======================
+
+Execute a DROP PRIMARY KEY.
+
+.. literalinclude:: forge/028.php
+
 Renaming a Table
 ================
 

user_guide_src/source/dbmgmt/forge/028.php

@@ -0,0 +1,5 @@
+<?php
+
+// MySqli Produces: ALTER TABLE `tablename` DROP PRIMARY KEY
+// Others Produces: ALTER TABLE `tablename` DROP CONSTRAINT `pk_tablename`
+$forge->dropPrimaryKey('tablename');