markhoerth commented on code in PR #12326: URL: https://github.com/apache/gravitino/pull/12326#discussion_r3700231392
########## docs/manage-tags-in-gravitino.md: ########## @@ -11,55 +10,24 @@ import TabItem from '@theme/TabItem'; ## Introduction -Starting from 0.6.0, Gravitino introduces a new tag system that allows you to manage tags for -metadata objects. Tags are a way to categorize and organize metadata objects in Gravitino. - -This document briefly introduces how to use tags in Gravitino by both Gravitino Java client and -REST APIs. If you want to know more about the tag system in Gravitino, refer to the -Javadoc and REST API documentation. - -Note that current tag system is a basic implementation, some advanced features will be added in -the future versions. - -:::info -1. Metadata objects are objects that are managed in Gravitino, such as `CATALOG`, `SCHEMA`, `TABLE`, - `VIEW`, `FUNCTION`, `FILESET`, `TOPIC`, `COLUMN`, `MODEL`, etc. A metadata object is combined by a - `type` and a dot-separated `name`. For example, a `CATALOG` object has a name "catalog1" with type - "CATALOG", a `SCHEMA` object has a name "catalog1.schema1" with type "SCHEMA", a `TABLE` - object has a name "catalog1.schema1.table1" with type "TABLE", a `COLUMN` object has a name - "catalog1.schema1.table1.column1" with type "COLUMN". -2. `CATALOG`, `SCHEMA`, `TABLE`, `VIEW`, `FUNCTION`, `FILESET`, `TOPIC`, `MODEL`, and `COLUMN` - objects can be tagged. -3. Tags in Gravitino is inheritable, so listing tags of a metadata object will also list the - tags of its parent metadata objects. For example, listing tags of a `Table` will also list - the tags of its parent `Schema` and `Catalog`. For catalogs that support multi-level - (hierarchical) schemas, such as a schema named `a:b:c` (using the configured schema - separator), the intermediate parent schemas `a:b` and `a` are also part of the hierarchy, so - their tags are inherited as well. -4. The same tag can be associated with both parent and child metadata objects. But when you list the - associated tags of a child metadata object, this tag will be included only once in the result - list with `inherited` value `false`. -::: +This page covers the tag API. For what a tag is, which object types can carry one, how inheritance Review Comment: ```suggestion This page covers the Gravitino API for tags. For what a tag is, which object types can carry one, how inheritance ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
