結構物件描述為資料代理提供資料來源架構中資料表、欄位及其他元素的商業背景資訊。 此上下文幫助代理區分名稱相似或模糊的物件，理解每個物件的目的，並產生更精確的查詢。 描述對於大型結構特別有用，因為單靠物件名稱無法清楚傳達其意義。
模式物件描述支援 SQL 資料來源，包括湖屋、倉庫、Fabric SQL 資料庫及鏡像資料庫。
注意
結構物件描述目前處於公開預覽階段。
注意
結構物件描述只有在資料代理使用 預覽執行時才可用。
新增或編輯描述
預設情況下，資料代理會繼承資料來源的可用描述並自動更新。 當你在資料代理中編輯繼承的描述時，變更只會影響資料代理本身。 它不會覆蓋原始碼的描述，且該物件不再從原始碼接收描述更新。
- 打開你的資料代理程式，然後選擇 設定。
- 在資料來源下，選擇 結構物件描述。
- 展開結構以找到你想描述的物件。
- 選擇物件旁的 編輯 圖示。
- 輸入描述，然後選擇 完成。
用 Python SDK 新增描述
使用 Fabric 資料代理 Python SDK 來程式化管理結構物件描述。 以下範例會為現有資料代理的第一個資料來源中的其中一個資料表設定描述：
from fabric.dataagent.client import FabricDataAgentManagement
agent = FabricDataAgentManagement("<data-agent-name>")
datasource = agent.get_datasources()[0]
table_path = ("Schemas", "dbo", "Tables", "adoptions")
datasource.update_description({
table_path: "Contains one row for each pet adoption transaction."
})
該元組會根據結構描述元素在資料來源中的路徑來識別該元素。 要描述欄位，請將其名稱加入資料表路徑。 例如，使用 table_path + ("adoption_date",)。 路徑名稱以大小寫區分，必須與資料來源所顯示的階層相符。
撰寫有效的描述
用描述來解釋從物件名稱中看不出來的商業意義。 保持每個描述簡潔且具體。
- 對於表格，請描述所代表的商業實體或事件、表格的細節程度及其主要目的。
- 對於欄位，請定義該數值的商業意義、格式、單位，或在可能不清楚時的期望值。
- 對於其他結構元素，請說明它們的角色以及資料代理何時應該使用它們。
- 釐清縮寫、內部術語及同名物件。
- 在產生查詢時，加入有助於代理選擇正確物件與關係的上下文。