Skip to content

feat(adding_foreign_key_constraint): allow when create table in transaction #703 #713

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

Merged
kodiakhq merged 1 commit into from
Nov 24, 2025
Merged

feat(adding_foreign_key_constraint): allow when create table in transaction #703 #713

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
115 changes: 77 additions & 38 deletions crates/squawk_linter/src/rules/adding_foreign_key_constraint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,60 +1,75 @@
use squawk_syntax::{
Parse, SourceFile,
ast::{self, AstNode},
identifier::Identifier,
};

use crate::{Linter, Rule, Violation};
use crate::{
Linter, Rule, Violation, rules::constraint_missing_not_valid::tables_created_in_transaction,
};

pub(crate) fn adding_foreign_key_constraint(ctx: &mut Linter, parse: &Parse<SourceFile>) {
let message = "Adding a foreign key constraint requires a table scan and a `SHARE ROW EXCLUSIVE` lock on both tables, which blocks writes to each table.";
let help = "Add `NOT VALID` to the constraint in one transaction and then VALIDATE the constraint in a separate transaction.";
let file = parse.tree();
let tables_created = tables_created_in_transaction(ctx.settings.assume_in_transaction, &file);
// TODO: use match_ast! like in #api_walkthrough
for stmt in file.stmts() {
if let ast::Stmt::AlterTable(alter_table) = stmt {
for action in alter_table.actions() {
match action {
ast::AlterTableAction::AddConstraint(add_constraint) => {
if add_constraint.not_valid().is_some() {
// Adding foreign key is okay when NOT VALID is specified.
continue;
}
if let Some(constraint) = add_constraint.constraint() {
if matches!(
constraint,
ast::Constraint::ForeignKeyConstraint(_)
| ast::Constraint::ReferencesConstraint(_)
) {
ctx.report(
Violation::for_node(
Rule::AddingForeignKeyConstraint,
message.into(),
constraint.syntax(),
if let Some(table_name) = alter_table
.relation_name()
.and_then(|x| x.path())
.and_then(|x| x.segment())
.and_then(|x| x.name_ref())
{
for action in alter_table.actions() {
match action {
ast::AlterTableAction::AddConstraint(add_constraint) => {
if add_constraint.not_valid().is_some()
|| tables_created.contains(&Identifier::new(&table_name.text()))
{
// Adding foreign key is okay when:
// - NOT VALID is specified.
// - The table is created in the same transaction
continue;
}
if let Some(constraint) = add_constraint.constraint() {
if matches!(
constraint,
ast::Constraint::ForeignKeyConstraint(_)
| ast::Constraint::ReferencesConstraint(_)
) {
ctx.report(
Violation::for_node(
Rule::AddingForeignKeyConstraint,
message.into(),
constraint.syntax(),
)
.help(help),
)
.help(help),
)
}
}
}
}
ast::AlterTableAction::AddColumn(add_column) => {
for constraint in add_column.constraints() {
if matches!(
constraint,
ast::Constraint::ForeignKeyConstraint(_)
| ast::Constraint::ReferencesConstraint(_)
) {
ctx.report(
Violation::for_node(
Rule::AddingForeignKeyConstraint,
message.into(),
constraint.syntax(),
ast::AlterTableAction::AddColumn(add_column) => {
for constraint in add_column.constraints() {
if matches!(
constraint,
ast::Constraint::ForeignKeyConstraint(_)
| ast::Constraint::ReferencesConstraint(_)
) {
ctx.report(
Violation::for_node(
Rule::AddingForeignKeyConstraint,
message.into(),
constraint.syntax(),
)
.help(help),
)
.help(help),
)
}
}
}
_ => continue,
}
_ => continue,
}
}
}
Expand All @@ -64,7 +79,7 @@ pub(crate) fn adding_foreign_key_constraint(ctx: &mut Linter, parse: &Parse<Sour
#[cfg(test)]
mod test {
use crate::Rule;
use crate::test_utils::lint;
use crate::test_utils::{lint, lint_with_assume_in_transaction};

#[test]
fn create_table_with_foreign_key_constraint() {
Expand All @@ -86,6 +101,30 @@ mod test {
assert!(errors.is_empty());
}

#[test]
fn alter_table_foreign_key_assume_transaction() {
let sql = r#"
CREATE TABLE "emails" ("id" UUID NOT NULL, "user_id" UUID NOT NULL);
ALTER TABLE "emails" ADD CONSTRAINT "fk_user" FOREIGN KEY ("user_id") REFERENCES "users" ("id");
"#;

let errors = lint_with_assume_in_transaction(sql, Rule::AddingForeignKeyConstraint);
assert!(errors.is_empty());
}

#[test]
fn alter_table_foreign_key_in_transaction() {
let sql = r#"
BEGIN;
CREATE TABLE "emails" ("id" UUID NOT NULL, "user_id" UUID NOT NULL);
ALTER TABLE "emails" ADD CONSTRAINT "fk_user" FOREIGN KEY ("user_id") REFERENCES "users" ("id");
COMMIT;
"#;

let errors = lint(sql, Rule::AddingForeignKeyConstraint);
assert!(errors.is_empty());
}

#[test]
fn add_foreign_key_constraint_not_valid_validate() {
let sql = r#"
Expand Down
Loading