Knowledge Catalog で Dataform リポジトリのメタデータを管理する

このドキュメントでは、Knowledge Catalog を使用して Dataform リポジトリのメタデータを表示し、アスペクトでアノテーションを付ける方法について説明します。

Knowledge Catalog を使用すると、メタデータを保存して管理できます。Dataform リポジトリは、追加の構成なしでデフォルトで Knowledge Catalog で使用できます。Knowledge Catalog は、Dataform リポジトリから次のメタデータを自動的に取得します。

  • データアセット名
  • データアセットの親
  • データアセットのロケーション
  • データアセットのタイプ
  • 対応する Google Cloud プロジェクト
  • サードパーティのリポジトリのソース
  • サービス アカウント

始める前に

  1. Google Cloud コンソールのプロジェクト セレクタページで、 Google Cloud プロジェクトを選択または作成します。

    プロジェクトの選択または作成に必要なロール

    • プロジェクトを選択する: プロジェクトの選択に特定の IAM ロールは必要ありません。ロールが付与されているプロジェクトであれば、どのプロジェクトでも選択できます。
    • プロジェクトを作成する: プロジェクトを作成するには、resourcemanager.projects.create 権限を含むプロジェクト作成者ロール（roles/resourcemanager.projectCreator）が必要です。詳しくは、ロールを付与する方法をご覧ください。

    プロジェクト セレクタに移動

  2. Dataplex API を有効にします。

    API を有効にするために必要なロール

    API を有効にするには、serviceusage.services.enable 権限を含む Service Usage 管理者 IAM ロール（roles/serviceusage.serviceUsageAdmin）が必要です。詳しくは、ロールを付与する方法をご覧ください。

    API の有効化

  3. 必要な Identity and Access Management（IAM）権限があることを確認します。

必要なロール

Knowledge Catalog で Dataform リポジトリを管理するには、Dataform リソースへのアクセスを許可する事前定義された Dataform ロールと、必要な Knowledge Catalog ロールが必要です。

Knowledge Catalog でメタデータを管理する

Knowledge Catalog は、Dataform リポジトリを次のエントリ値を持つエントリとしてログに記録します。

システム エントリ グループ
Dataform リポジトリのシステム エントリ グループは @dataform です。Knowledge Catalog でリポジトリ エントリの詳細を表示するには、dataform システム エントリ グループを表示する必要があります。エントリ グループ内のすべてのエントリのリストを表示する手順については、Knowledge Catalog ドキュメントのエントリ グループの詳細を表示するをご覧ください。
システム エントリのタイプ
Dataform リポジトリのシステム エントリ タイプは dataform-repository です。Dataform リポジトリの詳細を表示するには、dataform-repository システム エントリ タイプを表示する必要があります。選択したエントリタイプの詳細を表示する手順については、Knowledge Catalog ドキュメントのエントリタイプの詳細を表示するをご覧ください。選択したエントリの詳細を表示する手順については、Knowledge Catalog ドキュメントのエントリの詳細を表示するをご覧ください。

アセットを検索する

Knowledge Catalog でデータアセットを検索する方法については、Knowledge Catalog ドキュメントの Knowledge Catalog でデータアセットを検索するをご覧ください。

リポジトリにアノテーションを付ける

Knowledge Catalog の Dataform リポジトリにコンテキストを追加するには、アスペクトを使用して Dataform エントリにアノテーションを付けます。

Dataform リポジトリのシステム アスペクト タイプは dataform-repository です。

エントリにアスペクトをアノテーションする方法については、Knowledge Catalog ドキュメントのアスペクトを管理してメタデータを拡充するをご覧ください。

制限事項

Knowledge Catalog で Dataform リポジトリを管理するには、次の制限があります。

  • Knowledge Catalog では、Dataform ファイルレベルのアセット（テーブルやビューなど）を表示または管理できません。

ロケーション

Knowledge Catalog を使用すると、すべての Dataform ロケーションから Dataform リポジトリを管理できます。

割り当て

Knowledge Catalog で Dataform リポジトリを管理する場合は、Knowledge Catalog の割り当てと上限が適用されます。

料金

Knowledge Catalog で Dataform リポジトリを管理する場合は、Knowledge Catalog の料金が適用されます。

次のステップ

  • Knowledge Catalog の詳細については、Knowledge Catalog のドキュメントの Knowledge Catalog の概要をご覧ください。