Modify comment related APIs #1000
Merged
Conversation
This file contains 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
- added support for using markdown in comments - since comment can now be markdown, changed all the .comment APIs to return an object similar to .displayname - moved the commentDisplay APIs to be inside the same object. - added support for contextualized column comments with display annot
jrchudy
approved these changes
Jan 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The main purpose of this PR is to add support for markdown in the raw value of
commentAPIs (#981). But instead of adding a separatecommentRenderMarkdown, I changed.commentreturned value to an object (similar to how.displaynameworks). This allows us also to remove.commentDisplayand have it as part of the object.Other changes are,
Contextualized
commentare now supported.Fix the inheritance of
comment_displayfrom the parent catalog, schema, or table.comment,comment_display, andcomment_render_markdowncan come from different levels and don't affect each other. Before, we used to only get thecomment_displayfrom where thecommentwas defined. But nowcomment_displaycan come from the column directive while thecommentis derived from the table (or vice versa).Moved the comment-related APIs of
ForeignkeyRefandKeytogetDisplay, similar to how we've done it onTableandColumn.Since I completely changed how the
.commentAPI works in here, we have to merge this at the same time as the chaise one.