エントリを管理してカスタムソースを取り込む

このドキュメントでは、エントリタイプ、エントリ グループ、カスタム エントリを作成して管理し、カスタム データソースと Dataplex の統合を有効にする方法について説明します。

エントリは、メタデータをキャプチャするリソースを表します。エントリ グループは、1 つ以上のエントリのコンテナであり、アクセス制御とリージョン ロケーションの管理に使用します。エントリタイプは、エントリに必要なメタデータを定義します。エントリタイプを使用すると、自由形式で緩く定義されたエントリ リソースに構造とルールを適用し、エントリを拡張できます。

カスタム データソースを Dataplex に統合するには、カスタム エントリ グループにあるカスタム エントリタイプを使用してカスタム エントリを作成します。カスタム エントリを作成する手順の概要は、次のとおりです。

1. エントリ グループを作成する
2. エントリタイプを作成します。
3. エントリ グループ内にエントリタイプのカスタム エントリを作成します。

エントリ

エントリは、メタデータをキャプチャするデータアセットを表します。すべてのエントリはエントリタイプのインスタンスです。エントリのアスペクトに対する各オペレーションは、エントリタイプの必須アスペクトに準拠する必要があります。たとえば、エントリを作成するときに、エントリタイプで定義されたすべてのアスペクト タイプの値を指定する必要があります。エントリタイプで required としてマークされているエントリのアスペクトは削除できません。

エントリのカテゴリ

• システム エントリ: Dataplex は、 Google Cloudリソース（BigQuery データセットやテーブルなど）のエントリを作成します。Dataplex が作成するエントリはシステム エントリと呼ばれます。Dataplex は、サポートされている Google Cloud システムからの継続的なメタデータ同期により、システム エントリを自動的に最新の状態に保ちます。

  システム エントリに自動的に入力されるメタデータ（必須アスペクト）は変更できません。システム エントリの追加メタデータを追加または変更できるのは、オプションのアスペクトを使用する場合のみです。詳細については、アスペクトのカテゴリをご覧ください。

• カスタム エントリ: カスタム リソース用に作成して管理できるエントリをカスタム エントリと呼びます。カスタム リソースは、 Google Cloud または外部（オンプレミスなど）でホストされている Google 以外のサービスのリソースです。

エントリ グループ

エントリ グループは、1 つ以上のエントリのコンテナです。エントリ グループを使用すると、エントリのアクセス制御とリージョン ロケーションを管理できます。すべてのエントリ グループはプロジェクトに属します。

エントリ グループのカテゴリ

• システム エントリ グループ: Google Cloud リソースの場合、Dataplex は、リソースが存在するすべてのプロジェクトとロケーションの各システムにエントリ グループを自動的に作成します。たとえば、@bigquery は BigQuery のシステム エントリ グループです。

• カスタム エントリ グループ: カスタム リソース用に作成するエントリ グループ。

エントリタイプ

エントリタイプは、必須のアスペクト タイプのセットを使用して、このタイプのエントリに必要なメタデータを定義します。

必須のアスペクト タイプはエントリにのみ指定できます。エントリの列には指定できません。特定のエントリタイプのエントリを作成する場合は、エントリタイプで指定されている必須のアスペクト タイプの値をすべて指定する必要があります。

エントリタイプ内で参照される必須アスペクト タイプは、エントリタイプと同じプロジェクトに属している必要があります。

エントリタイプのカテゴリ

• カスタム エントリタイプ: 作成して管理するエントリタイプ。これらのエントリタイプを使用して、カスタム エントリを作成できます。

• システム エントリタイプ: Dataplex はデフォルトでこれらのエントリタイプを提供します。システム エントリタイプは、再利用可能と制限付きにさらに分類されます。

  次の表では、システム エントリタイプのカテゴリと、各カテゴリに Dataplex が提供するエントリタイプのリストを示します。

  システム エントリタイプのカテゴリ	説明	Dataplex が提供するエントリタイプ
  再利用可能なシステム エントリタイプ	このエントリタイプを使用して、カスタム エントリを作成できます。	generic
  制限付きシステム エントリのタイプ	これらは、Google Cloud リソースのエントリの作成など、システム用に予約されています。 これらのエントリタイプを使用してエントリを作成することはできませんが、これらのエントリタイプのエントリを編集して、オプションのアスペクトを追加することはできます。	bigquery-connection bigquery-dataset bigquery-model bigquery-routine bigquery-table bigquery-view cloudsql-database cloudsql-instance cloudsql-schema cloudsql-table cloudsql-view dataform-repository dataform-code-asset sql-access storage storage-bucket storage-folder

注: entrygroup タイプのエントリはエントリ グループを表し、エントリ グループが作成されると自動的に作成されます。このタイプのエントリを検索できます。通常のエントリとは異なり、これらのエントリは削除できません。代わりに、エントリ グループを削除する必要があります。

カスタム エントリ タイプは、特定のリージョン ロケーションで、またはグローバル リソースとして作成できます。システム エントリタイプは常にグローバルです。エントリ タイプのロケーションは、適用範囲に影響します。詳細については、プロジェクトとロケーションの制約をご覧ください。

始める前に

エントリを管理してカスタム データソースを取り込む前に、このセクションで説明するタスクを完了していることを確認してください。

必要なロール

エントリの作成と管理に必要な権限を取得するには、リソースに対する次の IAM ロールの付与を管理者に依頼してください。

• エントリ、エントリ グループ、エントリタイプに対する完全な権限セット: Dataplex Catalog 管理者（roles/dataplex.catalogAdmin）
• エントリ、エントリ グループ、エントリタイプなど、すべての Dataplex Catalog リソースを作成、管理する: Dataplex Catalog 編集者（roles/dataplex.catalogEditor）
• エントリ関連のオペレーションに対する完全アクセス権: Dataplex エントリ オーナー（roles/dataplex.entryOwner）
• エントリ、エントリ グループ、エントリタイプ、およびそれらに関連付けられた IAM ポリシーを表示する: Dataplex Catalog 閲覧者（roles/dataplex.catalogViewer）
• カスタム エントリを作成するときに、アスペクト タイプを使用して、そのタイプのアスペクトを作成する: Dataplex アスペクト タイプ ユーザー（roles/dataplex.aspectTypeUser）
• エントリ グループを作成、管理する: Dataplex エントリ グループ オーナー（roles/dataplex.entryGroupOwner）
• エントリタイプを作成、管理する: Dataplex エントリタイプ オーナー（roles/dataplex.entryTypeOwner）
• エントリタイプを使用して、そのタイプのエントリを作成および変更する: Dataplex エントリタイプ ユーザー（roles/dataplex.entryTypeUser）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

注: エントリタイプを使用してそのタイプのエントリを作成および変更する場合、エントリタイプとエントリが異なるプロジェクトにある場合は、エントリタイプが存在するプロジェクトに対する Dataplex エントリタイプ ユーザー（roles/dataplex.entryTypeUser）の IAM ロールを付与する必要があります。

詳細については、Dataplex IAM ロールをご覧ください。

API を有効にする

Dataplex プロジェクトで Dataplex API を有効にします。

API の有効化

エントリ グループを作成する

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリ グループ] > [カスタム] タブをクリックします。

3. [エントリ グループを作成する（Dataplex Catalog）] をクリックします。

4. [エントリ グループを作成] ウィンドウで、次のように入力します。

   1. 省略可: [表示名] フィールドに、エントリ グループの表示名を入力します。
   2. エントリ グループ ID: エントリ グループの一意の ID を入力します。
   3. 省略可: [説明] フィールドに、エントリ グループの説明を入力します。
   4. ロケーション: ロケーションを選択します。エントリ グループの作成後にロケーションを変更することはできません。

5. 省略可: [ラベル] セクションで、任意のラベルを Key-Value ペアとしてリソースに追加します。

   1. [ラベルを追加] をクリックします。
   2. [キー] フィールドにキーを入力します。
   3. [値] フィールドにキーの値を入力します。
   4. ラベルをさらに追加するには、[ラベルを追加] をクリックして手順を繰り返します。

6. [保存] をクリックします。

エントリ グループを作成するには、gcloud dataplex entry-groups create コマンドを使用します。

エントリ グループを作成するには、entryGroups.Create メソッドを使用します。

エントリタイプを作成する

新しいソースを取り込むには、エントリタイプを作成する必要があります。

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリタイプ] > [カスタム] タブをクリックします。

3. [作成] をクリックします。

4. [エントリタイプを作成] ウィンドウで、次のように入力します。

   1. 省略可: [表示名] フィールドに、エントリタイプの表示名を入力します。
   2. エントリタイプ ID: エントリタイプの一意の ID を入力します。エントリタイプを作成した後にこの値を変更することはできません。
   3. 省略可: [説明] フィールドに、エントリタイプの説明を入力します。
   4. 省略可: [システム] フィールドに移行元のシステムを入力します。
   5. 省略可: [プラットフォーム] フィールドに、このタイプのエントリが属するプラットフォームを入力します。例: Google Cloud
   6. [ロケーション] フィールドで、ロケーションを選択します。エントリタイプを作成した後にロケーションを変更することはできません。

5. 省略可: [型エイリアス] セクションで、エントリタイプのデータ型を定義します。このデータ型は、エントリのクエリに使用できます。

   1. [型エイリアスを追加] をクリックします。
   2. [型エイリアス] フィールドでデータ型を選択します。型エイリアスは複数追加できます。

6. [必須のアスペクト タイプ] セクションで、このエントリタイプに必須のアスペクト タイプを選択します。このタイプに基づいて作成された各エントリには、これらの必須のアスペクト タイプが割り当てられます。

   1. [アスペクト タイプを選択] をクリックします。
   2. [アスペクト タイプを選択] ウィンドウで、アスペクトのタイプを選択します。
   3. [選択] をクリックします。

   エントリから必須のアスペクトを削除することはできません。

7. 省略可: [ラベル] セクションで、任意のラベルを Key-Value ペアとしてリソースに追加します。

   1. [ラベルを追加] をクリックします。
   2. [キー] フィールドにキーを入力します。
   3. [値] フィールドにキーの値を入力します。
   4. ラベルをさらに追加するには、[ラベルを追加] をクリックして手順を繰り返します。

8. [保存] をクリックします。

エントリタイプを作成するには、gcloud dataplex entry-types create コマンドを使用します。

エントリタイプを作成するには、entryTypes.create メソッドを使用します。

カスタム エントリを作成する

カスタム エントリを作成する前に、エントリ グループとエントリタイプを作成していることを確認します。

コンソールgcloudREST

Google Cloud コンソールを使用してカスタム エントリを作成することはできません。代わりに、Google Cloud CLI または API を使用してください。

カスタム エントリを作成するには、gcloud dataplex entries create コマンドを使用します。

カスタム エントリを作成するには、entries.create メソッドを使用します。

カスタム エントリを作成したら、エントリにアスペクトを追加できます。詳細については、エントリにアスペクトを追加するをご覧ください。

エントリ グループを管理する

このセクションでは、使用可能なエントリ グループのリストを表示する方法、エントリ グループの詳細を表示、更新、削除する方法について説明します。

使用可能なエントリ グループのリストを表示する

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリ グループ] タブをクリックします。

   このページには、使用可能なすべての Dataplex Catalog エントリ グループと Data Catalog エントリ グループが一覧表示されます。

3. カスタム エントリ グループを表示するには、[カスタム] タブをクリックします。[カスタム] タブの [カタログソース] 列に、リソースが存在する場所（Dataplex Catalog または Data Catalog）が表示されます。

   システム エントリ グループを表示するには、[システム] タブをクリックします。

   カスタム エントリ グループとシステム エントリ グループの詳細については、このドキュメントのエントリ グループのカテゴリをご覧ください。

4. 省略可: 選択したプロジェクトのエントリ グループのリストを表示するには、[カスタム] タブをクリックし、[すべてのプロジェクトから表示] をオフに切り替えます。

   [すべてのプロジェクトから表示] 切り替えボタンはデフォルトでオンになっています。リストには、選択した組織の Dataplex Catalog リソースと、アクセスできるすべての組織の Data Catalog リソースが含まれます。

   注: [すべてのプロジェクトの表示] 切り替えボタンがオンになっている場合、エントリグループを直接編集または削除することはできません。代わりに、エントリ グループをクリックしてエントリ グループの詳細ページを開き、編集または削除する必要があります。

使用可能なエントリ グループのリストを表示するには、gcloud dataplex entry-groups list コマンドを使用します。

使用可能なエントリ グループのリストを表示するには、entryGroups.list メソッドを使用します。

エントリ グループの詳細を表示する

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリ グループ] タブをクリックします。

3. 詳細を表示するエントリ グループをクリックします。

   [エントリ グループの詳細] ページが開きます。選択したエントリ グループの表示名、エントリ グループ ID、説明、プロジェクト ID、ロケーション、ラベル、作成日、最終更新日などの情報にアクセスできます。

   Data Catalog エントリ グループの詳細は、Data Catalog ウェブ インターフェースと Dataplex Catalog ウェブ インターフェースの両方で確認できます。これを行うには、エントリ グループの詳細ページで [Data Catalog] または [Dataplex Catalog] をクリックします。

   [サンプル エントリ] セクションには、選択したエントリ グループで最近作成された関連エントリが 10 個表示されます。

4. 省略可: エントリグループに関連するすべてのエントリを表示するには、[サンプル エントリ] セクションで [検索結果の関連エントリをすべて表示] をクリックします。

エントリ グループの詳細を取得するには、gcloud dataplex entry-groups describe コマンドを使用します。

エントリ グループの詳細を取得するには、entryGroups.get メソッドを使用します。

エントリ グループを更新する

カスタム エントリ グループを更新できます。システム エントリ グループは変更できません。

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリ グループ] > [カスタム] タブをクリックします。

3. 更新するエントリ グループをクリックします。

4. [エントリ グループの詳細] ページで、[編集] をクリックします。

5. 必要に応じて、表示名、説明、ラベルを編集します。

6. [保存] をクリックします。

エントリ グループを更新するには、gcloud dataplex entry-groups update コマンドを使用します。

エントリ グループを更新するには、entryGroups.patch メソッドを使用します。

エントリ グループを削除する

カスタム エントリ グループは削除できます。システム エントリ グループは削除できません。

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリ グループ] > [カスタム] タブをクリックします。

3. 削除するエントリ グループをクリックします。

4. [エントリ グループの詳細] ページで、[削除] をクリックします。表示されるメッセージを確認します。

エントリ グループを削除するには、gcloud dataplex entry-groups delete コマンドを使用します。

エントリ グループを削除するには、entryGroups.delete メソッドを使用します。

エントリタイプを管理する

このセクションでは、使用可能なエントリ グループのリストを表示する方法、エントリタイプの詳細を表示、更新、削除する方法について説明します。

使用可能なエントリタイプのリストを表示する

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリタイプ] タブをクリックします。

3. カスタム エントリタイプを表示するには、[カスタム] タブをクリックします。システム エントリタイプを表示するには、[システム] タブをクリックします。カスタム エントリタイプとシステム エントリタイプの詳細については、このドキュメントのエントリタイプのカテゴリをご覧ください。

4. 省略可: 選択したプロジェクトのエントリタイプのリストを表示するには、[カスタム] タブをクリックし、[すべてのプロジェクトから表示] をオフに切り替えます。

   [すべてのプロジェクトの表示] 切り替えボタンはデフォルトでオンになっています。リストには、すべてのプロジェクトのエントリタイプが含まれます。

   注: [すべてのプロジェクトの表示] 切り替えボタンがオンになっている場合、エントリタイプを直接編集または削除することはできません。代わりに、エントリタイプをクリックしてエントリタイプの詳細ページを開き、編集または削除する必要があります。

使用可能なエントリタイプのリストを表示するには、gcloud dataplex entry-types list コマンドを使用します。

使用可能なエントリタイプのリストを表示するには、entryTypes.list メソッドを使用します。

エントリタイプの詳細を表示する

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリタイプ] > [カスタム] タブをクリックします。

3. 詳細を表示するエントリタイプをクリックします。

   エントリタイプの詳細ページが開きます。選択したエントリタイプの表示名、エントリタイプ ID、説明、プロジェクト ID、ロケーション、プラットフォーム、システム、タイプ エイリアス、ラベル、作成日、最終更新日などの情報にアクセスできます。

4. 省略可: 最近作成された関連エントリのリスト（10 件）を表示するには、[サンプル エントリ] タブをクリックします。

5. 省略可: エントリグループに関連するすべてのエントリを表示するには、[サンプル エントリ] タブをクリックし、[検索結果の関連エントリをすべて表示] をクリックします。

エントリタイプの詳細を取得するには、gcloud dataplex entry-types describe コマンドを使用します。

エントリタイプの詳細を取得するには、entryTypes.get メソッドを使用します。

エントリタイプを更新する

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリタイプ] > [カスタム] タブをクリックします。

3. 更新するエントリタイプをクリックします。

4. [エントリタイプの詳細] ページで、[編集] をクリックします。

5. 必要に応じて、表示名、説明、システム、プラットフォーム、型エイリアス、ラベルを編集します。

6. [保存] をクリックします。

エントリタイプを更新するには、gcloud dataplex entry-types update コマンドを使用します。

エントリタイプを更新するには、entryTypes.patch メソッドを使用します。

エントリタイプを削除する

コンソールgcloudREST

1. Google Cloud コンソールで、Dataplex の [カタログ] ページに移動します。

   [カタログ] に移動

2. [エントリタイプ] > [カスタム] タブをクリックします。

3. 削除するエントリタイプをクリックします。

4. [エントリタイプの詳細] ページで、[削除] をクリックします。表示されるメッセージを確認します。

エントリタイプを削除するには、gcloud dataplex entry-types delete コマンドを使用します。

エントリタイプを削除するには、entryTypes.delete メソッドを使用します。

次のステップ

• Dataplex Catalog でデータアセットを検索する方法を確認する。
• アスペクトを管理してメタデータを拡充する方法を確認する。
• Dataplex にメタデータをインポートする方法を確認する。
• Dataplex Catalog の詳細を確認する。