Unity Catalog の Wiki

Important

この機能は ベータ版です。 アカウント管理者は、アカウント コンソール の [プレビュー ] ページからこの機能へのアクセスを管理できます。 アカウント レベルのプレビューの管理を参照してください。

ウィキは、チームが表の意味、意図された使用法、出典を記録し、その情報についてカタログエクスプローラーで直接共同作業できるようにします。 データオーナーやデータスチュワードは、定義や既知の注意事項など、テーブルに属するビジネスコンテキストを記録するためにウィキを作成し公開します。 テーブルのメタデータを閲覧できる人は、公開されたウィキを読み、コメントし、編集を提案し、リアクションすることができます。

Wiki には、1 つのテーブルを記録します。 ページでは、多くのアセットにまたがる可能性のあるビジネス概念を定義します。 特定の表のコンテキストにはウィキを使い、共有の定義にはページを使いましょう。

ウィキはテーブルの既存のコメントと並行して機能します。 Wikiやテーブルコメントを参照してください。

ウィキには何があるのか

ウィキには以下のフィールドが含まれています:

フィールド Description
Description 表の一行まとめで、ウィキの上部に示されています。
ページ本文 Unity Catalogのセキュア可能なオブジェクトやワークスペースオブジェクトの見出し、リンク、画像、インライン言及をサポートするリッチテキストドキュメント。
Sources ウィキの内容の元となる ページ や外部ソースへのリンク。

カタログエクスプローラーのテーブルの概要タブに公開されたウィキで、説明、ページ本文のセクション、そしてソースリンクが付いています

サポートされるセキュリティ保護可能なリソース

以下のUnity Catalogのセキュア可能なオブジェクトについてウィキを作成できます:

Note

Wiki は、OpenSharing を通じて共有されたセキュリティ保護可能なリソースでは利用できません。

Permissions

Wiki はセキュリティ保護可能なオブジェクトではありません。 これはテーブルのメタデータなので、テーブルに対する既存のUnity Catalog権限が、そのウィキに対して実行できる操作を決定します。 Unity Catalogの権限に関する背景については、 Unity Catalogの権限モデルの概念を参照してください。

以降の権限テーブルでは、親オブジェクトに対する使用権限という表現を、READ_METADATA、MANAGE、または所有権が効力を発揮するために必要となる使用権限を意味するものとして使用しています。 それらは、オブジェクトによって異なります。

  • 表:親スキーマに USE SCHEMA 、親カタログに USE CATALOG 。
  • スキーマ: 親カタログに対する USE CATALOG。
  • カタログ:なし。
アクション 必要な特権
公開された Wiki の閲覧と共同編集: 公開された Wiki の閲覧、自身のコメントの追加、編集、削除、編集の提案、およびリアクションの追加 次のいずれか:
  • テーブルに対する SELECT、スキーマに対する USE SCHEMA、およびカタログに対するUSE CATALOG
  • 親カタログの BROWSE
  • テーブル、スキーマ、カタログ、またはメタストアに対する READ_METADATA (親オブジェクトに対する使用権限を含む)
  • テーブル、スキーマ、またはカタログに対する MANAGE (親オブジェクトに対する使用権限を含む)
  • テーブル、親スキーマ、または親カタログの所有者であり、親オブジェクトの使用権限を持つ
  • メタストア管理者
ドラフトウィキを見る 次のいずれか:
  • テーブル、スキーマ、カタログ、またはメタストアに対する READ_METADATA (親オブジェクトに対する使用権限を含む)
  • テーブル、スキーマ、またはカタログに対する MANAGE (親オブジェクトに対する使用権限を含む)
  • テーブル、親スキーマ、または親カタログの所有者であり、親オブジェクトの使用権限を持つ
  • メタストア管理者
ウィキとコメントの管理:ウィキの作成、編集、公開、または非公開、提案された編集の承認・拒否、コメントの削除 次のいずれか:
  • テーブル、スキーマ、またはカタログに対する MANAGE (親オブジェクトに対する使用権限を含む)
  • テーブル、親スキーマ、または親カタログの所有者であり、親オブジェクトの使用権限を持つ
  • メタストア管理者

ウィキを作成してください

ウィキを作成するには、テーブルのウィキを管理する権限が必要です。 「 アクセス許可」を参照してください。

手動でウィキを作成することも、Genie Codeで下書きを作成することもできます。

Warning

WikiデータはMicrosoft管理の鍵で静止時に暗号化されています。 ウィキは顧客管理鍵(CMK)暗号化をサポートしていません。 ウィキの説明文やページ本文に個人情報、規制データ、その他の機密情報を含めないでください。

  1. カタログエクスプローラーでテーブルを開きます。

  2. 概要タブで「ウィキ作成」をクリックします。 [Wiki の作成] バナーを閉じた場合は、代わりにページ右上隅にある ケバブ メニュー アイコン ケバブ メニューをクリックし、[Wiki の作成] を選択します。 テーブルに既存のコメントがあれば、ウィキのページ本文の初期値として設定します。

    概要タブのテーブルの説明の上に表示される「Create wikiバナー」

  3. ウィキの内容を追加してください:

    • 手動で作成するには、説明文とページ本文を入力し、ソースを追加してください。
    • Genie Codeでドラフトする場合は、ウィキエディターのGenie Codeパネルをご利用ください。 Genie Codeが作業できるファイルやその他の関連情報を添付してください。 Genie Code を参照してください。
  4. ウィキの作業を続けるには「ドラフトとして保存」をクリックし、「公開」をクリックするとテーブルのメタデータを閲覧できるすべての人に表示されます。

ウィキを公開すると、テーブルの「概要」タブの上部に表示され、テーブルの 説明 は「詳細」タブに移動します。

ウィキの編集と公開

Wiki を編集、公開、または非公開にするには、テーブルで Wiki を管理する権限が必要です。 「 アクセス許可」を参照してください。

  1. カタログエクスプローラーでテーブルを開きます。

  2. Wiki で、[編集] をクリックします。

  3. 変更を加えてから [保存] をクリックして保存するか、[公開] をクリックして下書きの Wiki を公開します。

    編集モードのドラフトウィキで、キャンセル、保存、公開ボタンがあります

公開されたウィキを内容を失わずに非表示にするには、 編集をクリックし、ケバブメニューをクリックし、その後「 公開解除」をクリックしてください。 ウィキは、ドラフトを閲覧できるユーザーだけが見られる下書きに戻ります。 ウィキを再度公開するまでは、テーブルの 説明 が 概要 タブの上部に表示されます。

編集モードの公開済みウィキのケバブメニューにある「公開解除」オプション

ウィキで共同作業する

公開されたウィキを閲覧できる人は誰でもそのウィキで共同作業できます。 「 アクセス許可」を参照してください。

  • コメント: 質問をしたり、補足情報を追加したりしてください。 ご自身のコメントを編集または削除できます。
  • 編集を提案:ウィキのページ本文への変更提案。 「 提案」をクリックし、ページ本文を編集し、「 保存」をクリックします。 ウィキを管理する権限を持つユーザーは提案を受け入れるか拒否するかを決めます。
  • React:ウィキに賛否をつけて、役に立ったかどうかを伝えてください。

Wiki とテーブルのコメント

ウィキはテーブルのコメントを置き換えるものではないため、コメントを読み書きする既存のパイプラインは引き続き機能します:

  • コメントは引き続き COMMENT ON TABLE や ALTER TABLEで設定できます。 このコメントは今も information_schema やカタログエクスプローラーの 説明 欄に表示されます。
  • ウィキを作成すると、テーブルの既存のコメントがウィキのページ本文にシードされます。 その後はウィキとコメントは独立しています。 一方の変更はもう一方を更新しません。

テーブルコメントの詳細については、「データ資産と AI 資産にコメントを追加する」をご覧ください。

REST APIでウィキを管理する

テーブルのウィキをプログラム的に読み、ウィキのREST APIを使って更新してください。 APIは以下の操作をサポートしています:

  • ウィキを取得する: 表のウィキを取り出します。
  • ウィキを更新する:テーブルのウィキを更新するか、テーブルにウィキがなければ作成してください。 ウィキの状態を公開に設定すると公開されます。

APIはUIと同じ権限を必要とします。 「 アクセス許可」を参照してください。 リクエストは、ワークスペースユーザー用のDatabricks個人用アクセストークン、またはOAuthで認証してください。

リクエストおよびレスポンスの詳細は、Wikis REST APIリファレンスを参照してください。

Limitations

  • Wiki は、「サポートされているセキュリティ保護可能なリソース」に一覧表示されているセキュリティ保護可能なオブジェクトでのみ利用可能です。 カラム、スキーマ、カタログ、その他のセキュリティ保護可能なオブジェクトに関するウィキはサポートされていません。
  • 各テーブルは1つのウィキを持つことができます。
  • WikiはAzure Government、Azure China、FedRAMPの各地域では利用できません。