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.

Sign up for GitHub

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

Jump to bottom

doc/user: promote COMMENT ON to GA #30679

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −10
Open

doc/user: promote COMMENT ON to GA #30679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions doc/user/content/releases/previews.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,6 @@ For more information, see:
- [`CREATE CLUSTER`](/sql/create-cluster).
- [`ALTER CLUSTER`](/sql/alter-cluster).

### COMMENT ON

Materialize adds the `COMMENT ON` command to allow commenting on an object.

For more information, see [`COMMENT ON`](/sql/comment-on).

### Support for Fivetran

Materialize adds support for Fivetran to sync data into Materialize.
Expand Down
2 changes: 0 additions & 2 deletions doc/user/content/sql/comment-on.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ menu:
parent: 'commands'
---

{{< public-preview />}}

`COMMENT ON ...` adds or updates the comment of an object.

## Syntax
Expand Down
4 changes: 2 additions & 2 deletions doc/user/content/sql/system-catalog/mz_internal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,14 +289,14 @@ The `mz_pending_cluster_replicas` table lists the replicas that were created dur

## `mz_comments`

The `mz_comments` table stores optional comments (descriptions) for objects in the database.
The `mz_comments` table stores optional comments (i.e., descriptions) for objects in the database.

<!-- 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.

| `comment` | [`text`] | The comment itself. |

## `mz_compute_dependencies`
Expand Down