Skip to content

HCK-15551: improve view column comments#330

Merged
Vitalii4as merged 3 commits intodevelopfrom
feature/HCK-15551
Apr 9, 2026
Merged

HCK-15551: improve view column comments#330
Vitalii4as merged 3 commits intodevelopfrom
feature/HCK-15551

Conversation

@taras-dubyk
Copy link
Copy Markdown
Contributor

Content

  • Prioritized reference descriptions (refDescription) over definition descriptions (description) for view column references
  • Removed population of the "Column list" property for reverse engineering of regular views from HQL
    • View columns are now correctly parsed for regular views, so duplicating them in the "Column list" is no longer necessary
    • The property is still populated for materialized views, as they may require a more complex column list
  • Added refDescription to the script generation options configuration, enabling it to work alongside the existing description property

@taras-dubyk taras-dubyk requested a review from Vitalii4as April 9, 2026 10:47
@taras-dubyk taras-dubyk self-assigned this Apr 9, 2026
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 9, 2026

columnList.push({
name: `${prepareName(name)}`,
comment: property.description,
comment: property.refDescription || property.description,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we consider only refDescription when the column is a reference? For example If you have a table column with some comment, but in your view column (that references table column) you don't want to have a comment. It won't be possible to achieve with this code, because it will assign the description of definition as comment of view column.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's a valid use case.
We took a safe way for this change for now.
We may discuss it separately. It may indeed be better to use only refDescription for references.

@Vitalii4as Vitalii4as enabled auto-merge (squash) April 9, 2026 11:25
@Vitalii4as Vitalii4as disabled auto-merge April 9, 2026 13:17
@Vitalii4as Vitalii4as merged commit 533d991 into develop Apr 9, 2026
6 of 9 checks passed
@Vitalii4as Vitalii4as deleted the feature/HCK-15551 branch April 9, 2026 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants