Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add a primary key to an existing table #8031

Merged
merged 3 commits into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion phpstan-baseline.php
Original file line number Diff line number Diff line change
Expand Up @@ -1238,7 +1238,7 @@
];
$ignoreErrors[] = [
'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
'count' => 16,
'count' => 13,
'path' => __DIR__ . '/system/Database/Forge.php',
];
$ignoreErrors[] = [
Expand Down
14 changes: 6 additions & 8 deletions system/Database/Forge.php
Original file line number Diff line number Diff line change
Expand Up @@ -1073,7 +1073,7 @@ public function processIndexes(string $table): bool
$sqls = [];
$fk = $this->foreignKeys;

if (empty($this->fields)) {
if ($this->fields === []) {
$this->fields = array_flip(array_map(
static fn ($columnName) => $columnName->name,
$this->db->getFieldData($this->db->DBPrefix . $table)
Expand All @@ -1082,20 +1082,18 @@ public function processIndexes(string $table): bool

$fields = $this->fields;

if (! empty($this->keys)) {
if ($this->keys !== []) {
$sqls = $this->_processIndexes($this->db->DBPrefix . $table, true);
}

$pk = $this->_processPrimaryKeys($table, true);

if ($pk !== '') {
$sqls[] = $pk;
}
if ($this->primaryKeys !== []) {
$sqls[] = $this->_processPrimaryKeys($table, true);
}

$this->foreignKeys = $fk;
$this->fields = $fields;

if (! empty($this->foreignKeys)) {
if ($this->foreignKeys !== []) {
$sqls = array_merge($sqls, $this->_processForeignKeys($table, true));
}

Expand Down
81 changes: 81 additions & 0 deletions tests/system/Database/Live/ForgeTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
$this->assertTrue($databaseCreated);
}

public function testCreateDatabaseIfNotExists(): void

Check warning on line 60 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 0.81s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testCreateDatabaseIfNotExists
{
if ($this->db->DBDriver === 'OCI8') {
$this->markTestSkipped('OCI8 does not support create database.');
Expand All @@ -72,7 +72,7 @@
$this->assertTrue($databaseCreateIfNotExists);
}

public function testCreateDatabaseIfNotExistsWithDb(): void

Check warning on line 75 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 0.82s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testCreateDatabaseIfNotExistsWithDb
{
if ($this->db->DBDriver === 'OCI8') {
$this->markTestSkipped('OCI8 does not support create database.');
Expand Down Expand Up @@ -384,7 +384,7 @@
$this->forge->createTable('forge_test_table');
}

public function testRenameTable(): void

Check warning on line 387 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 0.96s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testRenameTable
{
$this->forge->dropTable('forge_test_table_dummy', true);

Expand Down Expand Up @@ -440,7 +440,7 @@
$this->forge->dropTable('', true);
}

public function testForeignKey(): void

Check warning on line 443 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, OCI8, 5.7) / Database Live Tests

Took 4.07s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testForeignKey

Check warning on line 443 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 1.04s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testForeignKey
{
$this->forge->dropTable('forge_test_invoices', true);
$this->forge->dropTable('forge_test_users', true);
Expand Down Expand Up @@ -544,7 +544,7 @@
/**
* @see https://github.com/codeigniter4/CodeIgniter4/issues/4310
*/
public function testCompositeForeignKey(): void

Check warning on line 547 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 0.88s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testCompositeForeignKey
{
$this->forge->dropTable('forge_test_invoices', true);
$this->forge->dropTable('forge_test_users', true);
Expand Down Expand Up @@ -730,7 +730,7 @@
$this->forge->createTable('forge_test_invoices', true, $attributes);
}

public function testDropForeignKey(): void

Check warning on line 733 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 0.97s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testDropForeignKey
{
$this->forge->dropTable('forge_test_invoices', true);
$this->forge->dropTable('forge_test_users', true);
Expand Down Expand Up @@ -1182,7 +1182,7 @@
$this->forge->dropTable('forge_test_1', true);
}

public function testSetKeyNames(): void

Check warning on line 1185 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, OCI8, 5.7) / Database Live Tests

Took 1.87s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testSetKeyNames
{
$this->forge->dropTable('forge_test_1', true);

Expand Down Expand Up @@ -1318,7 +1318,7 @@
$this->forge->dropTable('forge_test_three', true);
}

public function testModifyColumnNullTrue(): void

Check warning on line 1321 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 0.90s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testModifyColumnNullTrue
{
$this->forge->dropTable('forge_test_modify', true);

Expand Down Expand Up @@ -1430,7 +1430,7 @@
}
}

public function testDropMultipleColumnWithArray(): void

Check warning on line 1433 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 0.85s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testDropMultipleColumnWithArray
{
$this->forge->dropTable('forge_test_two', true);

Expand Down Expand Up @@ -1506,7 +1506,7 @@
$this->forge->dropTable('forge_test_four', true);
}

public function testDropKey(): void

Check warning on line 1509 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, OCI8, 5.7) / Database Live Tests

Took 1.61s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testDropKey
{
$this->forge->dropTable('key_test_users', true);
$keyName = 'key_test_users_id';
Expand Down Expand Up @@ -1593,7 +1593,7 @@
$this->forge->dropTable('forge_test_users', true);
}

public function testProcessIndexes(): void

Check warning on line 1596 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, OCI8, 5.7) / Database Live Tests

Took 2.35s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testProcessIndexes

Check warning on line 1596 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 1.00s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testProcessIndexes
{
// make sure tables don't exist
$this->forge->dropTable('actions', true);
Expand Down Expand Up @@ -1657,6 +1657,87 @@
$this->forge->dropTable('user2', true);
}

public function testProcessIndexesWithKeyOnly(): void
{
// make sure tables don't exist
$this->forge->dropTable('actions', true);

$this->createActionsTable();
$this->forge->addKey('name', false, false, 'db_actions_name');

// create indexes
$this->forge->processIndexes('actions');

// get a list of all indexes
$allIndexes = $this->db->getIndexData('actions');

// check that db_actions_name key exists
$indexes = array_filter(
$allIndexes,
static fn ($index) => ($index->name === 'db_actions_name')
&& ($index->fields === [0 => 'name'])
);
$this->assertCount(1, $indexes);

// drop tables to avoid any future conflicts
$this->forge->dropTable('actions', true);
}

public function testProcessIndexesWithPrimaryKeyOnly(): void
{
// make sure tables don't exist
$this->forge->dropTable('actions', true);

$this->createActionsTable();
$this->forge->addPrimaryKey('id');

// create indexes
$this->forge->processIndexes('actions');

// get a list of all indexes
$allIndexes = $this->db->getIndexData('actions');

// check that the primary key exists
$indexes = array_filter(
$allIndexes,
static fn ($index) => $index->type === 'PRIMARY'
);
$this->assertCount(1, $indexes);

// drop tables to avoid any future conflicts
$this->forge->dropTable('actions', true);
}

public function testProcessIndexesWithForeignKeyOnly(): void

Check warning on line 1711 in tests/system/Database/Live/ForgeTest.php

View workflow job for this annotation

GitHub Actions / database-live-tests (8.1, SQLSRV, 5.7) / Database Live Tests

Took 0.89s from 0.50s limit to run CodeIgniter\\Database\\Live\\ForgeTest::testProcessIndexesWithForeignKeyOnly
{
// make sure tables don't exist
$this->forge->dropTable('actions', true);
$this->forge->dropTable('user2', true);

$this->createUser2TableWithKeys();
$this->populateUser2Table();
$this->createActionsTable();

// SQLite does not support custom foreign key name
if ($this->db->DBDriver === 'SQLite3') {
$this->forge->addForeignKey('userid', 'user', 'id');
$this->forge->addForeignKey('userid2', 'user2', 'id');
} else {
$this->forge->addForeignKey('userid', 'user', 'id', '', '', 'db_actions_userid_foreign');
$this->forge->addForeignKey('userid2', 'user2', 'id', '', '', 'db_actions_userid2_foreign');
}

// create indexes
$this->forge->processIndexes('actions');

// check that the two foreign keys exist
$this->assertCount(2, $this->db->getForeignKeyData('actions'));

// drop tables to avoid any future conflicts
$this->forge->dropTable('actions', true);
$this->forge->dropTable('user2', true);
}

private function createUser2TableWithKeys(): void
{
$fields = [
Expand Down
2 changes: 2 additions & 0 deletions user_guide_src/source/changelogs/v4.4.2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Bugs Fixed
Page Not Found.
- **Spark:** Fixed a bug that caused spark to not display exceptions in the
production mode or to display backtrace in json when an exception occurred.
- **Forge:** Fixed a bug where adding a Primary Key to an existing table was
ignored if there were no other Keys added too.

See the repo's
`CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
Expand Down
Loading