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

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

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

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

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

始める前に

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

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

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

    • MODIFY そしてテーブルの上に SELECT 。

    • USE CATALOG 親カタログとスキーマに USE SCHEMA します。

  • (共有またはシングルユーザー コンピュート) SQLをサポートする ウェアハウスまたはその他のコンピュートを使用する必要があります。Unity Catalog

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

コメントの追加と編集

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

  1. ワークスペースサイドバーで、カタログ アイコンカタログをクリックすると、カタログ エクスプローラーが開きます。

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

    データと AI オブジェクトはカタログペインにリストされ、検索可能です。 共有、ストレージの資格情報、外部ロケーション、接続には、歯車アイコン歯車アイコン。

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

    • AI 生成コメントを使用してテーブルにコメントを追加するには、 [概要]タブの右側のペインでAI 提案コメントを表示します。 表示されるまでに数秒かかる場合があります。 そのまま 受け入れる か、 編集 して保存します。

    • AI 生成コメントを使用してテーブル列にコメントを追加するには、列リストの上にあるAI 生成ボタンをクリックします。 Databricks は各列に対してコメントを生成します。 そのまま受け入れるか、編集します。 チェックマークをクリックして、コメントを保存します。

    • AI 生成コメントをサポートしていないオブジェクトにコメントを追加するには、 「コメントを追加」をクリックしてコメントを追加します。

    • AI生成コメントを使用せずにテーブル列にコメントを追加するには、列タグまたはコメントを追加するためのアイコン列の行にコメント アイコンを追加します。

    • コメントがすでに存在する場合は、概要タブの右側のペインまたはオブジェクト名の下に表示されます。 AI生成でない場合は、編集アイコン編集するには編集アイコンをクリックします。

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

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

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 リファレンス記事を参照してください。