Rename ForeignKeyReferenceOnDelete to ForeignKeyAction (#639)

kvch · web-flow · commit f2701699a0ad · 2025-01-29T13:38:57.000+01:00
This PR renames `ForeignKeyReferenceOnDelete` to `ForeignKeyAction`. The name was too long. Also, `ON DELETE` and `ON UPDATE` referential actions are the same. This name makes it clearer that we are reusing this enum for both options. Extracted from #628
diff --git a/pkg/migrations/errors.go b/pkg/migrations/errors.go
@@ -191,11 +191,11 @@ type InvalidOnDeleteSettingError struct {
 func (e InvalidOnDeleteSettingError) Error() string {
 	return fmt.Sprintf("foreign key %q on_delete setting must be one of: %q, %q, %q, %q or %q, not %q",
 		e.Name,
-		ForeignKeyReferenceOnDeleteNOACTION,
-		ForeignKeyReferenceOnDeleteRESTRICT,
-		ForeignKeyReferenceOnDeleteSETDEFAULT,
-		ForeignKeyReferenceOnDeleteSETNULL,
-		ForeignKeyReferenceOnDeleteCASCADE,
+		ForeignKeyActionNOACTION,
+		ForeignKeyActionRESTRICT,
+		ForeignKeyActionSETDEFAULT,
+		ForeignKeyActionSETNULL,
+		ForeignKeyActionCASCADE,
 		e.Setting,
 	)
 }
@@ -207,8 +207,8 @@ type UnexpectedOnDeleteSetColumnError struct {
 func (e UnexpectedOnDeleteSetColumnError) Error() string {
 	return fmt.Sprintf("if on_delete_set_columns is set in foreign key %q, on_delete setting must be one of: %q, %q",
 		e.Name,
-		ForeignKeyReferenceOnDeleteSETDEFAULT,
-		ForeignKeyReferenceOnDeleteSETNULL,
+		ForeignKeyActionSETDEFAULT,
+		ForeignKeyActionSETNULL,
 	)
 }
 
diff --git a/pkg/migrations/fk_reference.go b/pkg/migrations/fk_reference.go
@@ -29,11 +29,11 @@ func (f *ForeignKeyReference) Validate(s *schema.Schema) error {
 	}
 
 	switch strings.ToUpper(string(f.OnDelete)) {
-	case string(ForeignKeyReferenceOnDeleteNOACTION):
-	case string(ForeignKeyReferenceOnDeleteRESTRICT):
-	case string(ForeignKeyReferenceOnDeleteSETDEFAULT):
-	case string(ForeignKeyReferenceOnDeleteSETNULL):
-	case string(ForeignKeyReferenceOnDeleteCASCADE):
+	case string(ForeignKeyActionNOACTION):
+	case string(ForeignKeyActionRESTRICT):
+	case string(ForeignKeyActionSETDEFAULT):
+	case string(ForeignKeyActionSETNULL):
+	case string(ForeignKeyActionCASCADE):
 	case "":
 		break
 	default:
diff --git a/pkg/migrations/op_add_column.go b/pkg/migrations/op_add_column.go
@@ -315,7 +315,7 @@ func (w ColumnSQLWriter) Write(col Column) (string, error) {
 	}
 
 	if col.References != nil {
-		onDelete := string(ForeignKeyReferenceOnDeleteNOACTION)
+		onDelete := string(ForeignKeyActionNOACTION)
 		if col.References.OnDelete != "" {
 			onDelete = strings.ToUpper(string(col.References.OnDelete))
 		}
diff --git a/pkg/migrations/op_add_column_test.go b/pkg/migrations/op_add_column_test.go
@@ -722,7 +722,7 @@ func TestAddForeignKeyColumn(t *testing.T) {
 									Name:     "fk_users_id",
 									Table:    "users",
 									Column:   "id",
-									OnDelete: migrations.ForeignKeyReferenceOnDeleteCASCADE,
+									OnDelete: migrations.ForeignKeyActionCASCADE,
 								},
 							},
 						},
diff --git a/pkg/migrations/op_change_type_test.go b/pkg/migrations/op_change_type_test.go
@@ -185,7 +185,7 @@ func TestChangeColumnType(t *testing.T) {
 										Name:     "fk_employee_department",
 										Table:    "departments",
 										Column:   "id",
-										OnDelete: migrations.ForeignKeyReferenceOnDeleteCASCADE,
+										OnDelete: migrations.ForeignKeyActionCASCADE,
 									},
 								},
 							},
diff --git a/pkg/migrations/op_create_table.go b/pkg/migrations/op_create_table.go
@@ -171,7 +171,7 @@ func (o *OpCreateTable) Validate(ctx context.Context, s *schema.Schema) error {
 				return FieldRequiredError{Name: "references"}
 			}
 			if len(c.References.OnDeleteSetColumns) != 0 {
-				if c.References.OnDelete != ForeignKeyReferenceOnDeleteSETDEFAULT && c.References.OnDelete != ForeignKeyReferenceOnDeleteSETNULL {
+				if c.References.OnDelete != ForeignKeyActionSETDEFAULT && c.References.OnDelete != ForeignKeyActionSETNULL {
 					return UnexpectedOnDeleteSetColumnError{
 						Name: o.Name,
 					}
@@ -381,15 +381,15 @@ func (w *ConstraintSQLWriter) WritePrimaryKey() string {
 	return constraint
 }
 
-func (w *ConstraintSQLWriter) WriteForeignKey(referencedTable string, referencedColumns []string, onDelete, onUpdate ForeignKeyReferenceOnDelete, setColumns []string) string {
-	onDeleteAction := string(ForeignKeyReferenceOnDeleteNOACTION)
+func (w *ConstraintSQLWriter) WriteForeignKey(referencedTable string, referencedColumns []string, onDelete, onUpdate ForeignKeyAction, setColumns []string) string {
+	onDeleteAction := string(ForeignKeyActionNOACTION)
 	if onDelete != "" {
 		onDeleteAction = strings.ToUpper(string(onDelete))
 		if len(setColumns) != 0 {
 			onDeleteAction += " (" + strings.Join(quoteColumnNames(setColumns), ", ") + ")"
 		}
 	}
-	onUpdateAction := string(ForeignKeyReferenceOnDeleteNOACTION)
+	onUpdateAction := string(ForeignKeyActionNOACTION)
 	if onUpdate != "" {
 		onUpdateAction = strings.ToUpper(string(onUpdate))
 	}
diff --git a/pkg/migrations/op_create_table_test.go b/pkg/migrations/op_create_table_test.go
@@ -309,7 +309,7 @@ func TestCreateTable(t *testing.T) {
 										Column:   "id",
 										Name:     "fk_users_id",
 										Table:    "users",
-										OnDelete: migrations.ForeignKeyReferenceOnDeleteCASCADE,
+										OnDelete: migrations.ForeignKeyActionCASCADE,
 									},
 								},
 								{
@@ -820,7 +820,7 @@ func TestCreateTable(t *testing.T) {
 									References: &migrations.ConstraintReferences{
 										Table:    "owners",
 										Columns:  []string{"id"},
-										OnDelete: migrations.ForeignKeyReferenceOnDeleteCASCADE,
+										OnDelete: migrations.ForeignKeyActionCASCADE,
 									},
 								},
 							},
@@ -950,7 +950,7 @@ func TestCreateTable(t *testing.T) {
 									References: &migrations.ConstraintReferences{
 										Table:              "owners",
 										Columns:            []string{"id", "city"},
-										OnDelete:           migrations.ForeignKeyReferenceOnDeleteSETDEFAULT,
+										OnDelete:           migrations.ForeignKeyActionSETDEFAULT,
 										OnDeleteSetColumns: []string{"owner_id", "owner_city_id"},
 									},
 								},
diff --git a/pkg/migrations/op_set_check_test.go b/pkg/migrations/op_set_check_test.go
@@ -249,7 +249,7 @@ func TestSetCheckConstraint(t *testing.T) {
 										Name:     "fk_employee_department",
 										Table:    "departments",
 										Column:   "id",
-										OnDelete: migrations.ForeignKeyReferenceOnDeleteCASCADE,
+										OnDelete: migrations.ForeignKeyActionCASCADE,
 									},
 								},
 							},
diff --git a/pkg/migrations/op_set_fk_test.go b/pkg/migrations/op_set_fk_test.go
@@ -304,7 +304,7 @@ func TestSetForeignKey(t *testing.T) {
 								Name:     "fk_users_id",
 								Table:    "users",
 								Column:   "id",
-								OnDelete: migrations.ForeignKeyReferenceOnDeleteCASCADE,
+								OnDelete: migrations.ForeignKeyActionCASCADE,
 							},
 							Up:   "SELECT CASE WHEN EXISTS (SELECT 1 FROM users WHERE users.id = user_id) THEN user_id ELSE NULL END",
 							Down: "user_id",
@@ -410,7 +410,7 @@ func TestSetForeignKey(t *testing.T) {
 								Name:     "fk_users_id",
 								Table:    "users",
 								Column:   "id",
-								OnDelete: migrations.ForeignKeyReferenceOnDeleteSETNULL,
+								OnDelete: migrations.ForeignKeyActionSETNULL,
 							},
 							Up:   "SELECT CASE WHEN EXISTS (SELECT 1 FROM users WHERE users.id = user_id) THEN user_id ELSE NULL END",
 							Down: "user_id",
@@ -520,7 +520,7 @@ func TestSetForeignKey(t *testing.T) {
 								Name:     "fk_users_id",
 								Table:    "users",
 								Column:   "id",
-								OnDelete: migrations.ForeignKeyReferenceOnDeleteSETDEFAULT,
+								OnDelete: migrations.ForeignKeyActionSETDEFAULT,
 							},
 							Up:   "SELECT CASE WHEN EXISTS (SELECT 1 FROM users WHERE users.id = user_id) THEN user_id ELSE NULL END",
 							Down: "user_id",
@@ -725,7 +725,7 @@ func TestSetForeignKey(t *testing.T) {
 								Name:     "fk_users_id_1",
 								Table:    "users",
 								Column:   "id",
-								OnDelete: migrations.ForeignKeyReferenceOnDeleteCASCADE,
+								OnDelete: migrations.ForeignKeyActionCASCADE,
 							},
 							Up:   "SELECT CASE WHEN EXISTS (SELECT 1 FROM users WHERE users.id = user_id) THEN user_id ELSE NULL END",
 							Down: "user_id",
@@ -1894,7 +1894,7 @@ func TestSetForeignKeyValidation(t *testing.T) {
 								Name:     "fk_users_doesntexist",
 								Table:    "users",
 								Column:   "id",
-								OnDelete: migrations.ForeignKeyReferenceOnDeleteNOACTION,
+								OnDelete: migrations.ForeignKeyActionNOACTION,
 							},
 							Up:   "SELECT CASE WHEN EXISTS (SELECT 1 FROM users WHERE users.id = user_id) THEN user_id ELSE NULL END",
 							Down: "user_id",
@@ -1918,7 +1918,7 @@ func TestSetForeignKeyValidation(t *testing.T) {
 								Name:     "fk_users_doesntexist",
 								Table:    "users",
 								Column:   "id",
-								OnDelete: migrations.ForeignKeyReferenceOnDeleteSETNULL,
+								OnDelete: migrations.ForeignKeyActionSETNULL,
 							},
 							Up:   "SELECT CASE WHEN EXISTS (SELECT 1 FROM users WHERE users.id = user_id) THEN user_id ELSE NULL END",
 							Down: "user_id",
diff --git a/pkg/migrations/op_set_notnull_test.go b/pkg/migrations/op_set_notnull_test.go
@@ -255,7 +255,7 @@ func TestSetNotNull(t *testing.T) {
 										Name:     "fk_employee_department",
 										Table:    "departments",
 										Column:   "id",
-										OnDelete: migrations.ForeignKeyReferenceOnDeleteCASCADE,
+										OnDelete: migrations.ForeignKeyActionCASCADE,
 									},
 								},
 							},
diff --git a/pkg/migrations/op_set_unique_test.go b/pkg/migrations/op_set_unique_test.go
@@ -288,7 +288,7 @@ func TestSetColumnUnique(t *testing.T) {
 										Name:     "fk_employee_department",
 										Table:    "departments",
 										Column:   "id",
-										OnDelete: migrations.ForeignKeyReferenceOnDeleteSETNULL,
+										OnDelete: migrations.ForeignKeyActionSETNULL,
 									},
 								},
 							},
diff --git a/pkg/migrations/types.go b/pkg/migrations/types.go
diff --git a/pkg/sql2pgroll/alter_table.go b/pkg/sql2pgroll/alter_table.go
@@ -223,20 +223,20 @@ func convertAlterTableAddForeignKeyConstraint(stmt *pgq.AlterTableStmt, constrai
 	}, nil
 }
 
-func parseOnDeleteAction(action string) (migrations.ForeignKeyReferenceOnDelete, error) {
+func parseOnDeleteAction(action string) (migrations.ForeignKeyAction, error) {
 	switch action {
 	case "a":
-		return migrations.ForeignKeyReferenceOnDeleteNOACTION, nil
+		return migrations.ForeignKeyActionNOACTION, nil
 	case "c":
-		return migrations.ForeignKeyReferenceOnDeleteCASCADE, nil
+		return migrations.ForeignKeyActionCASCADE, nil
 	case "r":
-		return migrations.ForeignKeyReferenceOnDeleteRESTRICT, nil
+		return migrations.ForeignKeyActionRESTRICT, nil
 	case "d":
-		return migrations.ForeignKeyReferenceOnDeleteSETDEFAULT, nil
+		return migrations.ForeignKeyActionSETDEFAULT, nil
 	case "n":
-		return migrations.ForeignKeyReferenceOnDeleteSETNULL, nil
+		return migrations.ForeignKeyActionSETNULL, nil
 	default:
-		return migrations.ForeignKeyReferenceOnDeleteNOACTION, fmt.Errorf("unknown delete action: %q", action)
+		return migrations.ForeignKeyActionNOACTION, fmt.Errorf("unknown delete action: %q", action)
 	}
 }
 
diff --git a/pkg/sql2pgroll/alter_table_test.go b/pkg/sql2pgroll/alter_table_test.go
@@ -90,23 +90,23 @@ func TestConvertAlterTableStatements(t *testing.T) {
 		},
 		{
 			sql:        "ALTER TABLE foo ADD CONSTRAINT fk_bar_cd FOREIGN KEY (a, b) REFERENCES bar (c, d);",
-			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyReferenceOnDeleteNOACTION),
+			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyActionNOACTION),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD CONSTRAINT fk_bar_cd FOREIGN KEY (a, b) REFERENCES bar (c, d) ON DELETE NO ACTION;",
-			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyReferenceOnDeleteNOACTION),
+			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyActionNOACTION),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD CONSTRAINT fk_bar_cd FOREIGN KEY (a, b) REFERENCES bar (c, d) ON DELETE RESTRICT;",
-			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyReferenceOnDeleteRESTRICT),
+			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyActionRESTRICT),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD CONSTRAINT fk_bar_cd FOREIGN KEY (a, b) REFERENCES bar (c, d) ON DELETE SET DEFAULT ;",
-			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyReferenceOnDeleteSETDEFAULT),
+			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyActionSETDEFAULT),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD CONSTRAINT fk_bar_cd FOREIGN KEY (a, b) REFERENCES bar (c, d) ON DELETE SET NULL;",
-			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyReferenceOnDeleteSETNULL),
+			expectedOp: expect.AddForeignKeyOp1WithOnDelete(migrations.ForeignKeyActionSETNULL),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD CONSTRAINT fk_bar_c FOREIGN KEY (a) REFERENCES bar (c);",
@@ -196,31 +196,31 @@ func TestConvertAlterTableStatements(t *testing.T) {
 		},
 		{
 			sql:        "ALTER TABLE foo ADD COLUMN bar int CONSTRAINT fk_baz REFERENCES baz (bar)",
-			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyReferenceOnDeleteNOACTION),
+			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyActionNOACTION),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD COLUMN bar int CONSTRAINT fk_baz REFERENCES baz (bar) ON UPDATE NO ACTION",
-			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyReferenceOnDeleteNOACTION),
+			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyActionNOACTION),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD COLUMN bar int CONSTRAINT fk_baz REFERENCES baz (bar) ON DELETE NO ACTION",
-			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyReferenceOnDeleteNOACTION),
+			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyActionNOACTION),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD COLUMN bar int CONSTRAINT fk_baz REFERENCES baz (bar) ON DELETE RESTRICT",
-			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyReferenceOnDeleteRESTRICT),
+			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyActionRESTRICT),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD COLUMN bar int CONSTRAINT fk_baz REFERENCES baz (bar) ON DELETE SET NULL ",
-			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyReferenceOnDeleteSETNULL),
+			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyActionSETNULL),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD COLUMN bar int CONSTRAINT fk_baz REFERENCES baz (bar) ON DELETE SET DEFAULT",
-			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyReferenceOnDeleteSETDEFAULT),
+			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyActionSETDEFAULT),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD COLUMN bar int CONSTRAINT fk_baz REFERENCES baz (bar) ON DELETE CASCADE",
-			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyReferenceOnDeleteCASCADE),
+			expectedOp: expect.AddColumnOp8WithOnDeleteAction(migrations.ForeignKeyActionCASCADE),
 		},
 		{
 			sql:        "ALTER TABLE foo ADD COLUMN bar int GENERATED BY DEFAULT AS IDENTITY ",
diff --git a/pkg/sql2pgroll/create_table.go b/pkg/sql2pgroll/create_table.go
diff --git a/pkg/sql2pgroll/expect/add_column.go b/pkg/sql2pgroll/expect/add_column.go
diff --git a/pkg/sql2pgroll/expect/add_foreign_key.go b/pkg/sql2pgroll/expect/add_foreign_key.go
diff --git a/pkg/sql2pgroll/expect/create_table.go b/pkg/sql2pgroll/expect/create_table.go
diff --git a/schema.json b/schema.json

Original file line number	Diff line number	Diff line change
`@@ -315,7 +315,7 @@ func (w ColumnSQLWriter) Write(col Column) (string, error) {`
`315`	`315`	`}`
`316`	`316`
`317`	`317`	`if col.References != nil {`
`318`		`- onDelete := string(ForeignKeyReferenceOnDeleteNOACTION)`
	`318`	`+ onDelete := string(ForeignKeyActionNOACTION)`
`319`	`319`	`if col.References.OnDelete != "" {`
`320`	`320`	`onDelete = strings.ToUpper(string(col.References.OnDelete))`
`321`	`321`	`}`
Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ func (o OpCreateTable) Validate(ctx context.Context, s schema.Schema) error {`
`171`	`171`	`return FieldRequiredError{Name: "references"}`
`172`	`172`	`}`
`173`	`173`	`if len(c.References.OnDeleteSetColumns) != 0 {`
`174`		`- if c.References.OnDelete != ForeignKeyReferenceOnDeleteSETDEFAULT && c.References.OnDelete != ForeignKeyReferenceOnDeleteSETNULL {`
	`174`	`+ if c.References.OnDelete != ForeignKeyActionSETDEFAULT && c.References.OnDelete != ForeignKeyActionSETNULL {`
`175`	`175`	`return UnexpectedOnDeleteSetColumnError{`
`176`	`176`	`Name: o.Name,`
`177`	`177`	`}`
`@@ -381,15 +381,15 @@ func (w *ConstraintSQLWriter) WritePrimaryKey() string {`
`381`	`381`	`return constraint`
`382`	`382`	`}`
`383`	`383`
`384`		`-func (w *ConstraintSQLWriter) WriteForeignKey(referencedTable string, referencedColumns []string, onDelete, onUpdate ForeignKeyReferenceOnDelete, setColumns []string) string {`
`385`		`- onDeleteAction := string(ForeignKeyReferenceOnDeleteNOACTION)`
	`384`	`+func (w *ConstraintSQLWriter) WriteForeignKey(referencedTable string, referencedColumns []string, onDelete, onUpdate ForeignKeyAction, setColumns []string) string {`
	`385`	`+ onDeleteAction := string(ForeignKeyActionNOACTION)`
`386`	`386`	`if onDelete != "" {`
`387`	`387`	`onDeleteAction = strings.ToUpper(string(onDelete))`
`388`	`388`	`if len(setColumns) != 0 {`
`389`	`389`	`onDeleteAction += " (" + strings.Join(quoteColumnNames(setColumns), ", ") + ")"`
`390`	`390`	`}`
`391`	`391`	`}`
`392`		`- onUpdateAction := string(ForeignKeyReferenceOnDeleteNOACTION)`
	`392`	`+ onUpdateAction := string(ForeignKeyActionNOACTION)`
`393`	`393`	`if onUpdate != "" {`
`394`	`394`	`onUpdateAction = strings.ToUpper(string(onUpdate))`
`395`	`395`	`}`