fix: composite FK referenced column order when FK order differs from table column order (#266) #267
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…table column order (pgplex#266) When dumping composite foreign key constraints where the FK column order differs from the table's column definition order, pgschema was outputting referenced columns in the wrong order, causing type mismatch errors when applying the generated DDL. The bug was in buildConstraints: ForeignOrdinalPosition (fa.attnum - the column's position in the foreign table was used for the referenced column's Position instead of using the local column's constraint position. Since local and referenced columns are paired in the FK definition, they should share the same position value. Fixes the issue by using the local column's constraint position for the paired referenced column. EOF )
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug in the handling of composite foreign key constraints where the FK column order differs from the table's column definition order. Previously, pgschema incorrectly used the foreign table's column positions (attnum) for referenced columns, causing type mismatches when the FK column order differed from the table definition order.
Changes:
- Fixed
buildConstraintsinir/inspector.goto use the local column's constraint position for paired referenced columns instead of the foreign table's column position - Added comprehensive test case
composite_fk_column_orderdemonstrating the bug and verifying the fix
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| ir/inspector.go | Fixed position assignment for referenced columns in composite FK constraints to use local constraint position instead of foreign table column position |
| testdata/diff/create_table/composite_fk_column_order/old.sql | Test input: tables without FK constraint |
| testdata/diff/create_table/composite_fk_column_order/new.sql | Test input: tables with composite FK where column order differs from table definition |
| testdata/diff/create_table/composite_fk_column_order/diff.sql | Expected diff output: correct FK constraint DDL |
| testdata/diff/create_table/composite_fk_column_order/plan.sql | Expected plan SQL output |
| testdata/diff/create_table/composite_fk_column_order/plan.txt | Expected plan text output |
| testdata/diff/create_table/composite_fk_column_order/plan.json | Expected plan JSON output |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
tianzhou
approved these changes
Jan 30, 2026
Contributor
tianzhou
left a comment
tianzhou
left a comment
There was a problem hiding this comment.
LGTM. Thanks for the contribution
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When dumping composite foreign key constraints where the FK column order differs from the table's column definition order, pgschema was outputting referenced columns in the wrong order, causing type mismatch errors when applying the generated DDL.
The bug was in buildConstraints: ForeignOrdinalPosition (fa.attnum - the column's position in the foreign table was used for the referenced column's Position instead of using the local column's constraint position. Since local and referenced columns are paired in the FK definition, they should share the same position value.
Fixes the issue by using the local column's constraint position for the paired referenced column.
Closes #266