マークダウンコメントを使用した「カタログエクスプローラ」でのデータのドキュメント化

ユーザーは 「カタログエクスプローラ」(Catalog Explorer ) を使用して、カタログ、スキーマ、表などのデータ資産に関するコメントを表示できます。 この記事では、オブジェクトの所有者またはオブジェクトに対する修正パーミッションを持つユーザーが、「カタログエクスプローラ」(Catalog Explorer) を使用してこれらのコメントを手動で追加する方法について説明します。

注：

テーブルと列の場合、カタログエクスプローラでは、AIが生成したコメント候補を表示して適用することもできます。 AIが生成したコメントを表に追加するを参照してください。

Unity Catalog を使用している場合は、カタログ エクスプローラーを使用して、Delta Sharing カタログ内のオブジェクト以外のすべてのオブジェクトにコメントを追加および編集できます。

Hive metastore内のデータについては、「カタログエクスプローラ」(Catalog Explorer) を使用してテーブルコメントのみを編集できます。

Markdown には、データを文書化するための堅牢なオプション セットが用意されており、Databricks ユーザーが共有データ資産の検出可能性と理解を深めるためのオプションが強化されています。 マークダウンコメントを使用しても、クエリーのパフォーマンスには影響しません。 Markdown は、 DESCRIBE ステートメントによって返された場合にレンダリングされません。

「カタログエクスプローラ」(Catalog Explorer) を使用したデータオブジェクトへのマークダウンコメントの追加

「カタログエクスプローラ」(Catalog Explorer) では、カタログ、スキーマ、テーブル、およびその他のアセットのコメントがオブジェクト名の下に表示されます。

  • コメントが存在しない場合は、[ コメントの追加 ] オプションが表示されます。

  • コメントの表示は、[ コメントを非表示] オプションと [コメントを表示] オプションで切り替えることができます。

テーブルコメントのマークダウンは、変更を保存するとすぐに「カタログエクスプローラ」(Catalog Explorer) に表示されます。

  • 鉛筆アイコンをクリックして、コメントを変更します。

  • [ 保存 ] をクリックしてコメントを更新します。

また、SQL を使用して、テーブルの作成時または ALTER TABLE アクション時にテーブル コメントを追加することもできます。

Delta Lake テーブルのコメントを変更する場合、テーブル履歴の SET TBLPROPERTIES 操作により、現在のテーブルコメントの定義に使用された SQL クエリーが記録されます。

サポートされているマークダウンドキュメントの例

「カタログエクスプローラ」では、基本的なマークダウン構文がサポートされています。 絵文字、画像、レンダリングされたマークダウンテーブルにマークダウンを使用することはできません。 カタログエクスプローラでは、2 レベルのマークダウンヘッダーのみがレンダリングされます。

次の例は、生のマークダウンのコードブロックを示しています。 このマークダウンを「カタログエクスプローラ」(Catalog Explorer) のコメントにコピーし、「 プレビューに保存」(Save to preview) をクリックします。

# 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 コマンド。このオプションでは、列のコメントはサポートされていません。

  • CREATE <object> または ALTER <object> コマンドを使用する場合のCOMMENTオプション。たとえば、「CREATE TABLE [USING]」 および 「ALTER TABLE」を参照してください。 このオプションは、列のコメントをサポートします。

  • カタログエクスプローラの AI 生成コメント (AI 生成ドキュメントとも呼ばれます)。 テーブル スキーマや列名などのテーブル メタデータを取得する大規模言語モデル (LLM) によって提案されたコメントを表示し、コメントをそのまま編集または受け入れることで追加できます。 このオプションは、テーブルと列のみをサポートします。 AIが生成したコメントを表に追加するを参照してください。