共用方式為

使用 Markdown 批注在目錄總管中記載數據

  • 發行項

使用者可以使用 目錄總 管來檢視有關數據資產的批註，例如目錄、架構和數據表。 本文說明具有物件修改許可權的對象擁有者或使用者如何使用目錄總管手動新增這些批注。

注意

針對數據表和數據行，目錄總管也可讓您查看 AI 產生的批注建議並加以套用。 請參閱 將 AI 產生的批註新增至數據表。

如果您使用 Unity 目錄，您可以使用目錄總管，在差異共享目錄中以外的所有物件上新增和編輯批注。

針對Hive中繼存放區中的數據，您可以使用目錄總管來編輯數據表批注。

Markdown 提供一組健全的選項來記錄數據，增強 Azure Databricks 用戶對於增加共用數據資產的可探索性和瞭解的選項。 使用 Markdown 批注不會影響查詢效能。 Markdown 不會在 語句傳 DESCRIBE 回時呈現。

使用目錄總管將 Markdown 批註新增至數據物件

目錄總管會顯示物件名稱下方目錄、架構、數據表和其他資產的批注。

  • 如果沒有批注存在，則會顯示 [ 新增批注 ] 選項。
  • 您可以使用 [隱藏批注] 和 [顯示批註] 選項來切換批注顯示。

當您儲存變更時，表格批注中的 Markdown 會在目錄總管中轉譯。

  • 按兩下鉛筆圖示以修改批註。
  • 按兩下 [ 儲存] 以更新批注。

您也可以使用 SQL 在資料表建立或 ALTER TABLE 動作期間新增資料表批注。

修改 Delta Lake 數據表上的批注時， SET TBLPROPERTIES 數據表記錄中的作業會記錄用來定義目前數據表批注的 SQL 查詢。

支援的 Markdown 檔範例

目錄總管支援基本 Markdown 語法。 您無法對 emoji、影像和轉譯的 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 命令。 此選項不支援資料行批注。
  • COMMENT當您使用 CREATE <object> 或 ALTER <object> 命令時的選項。 例如，請參閱 CREATE TABLE [USING] 和 ALTER TABLE。 此選項支援資料行批注。
  • 目錄總管中 AI 產生的批注（也稱為 AI 產生的檔）。 您可以檢視大型語言模型 （LLM） 建議的批注，該模型會考慮數據表元數據，例如數據表架構和數據行名稱，以及編輯或接受批注即為新增。 此選項僅支持資料表和資料行。 請參閱 將 AI 產生的批註新增至數據表。