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.

Sign up for GitHub

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

Use cakephp/database for postgres schema reflection #798

Merged
merged 2 commits into from
Jan 5, 2025
Merged

Use cakephp/database for postgres schema reflection #798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0a2456
Use cakephp/database for postgres schema reflection
markstory Jan 5, 2025
d6afd43
Fix phpstan failure
markstory Jan 5, 2025
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
147 changes: 75 additions & 72 deletions src/Db/Adapter/PostgresAdapter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
namespace Migrations\Db\Adapter;

use Cake\Database\Connection;
use Cake\Database\Schema\SchemaDialect;
use InvalidArgumentException;
use Migrations\Db\AlterInstructions;
use Migrations\Db\Literal;
Expand Down Expand Up @@ -123,6 +124,18 @@ public function rollbackTransaction(): void
$this->getConnection()->rollback();
}

/**
* Get the schema dialect for this adapter.
*
* @return \Cake\Database\Schema\SchemaDialect
*/
protected function getSchemaDialect(): SchemaDialect
{
$driver = $this->getConnection()->getDriver();

return $driver->schemaDialect();
}

/**
* Quotes a schema name for use in a query.
*
Expand All @@ -149,7 +162,9 @@ public function quoteTableName(string $tableName): string
*/
public function quoteColumnName(string $columnName): string
{
return '"' . $columnName . '"';
$driver = $this->getConnection()->getDriver();

return $driver->quoteIdentifier($columnName);
}

/**
Expand All @@ -160,20 +175,16 @@ public function hasTable(string $tableName): bool
if ($this->hasCreatedTable($tableName)) {
return true;
}

$parts = $this->getSchemaName($tableName);
$connection = $this->getConnection();
$stmt = $connection->execute(
'SELECT *
FROM information_schema.tables
WHERE table_schema = ?
AND table_name = ?',
[$parts['schema'], $parts['table']]
);
$count = $stmt->rowCount();
$stmt->closeCursor();
$tableName = $parts['table'];

return $count === 1;
$dialect = $this->getSchemaDialect();
[$query, $params] = $dialect->listTablesSql(['schema' => $parts['schema']]);

$rows = $this->query($query, $params)->fetchAll();
$tables = array_column($rows, 0);

return in_array($tableName, $tables, true);
}

/**
Expand Down Expand Up @@ -376,6 +387,10 @@ public function getColumns(string $tableName): array
{
$parts = $this->getSchemaName($tableName);
$columns = [];

// TODO We can't use cakephp/database here as several attributes are missing
// from the query cakephp prepares. We'll need to expand the cakephp/database
// query in a future release.
$sql = sprintf(
'SELECT column_name, data_type, udt_name, is_identity, is_nullable,
column_default, character_maximum_length, numeric_precision, numeric_scale,
Expand Down Expand Up @@ -673,40 +688,25 @@ protected function getDropColumnInstructions(string $tableName, string $columnNa
*/
protected function getIndexes(string $tableName): array
{
$dialect = $this->getSchemaDialect();
$parts = $this->getSchemaName($tableName);

[$query, $params] = $dialect->describeIndexSql($parts['table'], [
'schema' => $parts['schema'],
'database' => $this->getOption('database'),
]);
$rows = $this->query($query, $params)->fetchAll('assoc');

$indexes = [];
$sql = sprintf(
"SELECT
i.relname AS index_name,
a.attname AS column_name
FROM
pg_class t,
pg_class i,
pg_index ix,
pg_attribute a,
pg_namespace nsp
WHERE
t.oid = ix.indrelid
AND i.oid = ix.indexrelid
AND a.attrelid = t.oid
AND a.attnum = ANY(ix.indkey)
AND t.relnamespace = nsp.oid
AND nsp.nspname = %s
AND t.relkind = 'r'
AND t.relname = %s
ORDER BY
t.relname,
i.relname",
$this->quoteString($parts['schema']),
$this->quoteString($parts['table'])
);
$rows = $this->fetchAll($sql);
foreach ($rows as $row) {
if (!isset($indexes[$row['index_name']])) {
$indexes[$row['index_name']] = ['columns' => []];
if (!isset($indexes[$row['relname']])) {
$indexes[$row['relname']] = [
'isPrimary' => false,
'columns' => [],
];
}
$indexes[$row['index_name']]['columns'][] = $row['column_name'];
$indexes[$row['relname']]['columns'][] = $row['attname'];
$indexes[$row['relname']]['isPrimary'] = $row['indisprimary'];
}

return $indexes;
Expand Down Expand Up @@ -832,34 +832,17 @@ public function hasPrimaryKey(string $tableName, $columns, ?string $constraint =
*/
public function getPrimaryKey(string $tableName): array
{
$parts = $this->getSchemaName($tableName);
$params = [
$parts['schema'],
$parts['table'],
];
$rows = $this->query(
"SELECT
tc.constraint_name,
kcu.column_name
FROM information_schema.table_constraints AS tc
JOIN information_schema.key_column_usage AS kcu
ON tc.constraint_name = kcu.constraint_name
WHERE constraint_type = 'PRIMARY KEY'
AND tc.table_schema = ?
AND tc.table_name = ?
ORDER BY kcu.position_in_unique_constraint",
$params,
)->fetchAll('assoc');
$indexes = $this->getIndexes($tableName);

$primaryKey = [
'columns' => [],
];
foreach ($rows as $row) {
$primaryKey['constraint'] = $row['constraint_name'];
$primaryKey['columns'][] = $row['column_name'];
foreach ($indexes as $name => $index) {
if ($index['isPrimary']) {
$index['constraint'] = $name;

return $index;
}
}

return $primaryKey;
return ['columns' => []];
}

/**
Expand Down Expand Up @@ -897,6 +880,26 @@ public function hasForeignKey(string $tableName, $columns, ?string $constraint =
*/
protected function getForeignKeys(string $tableName): array
{
$parts = $this->getSchemaName($tableName);

// This should work but is blocked on a bug in cakephp/database
// The field ordering after reflection is lost
/*
$dialect = $this->getSchemaDialect();
[$query, $params] = $dialect->describeForeignKeySql($parts['table'], [
'schema' => $parts['schema'],
'database' => $this->getOption('database'),
]);
$rows = $this->query($query, $params)->fetchAll('assoc');
foreach ($rows as $row) {
$name = $row['name'];
$foreignKeys[$name]['table'] = $parts['table'];
$foreignKeys[$name]['columns'][] = $row['column_name'];
$foreignKeys[$name]['referenced_table'] = $row['references_table'];
$foreignKeys[$name]['references_columns'][] = $row['references_field'];
}
*/

$parts = $this->getSchemaName($tableName);
$foreignKeys = [];
$params = [
Expand Down Expand Up @@ -1556,7 +1559,7 @@ public function insert(Table $table, array $row): void
$this->quoteTableName($table->getName())
);
$columns = array_keys($row);
$sql .= '(' . implode(', ', array_map([$this, 'quoteColumnName'], $columns)) . ')';
$sql .= '(' . implode(', ', array_map($this->quoteColumnName(...), $columns)) . ')';

foreach ($row as $column => $value) {
if (is_bool($value)) {
Expand All @@ -1570,7 +1573,7 @@ public function insert(Table $table, array $row): void
}

if ($this->isDryRunEnabled()) {
$sql .= ' ' . $override . 'VALUES (' . implode(', ', array_map([$this, 'quoteValue'], $row)) . ');';
$sql .= ' ' . $override . 'VALUES (' . implode(', ', array_map($this->quoteValue(...), $row)) . ');';
$this->io->out($sql);
} else {
$values = [];
Expand Down Expand Up @@ -1600,19 +1603,19 @@ public function bulkinsert(Table $table, array $rows): void
$this->quoteTableName($table->getName())
);
$current = current($rows);
/** @var array<string> $keys */
$keys = array_keys($current);

$override = '';
if ($this->useIdentity) {
$override = self::OVERRIDE_SYSTEM_VALUE . ' ';
}

$callback = fn ($key) => $this->quoteColumnName($key);
$sql .= '(' . implode(', ', array_map($callback, $keys)) . ') ' . $override . 'VALUES ';
$sql .= '(' . implode(', ', array_map($this->quoteColumnName(...), $keys)) . ') ' . $override . 'VALUES ';

if ($this->isDryRunEnabled()) {
$values = array_map(function ($row) {
return '(' . implode(', ', array_map([$this, 'quoteValue'], $row)) . ')';
return '(' . implode(', ', array_map($this->quoteValue(...), $row)) . ')';
}, $rows);
$sql .= implode(', ', $values) . ';';
$this->io->out($sql);
Expand Down
7 changes: 5 additions & 2 deletions tests/TestCase/Db/Adapter/PostgresAdapterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,8 @@ public function testSchemaTableIsCreatedWithPrimaryKey()
public function testQuoteSchemaName()
{
$this->assertEquals('"schema"', $this->adapter->quoteSchemaName('schema'));
$this->assertEquals('"schema.schema"', $this->adapter->quoteSchemaName('schema.schema'));
// No . is supported in schema name.
$this->assertEquals('"schema"."schema"', $this->adapter->quoteSchemaName('schema.schema'));
}

public function testGetGlobalSchemaName()
Expand Down Expand Up @@ -172,7 +173,8 @@ public function testQuoteTableName()
public function testQuoteColumnName()
{
$this->assertEquals('"string"', $this->adapter->quoteColumnName('string'));
$this->assertEquals('"string.string"', $this->adapter->quoteColumnName('string.string'));
// No . is supported in column name.
$this->assertEquals('"string"."string"', $this->adapter->quoteColumnName('string.string'));
}

public function testCreateTable()
Expand Down Expand Up @@ -1686,6 +1688,7 @@ public function testDropForeignKeyWithMultipleColumns()
->save();

$this->assertTrue($this->adapter->hasForeignKey($table->getName(), ['ref_table_id', 'ref_table_field1']));

$this->adapter->dropForeignKey($table->getName(), ['ref_table_id', 'ref_table_field1']);
$this->assertFalse($this->adapter->hasForeignKey($table->getName(), ['ref_table_id', 'ref_table_field1']));
$this->assertTrue(
Expand Down
Loading