markdown 주석을 사용하여 카탈로그 탐색기에서 데이터 문서화

사용자는 카탈로그 탐색기를 사용하여 카탈로그, 스키마 및 테이블과 같은 데이터 자산에 대한 주석을 볼 수 있습니다. 이 문서에서는 개체 소유자 또는 개체에 대한 수정 권한이 있는 사용자가 카탈로그 탐색기를 사용하여 이러한 주석을 수동으로 추가하는 방법을 설명합니다.

참고 항목

테이블 및 열의 경우 카탈로그 탐색기를 사용하면 AI에서 생성된 주석 제안을 보고 적용할 수도 있습니다. 테이블에 AI 생성 주석 추가를 참조 하세요.

Unity 카탈로그를 사용하는 경우 카탈로그 탐색기를 사용하여 델타 공유 카탈로그에 있는 개체가 아닌 다른 모든 개체에 대한 주석을 추가하고 편집할 수 있습니다.

Hive 메타스토어의 데이터의 경우 카탈로그 탐색기를 사용하여 테이블 주석만 편집할 수 있습니다.

Markdown은 데이터를 문서화하기 위한 강력한 옵션 집합을 제공하여 Azure Databricks 사용자가 공유 데이터 자산의 검색 가능성과 이해도를 높이기 위해 갖는 옵션을 향상합니다. markdown 주석을 사용하면 쿼리 성능에 영향을 주지 않습니다. DESCRIBE 문에서 반환할 때 Markdown은 렌더링되지 않습니다.

카탈로그 탐색기를 사용하여 데이터 개체에 markdown 주석 추가

카탈로그 탐색기는 개체 이름 아래에 카탈로그, 스키마, 테이블 및 기타 자산에 대한 주석을 표시합니다.

• 주석이 없으면 주석 추가 옵션이 표시됩니다.
• 주석 숨기기 및 주석 표시 옵션을 사용하여 주석 표시를 전환할 수 있습니다.

변경 내용을 저장하는 즉시 테이블 주석의 Markdown이 카탈로그 탐색기에서 렌더링됩니다.

• 연필 아이콘을 클릭하여 주석을 수정합니다.
• 저장을 클릭하여 주석을 업데이트합니다.

SQL을 사용하여 테이블을 만들거나 ALTER TABLE 작업을 하는 동안 테이블 주석을 추가할 수도 있습니다.

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 명령입니다. 이 옵션은 열 주석을 지원하지 않습니다.
• COMMENT 또는 ALTER <object> 명령을 사용할 때의 CREATE <object> 옵션입니다. 예를 들어 CREATE TABLE [USING] 및 ALTER TABLE을 참조하세요. 이 옵션은 열 주석을 지원합니다.
• 카탈로그 탐색기에서 AI에서 생성된 주석(AI 생성 설명서라고도 함). 테이블 스키마 및 열 이름과 같은 테이블 메타데이터를 고려하는 LLM(큰 언어 모델)에서 제안하는 주석을 보고 주석을 편집하거나 그대로 받아 추가하여 추가할 수 있습니다. 이 옵션은 테이블 및 열만 지원합니다. 테이블에 AI 생성 주석 추가를 참조 하세요.