データと AI アセットにコメントを追加する

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

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

コメントは手動で追加することも、Databricks で AI が生成したコメントを作成させることもできます。 AI が生成したコメント (AI が生成したドキュメントとも呼ばれます) は、テーブルとテーブル列で使用できます。 「AI で生成されたコメントを Unity Catalog オブジェクトに追加する」を参照してください。

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

始める前に

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

• カタログ、スキーマ、ボリューム、モデル、共有、受信者、プロバイダー、ストレージ認証情報、外部ロケーション、または接続に対するコメントを追加または編集するには、オブジェクトの所有者であるか、オブジェクトに対する MANAGE 権限を持っている必要があります。

• テーブルまたは列のコメントを追加または編集するには、所有者であるか、次の権限を持っている必要があります。

  • MODIFY そしてテーブルの上に SELECT 。
  • USE CATALOG 親カタログとスキーマに USE SCHEMA します。

• SQLをサポートする ウェアハウスまたはその他のコンピュートを使用する必要があります。Unity Catalog

• AI が生成したコメントを使用するには、ワークスペースで AI 支援機能が有効になっている必要があります。 「AI で生成されたコメントを Unity Catalog オブジェクトに追加する」を参照してください。

コメントの追加と編集

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

Catalog Explorer

important

コメントを保存すると、 ALTER SQL コマンドがトリガーされ、Databricks のパイプラインとジョブが中断される可能性があります。

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

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

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

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

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

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

AIで生成されたコメントの詳細については、「AIで生成されたコメントを Unity Catalog オブジェクトに追加する」を参照してください。

SQL

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

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

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

• 既存のテーブルのカラム・コメントを追加または更新するには、カラムの ALTER COLUMN 句と COMMENT オプションを指定して ALTER TABLE コマンドを使用します。ALTER TABLE と ALTER TABLE ...COLUMN 句。

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