データと AI 資産にコメントを追加する

  • [アーティクル]

この記事では、データと AI 資産のコメントを紹介し、それらを追加する方法について説明します。 コメントは、必要なデータと AI 資産を自分や他のユーザーが見つけて管理するのに役立ちます。

コメントでは、セキュリティ保護可能なオブジェクトに注釈を付けるためのメタデータ フィールドが提供されます。 Unity Catalog のセキュリティ保護可能なオブジェクト (カタログ、スキーマ、テーブル、ボリューム、AI モデルなど) にコメントを追加できます。 テーブル列にコメントを追加することもできます。

コメントは手動で追加することも、Databricks で AI 生成コメントを自動的に作成することもできます。 AI 生成コメント (AI 生成ドキュメントともいう) は、テーブルとテーブル列で使用できます。 「AI によって生成されたコメントをテーブルに追加する」を参照してください。

Unity Catalog テーブル (またはレガシ Hive メタストアの Delta Lake テーブル) のコメントを変更すると、テーブル履歴の SET TBLPROPERTIES 操作によって、テーブル コメントの定義に使用された SQL クエリが記録されます。

開始する前に

コメントを追加または編集するには、次の要件を満たす必要があります。

  • カタログ、スキーマ、ボリューム、モデル、共有、受信者、プロバイダー、ストレージ資格情報、外部の場所、または接続に関するコメントを追加または編集するには、オブジェクトの所有者である必要があります。
  • テーブルまたは列に対するコメントの追加または編集を行うには、所有者であるか、次の権限を持っている必要があります。
    • テーブルに対する MODIFY および SELECT。
    • 親カタログとスキーマに対する USE CATALOG および USE SCHEMA。
  • Unity Catalog (共有またはシングル ユーザー コンピューティング) をサポートする SQL ウェアハウスまたはその他のコンピューティングを使用する必要があります。
  • AI 生成コメントを使用するには、ワークスペースで AI 支援機能が有効になっている必要があります。 「AI によって生成されたコメントをテーブルに追加する」を参照してください。

コメントを追加および編集する

セキュリティ保護可能なオブジェクトにコメントを追加したり、SQL コマンドまたはカタログ エクスプローラーを使用して編集したりできます。

カタログ エクスプローラー

  1. ワークスペースのサイド バーで、カタログ アイコン [カタログ] をクリックしてカタログ エクスプローラーを開きます。

  2. コメントするオブジェクトを検索して選択します。

    データおよび AI オブジェクトは、[カタログ] ペインで一覧表示され、検索できます。 共有、ストレージ資格情報、外部の場所、接続には、歯車アイコン 歯車アイコンをクリックすると開くメニューを使用してアクセスできます。

  3. コメントを追加するか、既存のコメントを編集します。

    • AI 生成コメントを使用してテーブルにコメントを追加するには、[概要] タブの右側のペインで [AI 推奨コメント] を表示します。表示されるまでに数秒かかる場合があります。 そのまま受け入れるか、編集して保存します。
    • AI 生成コメントを使用してテーブル列にコメントを追加するには、列リストの上にある [AI 生成] ボタンをクリックします。 Databricks では、列ごとにコメントが生成されます。 そのまま受け入れるか、編集します。 チェック マークをクリックしてコメントを保存します。
    • AI 生成コメントをサポートしていないオブジェクトにコメントを追加するには、[コメントの追加] をクリックしてコメントを追加します。
    • AI 生成コメントを使用せずにテーブル列にコメントを追加するには、列行の 列タグまたはコメントを追加するアイコン [コメントの追加] アイコンをクリックします。
    • コメントが既に存在する場合、オブジェクト名の下または [概要] タブの右側のペインに表示されます。 AI 生成でない場合は、[編集] アイコン 編集アイコンをクリックして編集します。

基本的な Markdown を使用して、カタログ エクスプローラー UI でコメントのスタイルを設定できます。 DESCRIBE ステートメントによって返されるときは、Markdown スタイルはレンダリングされません。 カタログ エクスプローラーでは、イメージを除くすべての基本的な構文がサポートされ、2 つの見出しレベルのみがレンダリングされます。 詳細については、「基本構文」を参照してください。

AI 生成コメントの詳細については、「AI によって生成されたコメントをテーブルに追加する」を参照してください。

SQL

SQL コマンドを使用すると、Unity Catalog 内のセキュリティ保護可能なオブジェクトや、レガシ Hive メタストアで管理されているテーブルに、文字列リテラルをコメントとして追加できます。 使用する SQL コマンドは、コメントを追加または編集するオブジェクトによって異なります。

  • テーブル列を除く既存のセキュリティ保護可能なオブジェクトのコメントを追加または更新するには、COMMENT ON コマンドを使用します。 「COMMENT ON」を参照してください。

    COMMENT オプションは、オブジェクトの ALTER <object> コマンド (ALTER TABLE など) で使用することもできます。 ALTER <object> コマンドについては、SQL リファレンス記事を参照してください。

  • 既存のテーブルの列コメントを追加または更新するには、列で COMMENT オプションおよびALTER COLUMN 句を指定して ALTER TABLE コマンドを使用します。 「ALTER TABLE」および ALTER TABLE … COLUMN 句に関するページを参照してください。

  • オブジェクトの作成時にコメントを追加するには、CREATE <object> コマンドで COMMENT オプションを使用します。 使用する CREATE <object> コマンドについては、SQL リファレンス記事を参照してください。