drivers: getForeignKeys() works with multi-column foreign keys

Author: dg

src/Database/Drivers/Engine.php

@@ -73,7 +73,7 @@ function getIndexes(string $table): array;
 
 	/**
 	 * Returns metadata for all foreign keys in a table.
-	 * @return list<array{name: string, local: string, table: string, foreign: string}>
+	 * @return list<array{name: string, local: list<string>, table: string, foreign: list<string>}>
 	 */
 	function getForeignKeys(string $table): array;
 }

src/Database/Drivers/Engines/MSSQLEngine.php

@@ -201,12 +201,12 @@ public function getForeignKeys(string $table): array
 				tab1.name = ?
 			X, [$table_name]);
 
-		$id = 0;
 		while ($row = $rows->fetch()) {
-			$keys[$id]['name'] = $row['fk_name'];
-			$keys[$id]['local'] = $row['column'];
+			$id = $row['fk_name'];
+			$keys[$id]['name'] = $id;
+			$keys[$id]['local'][] = $row['column'];
 			$keys[$id]['table'] = $table_schema . '.' . $row['referenced_table'];
-			$keys[$id++]['foreign'] = $row['referenced_column'];
+			$keys[$id]['foreign'][] = $row['referenced_column'];
 		}
 
 		return array_values($keys);

src/Database/Drivers/Engines/MySQLEngine.php

@@ -155,12 +155,12 @@ public function getForeignKeys(string $table): array
 			  AND TABLE_NAME = ?
 			X, [$table]);
 
-		$id = 0;
 		while ($row = $rows->fetch()) {
-			$keys[$id]['name'] = $row['CONSTRAINT_NAME'];
-			$keys[$id]['local'] = $row['COLUMN_NAME'];
+			$id = $row['CONSTRAINT_NAME'];
+			$keys[$id]['name'] = $id;
+			$keys[$id]['local'][] = $row['COLUMN_NAME'];
 			$keys[$id]['table'] = $row['REFERENCED_TABLE_NAME'];
-			$keys[$id++]['foreign'] = $row['REFERENCED_COLUMN_NAME'];
+			$keys[$id]['foreign'][] = $row['REFERENCED_COLUMN_NAME'];
 		}
 
 		return array_values($keys);

src/Database/Drivers/Engines/PostgreSQLEngine.php

@@ -219,9 +219,14 @@ public function getForeignKeys(string $table): array
 			X, [$this->delimiteFQN($table)]);
 
 		while ($row = $rows->fetch()) {
-			$keys[] = $row;
+			$id = $row['name'];
+			$keys[$id]['name'] = $id;
+			$keys[$id]['local'][] = $row['local'];
+			$keys[$id]['table'] = $row['table'];
+			$keys[$id]['foreign'][] = $row['foreign'];
 		}
-		return $keys;
+
+		return array_values($keys);
 	}
 
 

src/Database/Drivers/Engines/SQLServerEngine.php

@@ -209,7 +209,11 @@ public function getForeignKeys(string $table): array
 			X, [$table]);
 
 		while ($row = $rows->fetch()) {
-			$keys[$row['name']] = $row;
+			$id = $row['name'];
+			$keys[$id]['name'] = $id;
+			$keys[$id]['local'][] = $row['local'];
+			$keys[$id]['table'] = $row['table'];
+			$keys[$id]['foreign'][] = $row['foreign'];
 		}
 
 		return array_values($keys);

src/Database/Drivers/Engines/SQLiteEngine.php

@@ -218,9 +218,12 @@ public function getForeignKeys(string $table): array
 		while ($row = $rows->fetch()) {
 			$id = $row['id'];
 			$keys[$id]['name'] = $id;
-			$keys[$id]['local'] = $row['from'];
+			$keys[$id]['local'][] = $row['from'];
 			$keys[$id]['table'] = $row['table'];
-			$keys[$id]['foreign'] = $row['to'];
+			$keys[$id]['foreign'][] = $row['to'];
+			if ($keys[$id]['foreign'][0] == null) {
+				$keys[$id]['foreign'] = [];
+			}
 		}
 
 		return array_values($keys);

src/Database/Reflection/Table.php

@@ -91,8 +91,8 @@ private function initForeignKeys(): void
 			$id = $row['name'];
 			$foreignTable = $this->reflection->getTable($row['table']);
 			$tmp[$id][0] = $foreignTable;
-			$tmp[$id][1][] = $this->getColumn($row['local']);
-			$tmp[$id][2][] = $foreignTable->getColumn($row['foreign']);
+			$tmp[$id][1] = array_map(fn($name) => $this->getColumn($name), $row['local']);
+			$tmp[$id][2] = array_map(fn($name) => $foreignTable->getColumn($name), $row['foreign']);
 			$tmp[$id][3] = is_string($id) ? $id : null;
 		}
 		$this->foreignKeys = array_map(fn($row) => new ForeignKey(...$row), array_values($tmp));

src/Database/Structure.php

@@ -219,17 +219,11 @@ protected function analyzeForeignKeys(array &$structure, string $table): void
 
 		$foreignKeys = $this->connection->getDatabaseEngine()->getForeignKeys($table);
 
-		$fksColumnsCounts = [];
-		foreach ($foreignKeys as $foreignKey) {
-			$tmp = &$fksColumnsCounts[$foreignKey['name']];
-			$tmp++;
-		}
-
-		usort($foreignKeys, fn($a, $b): int => $fksColumnsCounts[$b['name']] <=> $fksColumnsCounts[$a['name']]);
+		usort($foreignKeys, fn($a, $b): int => count($b['local']) <=> count($a['local']));
 
 		foreach ($foreignKeys as $row) {
-			$structure['belongsTo'][$lowerTable][$row['local']] = $row['table'];
-			$structure['hasMany'][strtolower($row['table'])][$table][] = $row['local'];
+			$structure['belongsTo'][$lowerTable][$row['local'][0]] = $row['table'];
+			$structure['hasMany'][strtolower($row['table'])][$table][] = $row['local'][0];
 		}
 
 		if (isset($structure['belongsTo'][$lowerTable])) {

tests/Database/Engine.postgre.phpt

@@ -65,9 +65,9 @@ test('Tables in schema', function () use ($connection) {
 	$foreign = $engine->getForeignKeys('one.slave');
 	Assert::same([
 		'name' => 'one_slave_fk',
-		'local' => 'one_id',
+		'local' => ['one_id'],
 		'table' => 'one.master',
-		'foreign' => 'one_id',
+		'foreign' => ['one_id'],
 	], (array) $foreign[0]);
 
 

tests/Database/Structure.phpt

@@ -74,13 +74,13 @@ class StructureTestCase extends TestCase
 		$this->connection->shouldReceive('getDatabaseEngine')->times(4)->andReturn($this->engine);
 		$this->engine->shouldReceive('getForeignKeys')->with('authors')->once()->andReturn([]);
 		$this->engine->shouldReceive('getForeignKeys')->with('Books')->once()->andReturn([
-			['local' => 'author_id', 'table' => 'authors', 'foreign' => 'id', 'name' => 'authors_fk1'],
-			['local' => 'translator_id', 'table' => 'authors', 'foreign' => 'id', 'name' => 'authors_fk2'],
+			['local' => ['author_id'], 'table' => 'authors', 'foreign' => ['id'], 'name' => 'authors_fk1'],
+			['local' => ['translator_id'], 'table' => 'authors', 'foreign' => ['id'], 'name' => 'authors_fk2'],
 		]);
 		$this->engine->shouldReceive('getForeignKeys')->with('tags')->once()->andReturn([]);
 		$this->engine->shouldReceive('getForeignKeys')->with('books_x_tags')->once()->andReturn([
-			['local' => 'book_id', 'table' => 'Books', 'foreign' => 'id', 'name' => 'books_x_tags_fk1'],
-			['local' => 'tag_id', 'table' => 'tags', 'foreign' => 'id', 'name' => 'books_x_tags_fk2'],
+			['local' => ['book_id'], 'table' => 'Books', 'foreign' => ['id'], 'name' => 'books_x_tags_fk1'],
+			['local' => ['tag_id'], 'table' => 'tags', 'foreign' => ['id'], 'name' => 'books_x_tags_fk2'],
 		]);
 
 		$this->structure = new StructureMock($this->connection, $this->storage);