Data Catalog API メソッドを Knowledge Catalog にマッピングする

Data Catalog は非推奨となりました。プログラマティック ワークフロー、スクリプト、クライアント ライブラリ、Terraform 構成を Data Catalog から Knowledge Catalog に移行する場合は、Dataplex API を使用するようにコードを更新する必要があります。

このドキュメントでは、Data Catalog のリソース、機能、API メソッドと、Dataplex API の同等のリソース、機能、API メソッドのマッピングについて説明します。

移行手順については、Data Catalog から Knowledge Catalog への移行をご覧ください。API リファレンス ドキュメントについては、Dataplex API REST ドキュメントDataplex API RPC ドキュメントをご覧ください。

リソース マッピング

次の表に、Data Catalog のリソースと Knowledge Catalog のリソースの関係を示します。

Data Catalog リソース Knowledge Catalog リソース 説明
公開タグ テンプレート アスペクト タイプ(global タグ テンプレートは、リージョン間で使用できる Data Catalog のリージョン リソースです。これらは、Knowledge Catalog の global アスペクト タイプに対応しています。
公開タグ オプションのアスペクト 公開タグは、Knowledge Catalog のエントリまたは列に付加されたオプションのアスペクトに対応しています。
エントリ グループ エントリ グループ エントリ グループは、両方のサービスで組織コンテナとセキュリティ コンテナとして機能します。 Google Cloud ソースの場合、@bigquery などのシステム エントリ グループはプロジェクトごとに自動的に設定されます。
カスタム エントリ カスタム エントリ(必須アスペクトあり) 標準のカスタム エントリ プロパティは、カスタム エントリの EntryType で定義された必須アスペクトとしてモデル化されます。
システム(Google Cloud)のエントリ システム エントリ(必須アスペクトあり) BigQuery テーブルの Schema など、組み込みエンティティを記述するメタデータは、システム定義のアスペクト タイプの必須アスペクトでキャプチャされます。
ビジネス用語集 ビジネス用語集 企業全体でビジネス コンテキストを標準化するビジネス用語の分類法。

機能の比較

次の表は、Knowledge Catalog と Data Catalog のメタデータ管理機能を比較したものです。

機能 Knowledge Catalog Data Catalog
サポートされている Google Cloud ソース サポートされている Google Cloud ソースで説明されているすべてのソース。 Data Catalog のドキュメントで説明されているすべてのソース。
カスタムソースの取り込み

エントリタイプで定義された、管理対象の構造を持つカスタム エントリへの取り込み。

Data Catalog のカスタム エントリとエントリ グループは、Knowledge Catalog の generic エントリタイプで使用できます。

汎用カスタム エントリへの取り込み。
メタデータ拡張

ビジネス用語集、アスペクト、アスペクト タイプを使用してキャプチャされます。

エントリ リンクはサポートされています。アスペクトをエントリリンクに直接関連付けることができます。

ビジネス用語集、タグ、タグ テンプレートを使用してキャプチャされます。

エントリ リンクはサポートされていません。

エントリリンク サポートされています。synonymdefinitionrelatedschema-join などの組み込み型を使用すると、エントリと列を接続できます。 利用できません。
メタデータ変更フィード Pub/Sub にストリーミングされるほぼリアルタイムのメタデータ変更通知。 利用できません。
検索 検索は、同じ組織と VPC Service Controls 境界内のサポートされているすべての Google Cloud ソース、カスタム エントリ、アスペクト、移行された Data Catalog コンテンツに対して実行されます。 検索は、サポートされているソース、カスタム エントリ、Data Catalog で作成されたタグに対して実行されます。
データリネージ Dataplex API を使用してアセットノードのエントリの詳細を取得します。 Google Cloud コンソールに、アタッチされたアスペクトが表示されます。 Data Catalog API を使用してエントリの詳細を取得します。
ビジネス用語集 ビジネス用語の分類法を構築し、データアセット(エントリ)と列の両方に関連付けることができます。 用語を列に関連付けることができます。

Data Catalog API メソッドを Knowledge Catalog にマッピングする

次の表に、Data Catalog API(google.cloud.datacatalog.v1)と Dataplex API(google.cloud.dataplex.v1.CatalogService)のメソッドごとのマッピングを示します。

エントリ グループ

エントリ グループのコンセプトは、両方のサービスで一貫しています。

Data Catalog API メソッド Dataplex API メソッド
projects.locations.entryGroups.create(REST)
CreateEntryGroup(RPC)
projects.locations.entryGroups.create(REST)
CreateEntryGroup(RPC)
projects.locations.entryGroups.get(REST)
GetEntryGroup(RPC)
projects.locations.entryGroups.get(REST)
GetEntryGroup(RPC)
projects.locations.entryGroups.patch(REST)
UpdateEntryGroup(RPC)
projects.locations.entryGroups.patch(REST)
UpdateEntryGroup(RPC)
projects.locations.entryGroups.delete(REST)
DeleteEntryGroup(RPC)
projects.locations.entryGroups.delete(REST)
DeleteEntryGroup(RPC)
projects.locations.entryGroups.list(REST)
ListEntryGroups(RPC)
projects.locations.entryGroups.list(REST)
ListEntryGroups(RPC)

エントリ

データアセットを表すエントリのコンセプトは、両方のサービスで一貫しています。

Data Catalog API メソッド Dataplex API メソッド
projects.locations.entryGroups.entries.create(REST)
CreateEntry(RPC)
projects.locations.entryGroups.entries.create(REST)
CreateEntry(RPC)
projects.locations.entryGroups.entries.get(REST)
GetEntry(RPC)
projects.locations.entryGroups.entries.get(REST)
GetEntry(RPC)
projects.locations.entryGroups.entries.patch(REST)
UpdateEntry(RPC)

projects.locations.entryGroups.entries.patch(REST)
UpdateEntry(RPC)

注: projects.locations.modifyEntry(REST)メソッドと ModifyEntry(RPC)メソッドを使用して、カタログ権限ではなくソースシステムの権限を使用してシステム エントリを更新することもできます。

projects.locations.entryGroups.entries.delete(REST)
DeleteEntry(RPC)
projects.locations.entryGroups.entries.delete(REST)
DeleteEntry(RPC)
projects.locations.entryGroups.entries.list(REST)
ListEntries(RPC)
projects.locations.entryGroups.entries.list(REST)
ListEntries(RPC)
entries.lookup(REST)
LookupEntry(RPC)
projects.locations.lookupEntry(REST)
LookupEntry(RPC)

注: lookupEntry を使用するには、エントリ名を指定する必要があります。BigQuery SQL 名、完全修飾名、リンクされたリソース名をエントリ名に変換するには、まず projects.locations.searchEntries(REST)または SearchEntries(RPC)を呼び出します。

projects.locations.entryGroups.entries.modifyEntryContacts(REST)
ModifyEntryContacts(RPC)
projects.locations.entryGroups.entries.patch(REST)
UpdateEntry(RPC)

注: update_mask を使用して、contacts アスペクトのみを変更します。

projects.locations.entryGroups.entries.modifyEntryOverview(REST)
ModifyEntryOverview(RPC)
projects.locations.entryGroups.entries.patch(REST)
UpdateEntry(RPC)

注: update_mask を使用して、overview アスペクトのみを変更します。

projects.locations.entryGroups.entries.tags.reconcile(REST)
ReconcileTags(RPC)
projects.locations.metadataJobs.create(REST)
CreateMetadataJob(RPC)、
projects.locations.entryGroups.entries.patch(REST)
UpdateEntry(RPC)

注: CreateMetadataJob をインポート ジョブタイプで使用して、複数のエントリのメタデータ コンテンツを一括でインポートします。単一のエントリのすべてのアスペクトを更新するには、UpdateEntry を使用します。

catalog.search(REST)
SearchCatalog(RPC)
projects.locations.searchEntries(REST)
SearchEntries(RPC)

注: searchEntries は、発信者の組織内を検索します。組織をまたぐ検索は、組織ごとに個別に発行する必要があります。

タグ テンプレートとアスペクト タイプ

アスペクト タイプは、Data Catalog タグ テンプレートの後継です。

Data Catalog API メソッド Dataplex API メソッド
projects.locations.tagTemplates.create(REST)
CreateTagTemplate(RPC)
projects.locations.aspectTypes.create(REST)
CreateAspectType(RPC)
projects.locations.tagTemplates.get(REST)
GetTagTemplate(RPC)
projects.locations.aspectTypes.get(REST)
GetAspectType(RPC)
projects.locations.tagTemplates.patch(REST)
UpdateTagTemplate(RPC)
projects.locations.aspectTypes.patch(REST)
UpdateAspectType(RPC)
projects.locations.tagTemplates.delete(REST)
DeleteTagTemplate(RPC)
projects.locations.aspectTypes.delete(REST)
DeleteAspectType(RPC)
type=tag_template を含む catalog.search(REST)
type=tag_template を含む SearchCatalog(RPC)
projects.locations.aspectTypes.list(REST)
ListAspectTypes(RPC)

タグ テンプレートのフィールド

タグ テンプレート フィールドは、アスペクト タイプの metadata_template フィールドの内容に対応しています。変更された metadata_template を含む UpdateAspectType を使用して、フィールドを作成、更新、名前変更、削除します。

Data Catalog API メソッド Dataplex API メソッド
projects.locations.tagTemplates.fields.create(REST)
CreateTagTemplateField(RPC)
projects.locations.aspectTypes.patch(REST)
UpdateAspectType(RPC)
projects.locations.tagTemplates.fields.patch(REST)
UpdateTagTemplateField(RPC)
projects.locations.aspectTypes.patch(REST)
UpdateAspectType(RPC)
projects.locations.tagTemplates.fields.rename(REST)
RenameTagTemplateField(RPC)
projects.locations.aspectTypes.patch(REST)
UpdateAspectType(RPC)
projects.locations.tagTemplates.fields.delete(REST)
DeleteTagTemplateField(RPC)
projects.locations.aspectTypes.patch(REST)
UpdateAspectType(RPC)

タグ テンプレートのフィールドの列挙値

対応するアスペクト タイプの metadata_template フィールドを更新して、列挙値を変更します。

Data Catalog API メソッド Dataplex API メソッド
projects.locations.tagTemplates.fields.enumValues.rename(REST)
RenameTagTemplateFieldEnumValue(RPC)
projects.locations.aspectTypes.patch(REST)
UpdateAspectType(RPC)

タグとアスペクト

アスペクトは、Data Catalog タグの後継です。アスペクトは親エントリまたはエントリリンクに直接カプセル化され、update_mask を使用した UpdateEntry メソッドで管理されます。

Data Catalog API メソッド Dataplex API メソッド
projects.locations.entryGroups.entries.tags.create(REST)
CreateTag(RPC)
projects.locations.entryGroups.entries.patch(REST)
UpdateEntry(RPC)
projects.locations.entryGroups.entries.tags.list(REST)
ListTags(RPC)
projects.locations.entryGroups.entries.get(REST)
GetEntry(RPC)

注: レスポンスでアスペクトをフィルタするには、viewsaspect_typespaths パラメータを使用します。

projects.locations.entryGroups.entries.tags.patch(REST)
UpdateTag(RPC)
projects.locations.entryGroups.entries.patch(REST)
UpdateEntry(RPC)
projects.locations.entryGroups.entries.tags.delete(REST)
DeleteTag(RPC)
projects.locations.entryGroups.entries.patch(REST)
UpdateEntry(RPC)

ポリシータグと分類

ポリシータグと分類階層の API は変更されないため、移行は必要ありません。引き続き datacatalog.googleapis.com エンドポイント(ポリシー タグ マネージャー サービス)で配信されます。BigQuery の列レベルのアクセス制御または動的データ マスキングを使用するプロジェクトでは、Data Catalog API(datacatalog.googleapis.com)を有効にしておく必要があります。

Knowledge Catalog で対象外の機能

次の Data Catalog の動作と機能は、Knowledge Catalog ではサポートされていないか、動作が異なります。

  • 非公開アスペクト タイプ: 非公開アスペクトと非公開アスペクト タイプ(Data Catalog の非公開タグと非公開タグ テンプレートの類似物)のコンセプトはありません。すべてのカスタム アスペクト タイプは、プロジェクトとエントリ グループの Identity and Access Management 権限に則って管理されます。
  • ポリシータグの検索: カタログ検索では、policytag または policytagid 述語を使用したポリシータグの検索はサポートされていません。
  • 権限の転送: Data Catalog のカスタム エントリ グループ、カスタム エントリ、タグ テンプレート、タグを Knowledge Catalog にインポートしても、元の権限は引き継がれません。インポートされたリソースの IAM 権限を構成する必要があります。以前の権限と置き換え後の権限の詳細な比較については、Data Catalog と Knowledge Catalog 間の IAM 権限をマッピングするをご覧ください。
  • Sensitive Data Protection の検査結果: Sensitive Data Protection の検査結果を Knowledge Catalog に直接送信することはできません。代わりに、検査結果を Data Catalog に送信し、結果を Knowledge Catalog に移行します。
  • プロジェクト間のタイプの一覧表示: 1 回の API 呼び出しでプロジェクト全体のエントリタイプ、エントリ リンクタイプ、アスペクト タイプを一覧表示することはできません。リクエストは単一のプロジェクトにスコープ設定する必要があります。
  • 管理者検索: 管理者検索(完全な再現率)はサポートされていません。代わりに、メタデータを Cloud Storage にエクスポートし、BigQuery を使用してクエリします。

次のステップ

ガイド

タグ テンプレート、カスタム エントリ、ワークフローを移行する手順ガイド。

コンセプト

Knowledge Catalog の柔軟なメタモデルとアクティブ コンテキスト グラフについて学習します。

リファレンス

Dataplex Catalog サービスの REST API リファレンス ドキュメントを参照します。

リファレンス

Dataplex Catalog サービスの gRPC API リファレンス ドキュメントを参照します。