fix: skip comment cleanup for renamed objects in psqldef#1101
Merged
gfx merged 1 commit intosqldef:masterfrom Jan 7, 2026
Merged
fix: skip comment cleanup for renamed objects in psqldef#1101gfx merged 1 commit intosqldef:masterfrom
gfx merged 1 commit intosqldef:masterfrom
Conversation
PostgreSQL automatically transfers comments when renaming columns, tables, or indexes. Track renamed objects as "dropped" for comment cleanup to avoid generating invalid COMMENT ... IS NULL statements.
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
Contributor
|
Good catch. Thank you for your contributions! |
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
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.
Summary
This PR fixes an issue where
psqldefgenerates invalidCOMMENT ... IS NULLstatements for renamed columns, tables, and indexes when using the@renamed from=xxxannotation.Problem
When renaming an object (column, table, or index) that has a comment, the generator incorrectly attempts to clean up the comment on the old name, resulting in errors like:
Root Cause
PostgreSQL automatically transfers comments when renaming objects. However, the generator was not tracking renamed objects as "dropped" for comment cleanup purposes, causing it to generate unnecessary
COMMENT ... IS NULLstatements for names that no longer exist.Solution
Track renamed objects in the existing
droppedColumns,droppedTables, anddroppedIndexesmaps so that comment cleanup logic correctly skips them:trackDroppedColumn()afterRENAME COLUMNdroppedTablesmap afterRENAME TABLEtrackDroppedIndex()afterRENAME INDEXChanges
schema/generator.go: Add tracking for renamed objects (3 locations, 6 lines total)cmd/psqldef/tests_comments.yml: Add test cases for rename + comment scenariosTest Plan
make buildmake test-all-flavors(all tests pass except mssqldef which requires SQL Server)make formatmake lintThank you for reviewing this PR!