Share via

Dokumentumadatok a Catalog Explorerben Markdown-megjegyzések használatával

  • Cikk

A felhasználók a Katalóguskezelővel megtekinthetik az adategységekkel, például katalógusokkal, sémákkal és táblákkal kapcsolatos megjegyzéseket. Ez a cikk azt ismerteti, hogy az objektumok tulajdonosai vagy az objektumokra vonatkozó módosítási engedéllyel rendelkező felhasználók hogyan adhatják hozzá ezeket a megjegyzéseket manuálisan a Catalog Explorer használatával.

Feljegyzés

Táblák és oszlopok esetén a Catalog Explorer lehetővé teszi az AI által létrehozott megjegyzésjavaslatok megtekintését és alkalmazását is. Lásd: AI által létrehozott megjegyzések hozzáadása egy táblához.

Ha Unity-katalógust használ, a Katalóguskezelővel megjegyzéseket adhat hozzá és szerkeszthet a Delta Sharing-katalógusban lévő objektumoktól eltérő összes objektumhoz.

A Hive-metaadattárban lévő adatok esetében a Katalóguskezelővel csak táblamegjegyzéseket szerkeszthet.

A Markdown számos lehetőséget kínál az adatok dokumentálására, és növeli az Azure Databricks felhasználóinak a megosztott adategységek felderíthetőségét és megértését. A Markdown-megjegyzések használata nincs hatással a lekérdezés teljesítményére. A Markdown nem jelenik meg utasítások visszaadásakor DESCRIBE .

Markdown-megjegyzések hozzáadása adatobjektumokhoz a Catalog Explorer használatával

A Katalóguskezelő az objektum neve alatt jeleníti meg a katalógusokhoz, sémákhoz, táblákhoz és egyéb objektumokhoz fűzött megjegyzéseket.

  • Ha nincs megjegyzés, megjelenik a Megjegyzés hozzáadása lehetőség.
  • A megjegyzés megjelenítését a Megjegyzés elrejtése és a Megjegyzés megjelenítése lehetőséggel kapcsolhatja be.

A táblázat megjegyzéseiben szereplő Markdown a módosítások mentése után azonnal megjelenik a Katalóguskezelőben.

  • A megjegyzések módosításához kattintson a ceruza ikonra.
  • A megjegyzések frissítéséhez kattintson a Mentés gombra.

Az SQL-lel táblabejegyzéseket is hozzáadhat a tábla létrehozása vagy ALTER TABLE műveletei során.

Egy Delta Lake-táblára vonatkozó megjegyzések módosításakor a táblaelőzmények egyik SET TBLPROPERTIES művelete rögzíti az aktuális tábla megjegyzéseinek meghatározásához használt SQL-lekérdezést.

Példa a támogatott Markdown-dokumentációra

A Katalóguskezelő támogatja az alapszintű Markdown-szintaxist. Emojikhoz, képekhez és renderelt Markdown-táblákhoz nem használhat markdownt. A Katalóguskezelő csak két szintű Markdown-fejlécet jelenít meg.

Az alábbi példa a nyers markdown kódblokkját mutatja be. Másolja ezt a markdownt egy megjegyzésbe a Katalóguskezelőben, és kattintson a Mentés gombra az előnézethez.

# 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(): visszatérési my_value


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

További erőforrások

Az alábbi funkciókkal megjegyzéseket fűzhet az adatobjektumokhoz:

  • A COMMENT ON parancs. Ez a beállítás nem támogatja az oszlopbejegyzéseket.
  • A COMMENT beállítás a parancs vagy ALTER <object> a CREATE <object> parancs használatakor. Lásd például a CREATE TABLE [USING] és az ALTER TABLE című témakört. Ez a beállítás támogatja az oszlopbejegyzéseket.
  • Az AI által létrehozott megjegyzések (más néven AI által létrehozott dokumentáció) a Catalog Explorerben. Megtekintheti a nagyméretű nyelvi modell (LLM) által javasolt megjegyzést, amely figyelembe veszi a tábla metaadatait, például a táblaséma és az oszlopneveket, és szerkesztheti vagy elfogadhatja a megjegyzést, hogy hozzáadja azt. Ez a beállítás csak táblákat és oszlopokat támogat. Lásd: AI által létrehozott megjegyzések hozzáadása egy táblához.