Skip to content

feat(database): add foreign key support for sqlite dialect #1831

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

Closed
guvra wants to merge 1 commit into from
Closed

feat(database): add foreign key support for sqlite dialect #1831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions packages/database/src/QueryStatements/BelongsToStatement.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
namespace Tempest\Database\QueryStatements;

use Tempest\Database\Config\DatabaseDialect;
use Tempest\Database\DialectWasNotSupported;
use Tempest\Database\QueryStatement;

final readonly class BelongsToStatement implements QueryStatement
Expand Down Expand Up @@ -44,7 +43,7 @@ public function compile(DatabaseDialect $dialect): string
'ON UPDATE ' . $this->onUpdate->value,
)),
),
DatabaseDialect::POSTGRESQL => new ConstraintStatement(
DatabaseDialect::POSTGRESQL , DatabaseDialect::SQLITE => new ConstraintStatement(
$constraintName,
new RawStatement(sprintf(
'FOREIGN KEY(%s) REFERENCES %s(%s) %s %s',
Expand All @@ -55,7 +54,6 @@ public function compile(DatabaseDialect $dialect): string
'ON UPDATE ' . $this->onUpdate->value,
)),
),
DatabaseDialect::SQLITE => throw new DialectWasNotSupported(),
};

return $statement->compile($dialect);
Expand Down
2 changes: 1 addition & 1 deletion packages/database/src/QueryStatements/ConstraintNameStatement.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public function __construct(
public function compile(DatabaseDialect $dialect): string
{
return match ($dialect) {
DatabaseDialect::MYSQL, DatabaseDialect::POSTGRESQL => sprintf('CONSTRAINT %s', $this->name->compile($dialect)),
DatabaseDialect::MYSQL, DatabaseDialect::POSTGRESQL, DatabaseDialect::SQLITE => sprintf('CONSTRAINT %s', $this->name->compile($dialect)),
default => throw new DialectWasNotSupported(),
};
}
Expand Down
10 changes: 8 additions & 2 deletions packages/database/src/QueryStatements/CreateTableStatement.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,8 +378,14 @@ public function compile(DatabaseDialect $dialect): string
'CREATE TABLE %s (%s);',
new TableDefinition($this->tableName),
arr($this->statements)
// Remove BelongsTo for sqlLite as it does not support those queries
->filter(fn (QueryStatement $queryStatement) => ! ($dialect === DatabaseDialect::SQLITE && $queryStatement instanceof BelongsToStatement))
->sortByCallback(function (QueryStatement $a, QueryStatement $b) {
// Foreign keys must be defined last in SQLite
if ($a instanceof BelongsToStatement && $b instanceof BelongsToStatement) {
return 0;
}

return $a instanceof BelongsToStatement ? 1 : -1;
})
->map(fn (QueryStatement $queryStatement) => str($queryStatement->compile($dialect))->trim()->replace(' ', ' '))
->filter(fn (ImmutableString $str) => $str->isNotEmpty())
->implode(', ' . PHP_EOL . ' ')
Expand Down
21 changes: 2 additions & 19 deletions packages/database/tests/QueryStatements/AlterTableStatementTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ public function test_alter_add_belongs_to_mysql(DatabaseDialect $dialect): void
}

#[TestWith([DatabaseDialect::POSTGRESQL])]
#[TestWith([DatabaseDialect::SQLITE])]
public function test_alter_add_belongs_to_postgresql(DatabaseDialect $dialect): void
{
$expected = 'ALTER TABLE `table` ADD CONSTRAINT `fk_parent_table_foo` FOREIGN KEY(foo) REFERENCES parent(bar) ON DELETE RESTRICT ON UPDATE NO ACTION ;';
Expand All @@ -71,16 +72,6 @@ public function test_alter_add_belongs_to_postgresql(DatabaseDialect $dialect):
$this->assertEqualsIgnoringCase($expected, $normalized);
}

#[TestWith([DatabaseDialect::SQLITE])]
public function test_alter_add_belongs_to_unsupported(DatabaseDialect $dialect): void
{
$this->expectException(DialectWasNotSupported::class);

new AlterTableStatement('table')
->add(new BelongsToStatement('table.foo', 'parent.bar'))
->compile($dialect);
}

#[TestWith([DatabaseDialect::MYSQL])]
#[TestWith([DatabaseDialect::POSTGRESQL])]
#[TestWith([DatabaseDialect::SQLITE])]
Expand All @@ -98,6 +89,7 @@ public function test_alter_table_drop_column(DatabaseDialect $dialect): void

#[TestWith([DatabaseDialect::MYSQL, 'ALTER TABLE `table` DROP CONSTRAINT `foo` ;'])]
#[TestWith([DatabaseDialect::POSTGRESQL, 'ALTER TABLE `table` DROP CONSTRAINT `foo` ;'])]
#[TestWith([DatabaseDialect::SQLITE, 'ALTER TABLE `table` DROP CONSTRAINT `foo` ;'])]
public function test_alter_table_drop_constraint(DatabaseDialect $dialect, string $expected): void
{
$statement = new AlterTableStatement('table')
Expand All @@ -109,15 +101,6 @@ public function test_alter_table_drop_constraint(DatabaseDialect $dialect, strin
$this->assertEqualsIgnoringCase($expected, $normalized);
}

#[TestWith([DatabaseDialect::SQLITE])]
public function test_alter_table_drop_constraint_unsupported_dialects(DatabaseDialect $dialect): void
{
$this->expectException(DialectWasNotSupported::class);
new AlterTableStatement('table')
->dropConstraint('foo')
->compile($dialect);
}

#[TestWith([DatabaseDialect::MYSQL, 'ALTER TABLE `table` ADD `foo` VARCHAR(42) DEFAULT \'bar\' NOT NULL ;'])]
#[TestWith([
DatabaseDialect::POSTGRESQL,
Expand Down
22 changes: 12 additions & 10 deletions packages/database/tests/QueryStatements/CreateTableStatementTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ public static function provide_fk_create_table_database_drivers(): Generator
CREATE TABLE `books` (
`id` INTEGER PRIMARY KEY AUTO_INCREMENT,
`author_id` INTEGER NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY books(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION,
`name` VARCHAR(255) NOT NULL
`name` VARCHAR(255) NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY books(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION
);
SQL,
];
Expand All @@ -110,8 +110,8 @@ public static function provide_fk_create_table_database_drivers(): Generator
CREATE TABLE `books` (
`id` SERIAL PRIMARY KEY,
`author_id` INTEGER NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION,
`name` VARCHAR(255) NOT NULL
`name` VARCHAR(255) NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION
);
SQL,
];
Expand All @@ -122,7 +122,8 @@ public static function provide_fk_create_table_database_drivers(): Generator
CREATE TABLE `books` (
`id` INTEGER PRIMARY KEY AUTOINCREMENT,
`author_id` INTEGER NOT NULL,
`name` VARCHAR(255) NOT NULL
`name` VARCHAR(255) NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION
);
SQL,
];
Expand All @@ -149,8 +150,8 @@ public static function provide_fk_create_table_database_drivers_explicit(): Gene
CREATE TABLE `books` (
`id` INTEGER PRIMARY KEY AUTO_INCREMENT,
`author_id` INTEGER NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY books(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION,
`name` VARCHAR(255) NOT NULL
`name` VARCHAR(255) NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY books(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION
);
SQL,
];
Expand All @@ -161,8 +162,8 @@ public static function provide_fk_create_table_database_drivers_explicit(): Gene
CREATE TABLE `books` (
`id` SERIAL PRIMARY KEY,
`author_id` INTEGER NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION,
`name` VARCHAR(255) NOT NULL
`name` VARCHAR(255) NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION
);
SQL,
];
Expand All @@ -173,7 +174,8 @@ public static function provide_fk_create_table_database_drivers_explicit(): Gene
CREATE TABLE `books` (
`id` INTEGER PRIMARY KEY AUTOINCREMENT,
`author_id` INTEGER NOT NULL,
`name` VARCHAR(255) NOT NULL
`name` VARCHAR(255) NOT NULL,
CONSTRAINT `fk_authors_books_author_id` FOREIGN KEY(author_id) REFERENCES authors(id) ON DELETE CASCADE ON UPDATE NO ACTION
);
SQL,
];
Expand Down
Loading