Dokumentowanie danych w Eksploratorze wykazu przy użyciu komentarzy markdown

  • Artykuł

Użytkownicy mogą używać Eksploratora wykazu do wyświetlania komentarzy dotyczących zasobów danych, takich jak wykazy, schematy i tabele. W tym artykule opisano, jak właściciele obiektów lub użytkownicy z uprawnieniami do modyfikowania obiektów mogą dodawać te komentarze ręcznie przy użyciu Eksploratora wykazu.

Uwaga

W przypadku tabel i kolumn Eksplorator wykazu umożliwia również wyświetlanie sugestii dotyczących komentarzy generowanych przez sztuczną inteligencję i stosowanie ich. Zobacz Dodawanie komentarzy generowanych przez sztuczną inteligencję do tabeli.

Jeśli używasz wykazu aparatu Unity, możesz użyć Eksploratora wykazu, aby dodawać i edytować komentarze do wszystkich obiektów innych niż te w wykazie udostępniania różnicowego.

W przypadku danych w magazynie metadanych Hive można użyć Eksploratora wykazu do edytowania tylko komentarzy tabeli.

Język Markdown udostępnia niezawodny zestaw opcji dokumentowania danych, zwiększając opcje dostępne dla użytkowników usługi Azure Databricks w celu zwiększenia możliwości odnajdywania i zrozumienia udostępnionych zasobów danych. Używanie komentarzy markdown nie ma wpływu na wydajność zapytań. Język Markdown nie jest renderowany w przypadku zwracania przez DESCRIBE instrukcje.

Dodawanie komentarzy markdown do obiektów danych przy użyciu Eksploratora wykazu

Eksplorator wykazu wyświetla komentarze dla katalogów, schematów, tabel i innych zasobów poniżej nazwy obiektu.

  • Jeśli komentarz nie istnieje, zostanie wyświetlona opcja Dodaj komentarz .
  • Możesz przełączać wyświetlanie komentarzy za pomocą opcji Ukryj komentarz i Pokaż komentarz .

Znaczniki Markdown w komentarzach tabeli są renderowane w Eksploratorze wykazu zaraz po zapisaniu zmian.

  • Kliknij ikonę ołówka, aby zmodyfikować komentarze.
  • Kliknij przycisk Zapisz , aby zaktualizować komentarze.

Możesz również użyć języka SQL, aby dodać komentarze do tabeli podczas tworzenia lub ALTER TABLE akcji tabeli.

Podczas modyfikowania komentarzy w tabeli SET TBLPROPERTIES usługi Delta Lake operacja w historii tabeli rejestruje zapytanie SQL używane do definiowania bieżących komentarzy tabeli.

Przykład obsługiwanej dokumentacji języka Markdown

Eksplorator wykazu obsługuje podstawową składnię języka Markdown. Nie można używać języka Markdown dla emoji, obrazów i renderowanych tabel języka Markdown. Eksplorator wykazu renderuje tylko dwa poziomy nagłówków markdown.

W poniższym przykładzie pokazano blok kodu nieprzetworzonego języka Markdown. Skopiuj ten znacznik markdown do komentarza w Eksploratorze wykazu i kliknij przycisk Zapisz w wersji zapoznawczej.

# 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(): zwracanie my_value


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

Więcej zasobów

Możesz również użyć następujących funkcji, aby dodać komentarze do obiektów danych:

  • POLECENIE KOMENTARZ NA . Ta opcja nie obsługuje komentarzy kolumn.
  • Opcja COMMENT w przypadku użycia CREATE <object> polecenia lub ALTER <object> . Na przykład zobacz CREATE TABLE [USING] (TWORZENIE TABELI [USING] i ALTER TABLE). Ta opcja obsługuje komentarze kolumn.
  • Komentarze generowane przez sztuczną inteligencję (nazywane również dokumentacją wygenerowaną przez sztuczną inteligencję) w Eksploratorze wykazu. Możesz wyświetlić komentarz sugerowany przez duży model językowy (LLM), który uwzględnia metadane tabeli, takie jak schemat tabeli i nazwy kolumn, oraz edytować lub zaakceptować komentarz w miarę dodawania. Ta opcja obsługuje tylko tabele i kolumny. Zobacz Dodawanie komentarzy generowanych przez sztuczną inteligencję do tabeli.