feat: COMMENT ON for function and stored procedure#230
Merged
Conversation
Document the implementation approach for adding comment support to functions and procedures in diff generation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add generateFunctionComment() and generateProcedureComment() helpers - Update functionsEqual() and proceduresEqual() to compare comments - Add functionsEqualExceptComment() and proceduresEqualExceptComment() - Comment-only changes generate just COMMENT ON statement (no DROP/CREATE) - New functions/procedures with comments emit COMMENT ON after CREATE - Body changes with comment changes emit both statements Test cases added: - comment/add_function_comment - comment/add_procedure_comment 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR implements COMMENT ON support for PostgreSQL functions and stored procedures, addressing part of issue #227 regarding function metadata. The implementation allows adding, modifying, and removing comments on these database objects.
Key Changes:
- Added comment generation for functions and procedures during creation and modification
- Implemented smart detection to generate only
COMMENT ONstatements when only comments change - Properly handles comment changes alongside body or attribute modifications
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
internal/diff/function.go |
Adds comment generation logic for functions, including detection of comment-only changes and integration with existing attribute-only change handling |
internal/diff/procedure.go |
Adds comment generation logic for procedures, including detection of comment-only changes and integration with DROP+CREATE modification flow |
testdata/diff/comment/add_function_comment/* |
Test data files validating that adding a comment to an existing function generates only a COMMENT ON FUNCTION statement |
testdata/diff/comment/add_procedure_comment/* |
Test data files validating that adding a comment to an existing procedure generates only a COMMENT ON PROCEDURE statement |
.gitignore |
Adds docs/plans/ to ignored paths for generated documentation files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
alecthomas
pushed a commit
to alecthomas/pgschema
that referenced
this pull request
Jan 26, 2026
* docs: add design for COMMENT ON FUNCTION/PROCEDURE support Document the implementation approach for adding comment support to functions and procedures in diff generation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: add COMMENT ON FUNCTION/PROCEDURE support - Add generateFunctionComment() and generateProcedureComment() helpers - Update functionsEqual() and proceduresEqual() to compare comments - Add functionsEqualExceptComment() and proceduresEqualExceptComment() - Comment-only changes generate just COMMENT ON statement (no DROP/CREATE) - New functions/procedures with comments emit COMMENT ON after CREATE - Body changes with comment changes emit both statements Test cases added: - comment/add_function_comment - comment/add_procedure_comment 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
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
1 participant
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.
Address part of #227 - 4. Function Metadata