スキーマオブジェクトの記述は、データエージェントにデータソーススキーマ内のテーブル、列、その他の要素に関するビジネスコンテキストを提供します。 この文脈により、エージェントは同名または曖昧なオブジェクトを区別し、それぞれのオブジェクトの目的を理解し、より正確なクエリを生成することができます。 記述は、オブジェクト名だけでは意味を明確に伝えられない大規模なスキーマに特に有用です。
スキーマオブジェクトの記述は、レイクハウス、ウェアハウス、Fabric SQLデータベース、ミラードデータベースなどのSQLデータソースでサポートされています。
注
スキーマオブジェクトの記述は現在パブリックプレビュー中です。
注
スキーマオブジェクトの記述は、データエージェントが プレビューランタイムを使用している場合にのみ利用可能です。
説明を追加または編集する
デフォルトでは、データエージェントはデータソースから利用可能な記述を継承し、それらを自動的に更新します。 データエージェントで継承した記述を編集すると、その変更はデータエージェントにのみ適用されます。 ソースの記述を上書きせず、そのオブジェクトもソースからの説明更新を受け取らなくなります。
- データエージェントを開き、「 セットアップ」を選択してください。
- データソースの下で、 スキーマオブジェクトの記述を選択します。
- スキーマを展開して、記述したいオブジェクトを見つけてください。
- オブジェクトの横にある 編集 アイコンを選択します。
- 説明を入力してから 「完了」を選択してください。
Python SDKで説明を追加してください
スキーマオブジェクトの記述をプログラム的に管理するには、FabricデータエージェントのPython SDKを使用してください。 以下の例は、既存のデータエージェントの最初のデータソースにあるあるテーブルの記述を示しています。
from fabric.dataagent.client import FabricDataAgentManagement
agent = FabricDataAgentManagement("<data-agent-name>")
datasource = agent.get_datasources()[0]
table_path = ("Schemas", "dbo", "Tables", "adoptions")
datasource.update_description({
table_path: "Contains one row for each pet adoption transaction."
})
タプルはデータソース内のパスによってスキーマ要素を識別します。 列を記述するには、その列の名前をテーブルパスに追加します。 たとえば、 table_path + ("adoption_date",)を使用します。 パス名では大文字と小文字が区別されるため、データソースに示されている階層と一致している必要があります。
効果的な説明文を書く
説明を使って、物の名前からは明らかでないビジネスの意味を説明しましょう。 各説明は簡潔かつ具体的に保管しましょう。
- 表の場合、表される事業体やイベント、表の詳細レベル、そして主な目的を記述してください。
- 列については、価値のビジネス意味、形式、単位、または不明瞭な期待値を定義してください。
- 他のスキーマ要素については、その役割とデータエージェントがいつ使用すべきかを説明してください。
- 略語、内部用語、同名のオブジェクトを明確にしてください。
- クエリを生成する際にエージェントが正しいオブジェクトや関係を選択できるようにするコンテキストを含めましょう。