使用 Markdown 注释在 Catalog Explorer 中记录数据

  • 项目

用户可以使用 Catalog Explorer 查看有关数据资产（如目录、架构和表）的注释。 本文介绍对象所有者或具有对象修改权限的用户如何使用 Catalog Explorer 手动添加这些注释。

如果你使用的是 Unity Catalog，则可以使用目录资源管理器添加和编辑所有非 Delta Sharing 目录对象的注释。

对于 Hive 元存储中的数据，只能使用目录资源管理器编辑表注释。

Markdown 提供一组可靠的选项用于记录数据，增强了供 Azure Databricks 用户用来提高共享数据资产的可发现性和理解性的选项。 使用 Markdown 注释不会影响查询性能。 当由 DESCRIBE 语句返回时，Markdown 不会呈现。

使用 Catalog Explorer 向数据对象添加 Markdown 注释

目录资源管理器会在对象名称下方显示目录、架构、表和其他资产的注释。

  • 如果不存在任何注释，则会显示“添加注释”选项。
  • 可以使用“隐藏注释”和“显示注释”选项来切换注释的显示状态。

保存更改后，表注释中的 Markdown 会立即呈现在目录资源管理器中。

  • 单击铅笔图标可修改注释。
  • 单击“保存”会更新注释。

在创建表或执行 ALTER TABLE 操作期间，还可以使用 SQL 来添加表注释。

修改 Delta Lake 表的注释时，表历史记录中的 SET TBLPROPERTIES 操作将记录用于定义当前表注释的 SQL 查询。

支持的 Markdown 记录方式示例

目录资源管理器支持基本 Markdown 语法。 不能对表情符号、图像和呈现的 Markdown 表使用 Markdown。 目录资源管理器仅呈现两个级别的 Markdown 标头。

以下示例演示原始 Markdown 的代码块。 在目录资源管理器中将此 Markdown 复制到注释，然后单击“保存”进行预览。

# Header 1
## Header 2

**bold text**

*italics text*

~~strikethrough text~~

`monospace text`

---

> Block quote

Ordered list:
1. Item 1
1. Item 2
1. Item 3

Unordered list:
- Item a
- Item b
- Item c

def my_function():
    return my_value

[Link](https://www.markdownguide.org/cheat-sheet/#basic-syntax)

更多资源

还可以使用以下功能向数据对象添加注释：

  • COMMENT ON 命令。 此选项不支持列注释。
  • 使用 CREATE <object> 或 ALTER <object> 命令时的 COMMENT 选项。 例如，请参阅 CREATE TABLE [USING] 和 ALTER TABLE。 此选项支持列注释。