Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/user: promote COMMENT ON to GA #30679

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

morsapaes
Copy link
Contributor

@ParkMyCar: it seems like the remaining task is to stabilize mz_comments. Marked that as a TODO under #8394.

@morsapaes morsapaes requested a review from a team as a code owner December 2, 2024 14:06
@ParkMyCar
Copy link
Member

We also wanted to change SHOW CREATE ... to include COMMENT ON if said object has a comment. IMO this doesn't necessarily need to block GA though


<!-- RELATION_SPEC mz_internal.mz_comments -->
| Field | Type | Meaning |
| -------------- |-------------| -------- |
| `id` | [`text`] | The ID of the object. Corresponds to [`mz_objects.id`](../mz_catalog/#mz_objects). |
| `object_type` | [`text`] | The type of object the comment is associated with. |
| `object_sub_id`| [`integer`] | For a comment on a column of a relation, this is the column number. For all other object types this column is `NULL`. |
| `object_sub_id`| [`integer`] | For a comment on a column of a relation, the column number. `NULL` for other object types. |
Copy link
Contributor

Choose a reason for hiding this comment

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

For parallelism, it probably should be more

Suggested change
| `object_sub_id`| [`integer`] | For a comment on a column of a relation, the column number. `NULL` for other object types. |
| `object_sub_id`| [`integer`] | For a comment on a column of a relation, the column number. For other object types, `NULL`. |

or

Suggested change
| `object_sub_id`| [`integer`] | For a comment on a column of a relation, the column number. `NULL` for other object types. |
| `object_sub_id`| [`integer`] | The column number for a comment on a column of a relation. `NULL` for other object types. |

But, recognizing that these pages are slightly loose ... so, feel free to ignore.

Copy link
Contributor

@kay-kim kay-kim left a comment

Choose a reason for hiding this comment

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

lgtm mod nit (feel free to ignore nit).

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.

3 participants