Knowledge Catalog を使用して Cloud SQL リソースを管理する

このページでは、Knowledge Catalog を使用して Cloud SQL リソースを検索して管理する方法について説明します。

Knowledge Catalog は、メタデータを保存、管理し、それにアクセスするためのプラットフォームです。Knowledge Catalog は、Cloud SQL インスタンス、データベース、テーブル、列、ビューから次のメタデータを自動的に取得します。

  • 名前
  • ロケーション（リージョン）
  • 作成日と最終更新日
  • スキーマ（テーブルとビュー用）
  • 説明
  • 主キー制約と外部キー制約

Knowledge Catalog は、Cloud SQL プライマリ インスタンスからのみメタデータを取得し、リードレプリカや外部サーバー レプリカからは取得しません。

Knowledge Catalog を使用すると、Cloud SQL メタデータを検出して把握できます。Knowledge Catalog は、次の作業に役立ちます。

  • データの検出
  • 分類
  • 分析（依存関係やユースケースへの適合性など）
  • チェンジ マネジメント
  • データの移動（パイプライン）
  • スキーマ進化

Knowledge Catalog では、Cloud SQL メタデータ エントリにアスペクトを適用してメタデータをキュレートします。各アスペクトには複数のメタデータ フィールドを含めることができ、事前定義済みのアスペクト タイプまたはカスタム アスペクト タイプに基づいて作成できます。

たとえば、個人を特定できる情報（PII）である社会保障番号を含む列に、次のアスペクトを適用できます。

  pii:true
  pii_type:SSN

Knowledge Catalog の詳細については、Knowledge Catalog のメタデータ管理についてをご覧ください。

Knowledge Catalog 統合のデータの更新速度

Knowledge Catalog のインスタンス メタデータの想定される更新頻度は、インスタンスの作成日、データベース バージョン、ネットワーク アーキテクチャによって異なります。

準リアルタイム

インスタンスが次の条件をすべて満たしている場合、インスタンスの作成時に Knowledge Catalog との統合がデフォルトで有効になります。

  1. 作成日時: 2026 年 4 月 18 日以降

  2. バージョン: Cloud SQL for PostgreSQL バージョン 14.0 以降
  3. ネットワーク アーキテクチャ: 新しいネットワーク アーキテクチャ

2026 年 4 月 18 日より前に作成された既存のインスタンスで、バージョンと新しいネットワーク アーキテクチャの条件を満たしている場合は、既存の Cloud SQL インスタンスで Knowledge Catalog の統合を有効にするを使用して Knowledge Catalog の統合を有効にすると、準リアルタイムで統合が有効になります。このようなインスタンスで Knowledge Catalog の統合が 1 日 1 回有効になっている場合は、統合を無効にしてから再度有効にすると、1 日 1 回から準リアルタイムに移行できます。

インスタンスが準リアルタイム統合の条件を満たしていない場合は、1 日 1 回をご覧ください。

準リアルタイムで統合されたインスタンスには、アセットの作成時間と更新時間を追跡するためのタイムスタンプ テーブルが含まれています。タイムスタンプ テーブルは cloudsqladmin データベースにあります。インスタンスに DDL またはスキーマの変更があると、統合はタイムスタンプ テーブルをクエリして最近変更されたアセットを特定し、最新のスキーマ更新を準リアルタイムで Knowledge Catalog に読み込みます。まれに、ネットワークが不安定な場合などに、Knowledge Catalog で更新が欠落することがあります。これはまれですが、見逃された変更は最終的に整合性が取れます（通常は 24 時間以内）。変更が反映されないシナリオについて詳しくは、このページの制限事項をご覧ください。

インスタンスで実行されたクエリを表示すると、Knowledge Catalog の統合をサポートするクエリが表示されます。これらのクエリは、含まれている --Dataplex コメントで識別できます。インスタンスのクエリを表示するには、アクティブなクエリを表示するをご覧ください。

統合を無効にして、後でインスタンスを更新するの手順に沿って再度有効にできます。

1 日 1 回

Knowledge Catalog との統合は、次のいずれかの条件を満たすインスタンスで有効にできます。

  1. 作成日時: 2026 年 4 月 18 日より前
  2. バージョン: 14.0 より前の Cloud SQL for PostgreSQL バージョン
  3. ネットワーク アーキテクチャ: 以前のネットワーク アーキテクチャ

Knowledge Catalog との統合を有効にすると、通常、これらの条件のいずれかを満たすインスタンスのメタデータは、Knowledge Catalog で 1 日に 1 回程度更新されます。

インスタンスが 2026 年 4 月 18 日以降に作成された場合、Knowledge Catalog との統合はデフォルトで有効になっています。2026 年 4 月 18 日より前に作成されたインスタンスの場合は、既存の Cloud SQL インスタンスで Knowledge Catalog の統合を有効にする ことができます。

2026 年 4 月 18 日より前に作成された既存のインスタンスが、準リアルタイムのバージョンと新しいネットワーク アーキテクチャの条件を満たしている場合、Knowledge Catalog の統合を有効にする（または、すでに 1 日 1 回統合されている場合は、統合を無効にしてから再度有効にする）と、インスタンスは準リアルタイムの更新用に構成されます。

統合を無効にして、後でインスタンスを更新するの手順に沿って再度有効にできます。

始める前に

  1. Google Cloud アカウントにログインします。 Google Cloudを初めて使用する場合は、 アカウントを作成して、実際のシナリオで Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分も差し上げます。

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  5. Verify that billing is enabled for your Google Cloud project.

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

    Dataplex API を有効にする

  7. 権限を確認してください。

    エントリを検索して Cloud SQL アセットに適用するには、特定の Identity and Access Management（IAM）ロールと権限が必要です。詳細については、Knowledge Catalog に必要な IAM ロールと権限をご覧ください。

Knowledge Catalog に必要な IAM のロールと権限

Cloud SQL は、cloudsql.schemas.view 権限を使用して Knowledge Catalog のメタデータへのアクセスを提供します。

この権限を付与するには、この権限を含むカスタムロールを作成するか、この権限を持つ事前定義ロールのいずれかを使用します。

詳細については、Cloud SQL IAM 事前定義ロールをご覧ください。

Knowledge Catalog の統合を有効にしてインスタンスを作成する

新しいインスタンスは、デフォルトで Knowledge Catalog と統合されています。Knowledge Catalog の統合を有効にして新しいインスタンスを作成するには、新しいインスタンスを作成するだけです。Knowledge Catalog が準リアルタイムで統合されたインスタンスを作成するには、新しいインスタンスが次の条件をすべて満たしている必要があります。

  1. 作成日時: 2026 年 4 月 18 日以降

  2. バージョン: Cloud SQL for PostgreSQL バージョン 14.0 以降
  3. ネットワーク アーキテクチャ: 新しいネットワーク アーキテクチャ

以前のデータベース バージョンまたは古いネットワーク アーキテクチャを使用する新しいインスタンスで準リアルタイムの Knowledge Catalog を有効にする場合は、インスタンスのクローンを作成するか、バックアップから新しいインスタンスに復元します。

gcloud

インスタンスを作成する

Cloud SQL インスタンスを作成するには、gcloud sql instances create コマンドを使用します。

gcloud sql instances create INSTANCE_NAME \
  --database-version=DATABASE_VERSION \
  --tier=MACHINE_TYPE \
  --region=REGION_NAME

次の項目を変更します。

  • INSTANCE_NAME: インスタンスの名前
  • DATABASE_VERSION: インスタンスのデータベース バージョン（例: POSTGRES_14）。使用可能な文字列の一覧については、SqlDatabaseVersion をご覧ください。
  • MACHINE_TYPE: インスタンスのマシンタイプ
  • REGION_NAME: インスタンスのリージョン名

この例は Linux ベースです。

REST v1

インスタンスを作成する

統合を有効にしてインスタンスを作成するには、次の例を使用します。この呼び出しで使用できるパラメータの完全なリストについては、instances.insert ページをご覧ください。

リクエストのデータを使用する前に、次のように置き換えます。

  • PROJECT_ID: インスタンスが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号
  • INSTANCE_NAME: インスタンスの名前
  • REGION_NAME: インスタンスのリージョン名
  • DATABASE_VERSION: データベース バージョンの列挙型文字列（例: POSTGRES_13）。使用可能な文字列の一覧については、SqlDatabaseVersion をご覧ください。
  • PASSWORD: root ユーザーのパスワード
  • MACHINE_TYPE: マシン（階層）タイプの列挙型文字列（例: db-custom-[CPUS]-[MEMORY_MBS]）
  • EDITION_TYPE: Cloud SQL のエディション

HTTP メソッドと URL:

POST https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances

リクエストの本文（JSON）: 

{
  "name": "INSTANCE_NAME",
  "region": "REGION_NAME",
  "databaseVersion": "DATABASE_VERSION",
  "rootPassword": "PASSWORD",
  "settings": {
    "tier": "MACHINE_TYPE",
    "edition": "EDITION_TYPE",
    "enableDataplexIntegration": true
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

インスタンスを作成する

統合を有効にしてインスタンスを作成するには、次の例を使用します。この呼び出しで使用できるパラメータの完全なリストについては、instances.insert ページをご覧ください。

リクエストのデータを使用する前に、次のように置き換えます。

  • PROJECT_ID: インスタンスが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号
  • INSTANCE_NAME: インスタンスの名前
  • REGION_NAME: インスタンスのリージョン名
  • DATABASE_VERSION: データベース バージョンの列挙型文字列（例: POSTGRES_13）。使用可能な文字列の一覧については、SqlDatabaseVersion をご覧ください。
  • PASSWORD: root ユーザーのパスワード
  • MACHINE_TYPE: マシン（階層）タイプの列挙型文字列（例: db-custom-[CPUS]-[MEMORY_MBS]）
  • EDITION_TYPE: Cloud SQL のエディション

HTTP メソッドと URL:

POST https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances

リクエストの本文（JSON）: 

{
  "name": "INSTANCE_NAME",
  "region": "REGION_NAME",
  "databaseVersion": "DATABASE_VERSION",
  "rootPassword": "PASSWORD",
  "settings": {
    "tier": "MACHINE_TYPE",
    "edition": "EDITION_TYPE",
    "enableDataplexIntegration": true
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-09-25T22:19:33.735Z",
  "operationType": "CREATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_ID",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

既存の Cloud SQL インスタンスで Knowledge Catalog の統合を有効にする

このセクションの更新手順に沿って、2026 年 4 月 18 日より前に作成された既存のインスタンスで Knowledge Catalog の統合を有効にできます。

既存のインスタンスで Knowledge Catalog の統合を有効にすると、次のようになります。

  • 次の条件のいずれかを満たすインスタンスで Knowledge Catalog の統合を有効にすると、1 日 1 回更新が有効になります。

  • 次の条件をすべて満たすインスタンスでは、Knowledge Catalog の統合を有効にすると、準リアルタイム更新が有効になります。

    準リアルタイムで統合を有効にすると、新しい DDL とスキーマの変更は 10 分以内に表示され、インスタンス上の既存のリソースは 24 時間以内に移入されます。

既存の Cloud SQL インスタンスで Knowledge Catalog の統合を有効または再度有効にするには、次のいずれかの方法を使用します。

gcloud

インスタンスを更新する

既存のインスタンスで統合を有効にするには、gcloud sql instances patch コマンドを使用します。

gcloud sql instances patch INSTANCE_NAME \
  --enable-dataplex-integration

プロジェクト内のすべての Cloud SQL インスタンスを有効にして更新する必要がある場合は、次のようなスクリプトを実行します。

gcloud sql instances list --format="(NAME)" \
| tail -n +2 | xargs -t -I %
gcloud sql instances patch % --enable-dataplex-integration

この例は Linux ベースです。

REST v1

インスタンスを更新する

既存のインスタンスを更新するには、この例を使用します。この呼び出しで使用できるパラメータの一覧については、instances.patch ページをご覧ください。

リクエストのデータを使用する前に、次のように置き換えます。

  • PROJECT_ID: インスタンスが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号
  • INSTANCE_NAME: インスタンスの名前

HTTP メソッドと URL:

PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME

リクエストの本文（JSON）: 

{
  "settings":
  {
    "enableDataplexIntegration": true
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

インスタンスを更新する

既存のインスタンスを更新するには、この例を使用します。この呼び出しで使用できるパラメータの一覧については、instances.patch ページをご覧ください。

既存のインスタンスを更新するには、この例を使用します。この呼び出しで使用できるパラメータの一覧については、instances.patch ページをご覧ください。

リクエストのデータを使用する前に、次のように置き換えます。

  • PROJECT_ID: インスタンスが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号
  • INSTANCE_NAME: インスタンスの名前

HTTP メソッドと URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

リクエストの本文（JSON）: 

{
  "settings":
  {
    "enableDataplexIntegration": true
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Cloud SQL インスタンスで Knowledge Catalog の統合を確認する

インスタンスで Knowledge Catalog の統合が有効になっていることを確認するには、次のいずれかの方法を使用します。

gcloud

既存のインスタンスで Knowledge Catalog の統合が有効になっていることを確認するには、gcloud sql instances describe コマンドを使用します。

gcloud sql instances describe INSTANCE_NAME

INSTANCE_NAME は、インスタンス名で置き換えます。出力で、enableDataplexIntegration が true に設定されている構成設定を探します。

REST v1

リクエストのデータを使用する前に、次のように置き換えます。

  • PROJECT_ID: プロジェクト ID
  • INSTANCE_ID: インスタンス ID

HTTP メソッドと URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{
"settings":
  {
  "enableDataplexIntegration": true
  }
}

REST v1beta4

リクエストのデータを使用する前に、次のように置き換えます。

  • PROJECT_ID: プロジェクト ID
  • INSTANCE_ID: インスタンス ID

HTTP メソッドと URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{
"settings":
  {
  "enableDataplexIntegration": true
  }
}

Cloud SQL インスタンスで Knowledge Catalog の統合を無効にする

Cloud SQL インスタンスで Knowledge Catalog の統合を無効にするには、次のいずれかの方法を使用します。準リアルタイムで統合されているインスタンスで Knowledge Catalog の統合を無効にするには、最大 10 分かかります。

コンソール

  1. Google Cloud コンソールで、Cloud SQL の [インスタンス] ページに移動します。

    Cloud SQL の [インスタンス] に移動

  2. インスタンスの [概要] ページを開くには、インスタンス名をクリックします。
  3. [編集] をクリックします。
  4. [インスタンスのカスタマイズ] セクションで、[構成オプションを表示] メニューを開きます。

  5. [フラグとパラメータ] セクションで、[Knowledge Catalog の統合を有効にする] チェックボックスをオフにします。

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

gcloud

既存のインスタンスの統合を無効にするには、gcloud sql instances patch コマンドを使用します。

gcloud sql instances patch INSTANCE_NAME \
  --no-enable-dataplex-integration

統合を無効にしてプロジェクト内のすべての Cloud SQL インスタンスを更新する必要がある場合は、次のようなスクリプトを実行します。

gcloud sql instances list --format="(NAME)" \
| tail -n +2 | xargs -t -I %
gcloud sql instances patch % --no-enable-dataplex-integration

この例は Linux ベースです。

REST v1

この例を使用して、統合を無効にします。

リクエストのデータを使用する前に、次のように置き換えます。

  • PROJECT_ID: インスタンスが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号
  • INSTANCE_NAME: インスタンスの名前

HTTP メソッドと URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

リクエストの本文（JSON）: 

{
  "settings":
  {
    "enableDataplexIntegration": false
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

この例を使用して、統合を無効にします。

リクエストのデータを使用する前に、次のように置き換えます。

  • PROJECT_ID: インスタンスが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号
  • INSTANCE_NAME: インスタンスの名前

HTTP メソッドと URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

リクエストの本文（JSON）: 

{
  "settings":
  {
    "enableDataplexIntegration": false
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

次のような JSON レスポンスが返されます。

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2024-01-16T02:32:12.281Z",
  "operationType": "UPDATE",
  "name": "OPERATION_ID",
  "targetId": "INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

アスペクトを使用して Cloud SQL アセットを拡張する

アスペクト タイプは、アスペクトのテンプレートとして使用できる再利用可能なリソースです。アスペクト タイプを使用すると、作業の重複や不完全なアスペクトを回避できます。Knowledge Catalog では、必要なアスペクト タイプを作成できます。

カスタム アスペクト タイプを作成したら、Cloud SQL アセットにアスペクトを適用できます。Cloud SQL アセットにアスペクトを適用すると、次のことが可能になります。

  • ビジネス メタデータをアセットに追加する。
  • ビジネス メタデータとその他のカスタム メタデータでアセットを検索する。

アスペクト タイプの作成と Cloud SQL へのアスペクトの適用の詳細については、アスペクトを管理してメタデータを拡張するをご覧ください。

Cloud SQL アセットを検索する

Google Cloud コンソールの Knowledge Catalog 検索ページを使用して、Cloud SQL アセットを検索します。

  1. Knowledge Catalog の [検索] ページに移動します。

    [検索] に移動

  2. [検索プラットフォームの選択] で、[Knowledge Catalog] を選択します。

  3. [フィルタ] パネルで [システム] をクリックし、[Cloud SQL] を選択します。

  4. 省略可。[タイプ エイリアス] では、次のいずれかのタイプ エイリアスを選択して、検索結果を特定のタイプの Cloud SQL アセットにフィルタできます。

    • データベース
    • データベース スキーマ
    • サービス
    • テーブル
    • ビュー

クエリを使用して検索を行う

Knowledge Catalog の検索フィールドを使用して検索クエリを実行することもできます。すべての Cloud SQL アセットを表示するには、system=Cloud_SQL と入力します。

次に、特定のキーワードを入力します。たとえば、すべての Cloud SQL データベースを表示するには:

system=Cloud_SQL AND type=Database

すべての Cloud SQL テーブルを表示するには、次のクエリを入力します。

system=Cloud_SQL AND type=Table

複雑な式では、かっこと、論理演算子（AND と OR）を使用することもできます。検索フィールドで使用できる式の詳細については、Knowledge Catalog の検索構文をご覧ください。

検索フィールドに、特定の Cloud SQL アセットの検索クエリを直接入力できます。クエリ文字列の形式は次のとおりです。

type="projects/dataplex-types/locations/global/entryTypes/QUERY_STRING"

QUERY_STRING は、Cloud SQL エンジンとクエリするアセットのタイプに基づくクエリ文字列に置き換えます。次の表で、適切なクエリ文字列を確認してください。

Cloud SQL エンジン クエリ文字列
Cloud SQL for MySQL
  • cloudsql-mysql-database
  • cloudsql-mysql-instance
  • cloudsql-mysql-table
  • cloudsql-mysql-view
Cloud SQL for PostgreSQL
  • cloudsql-postgresql-database
  • cloudsql-postgresql-instance
  • cloudsql-postgresql-table
  • cloudsql-postgresql-schema
  • cloudsql-postgresql-view
Cloud SQL for SQL Server
  • cloudsql-sqlserver-database
  • cloudsql-sqlserver-instance
  • cloudsql-sqlserver-table
  • cloudsql-sqlserver-schema
  • cloudsql-sqlserver-view

クエリの例を次に示します。

type="projects/dataplex-types/locations/global/entryTypes/cloudsql-postgresql-instance"

Cloud SQL アセットを Cloud SQL 言語でフィルタする

デフォルトでは、Knowledge Catalog にはすべての Cloud SQL アセットが表示されます。Cloud SQL for MySQL、Cloud SQL for PostgreSQL、または SQL Server のアセットのみをフィルタするには、次の操作を行います。

  1. [アスペクト] パネルで、[アスペクト タイプを追加] メニューをクリックします。

  2. [SQL Access] を選択します。

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

  4. playlist_add （アスペクトの編集）ボタンをクリックします。[SQL Access] ページで、次の操作を行います。

    • [言語] フィールドで [PostgreSQL] を選択し、Cloud SQL for PostgreSQL アセットをフィルタします。
  5. 省略可。[バージョン] フィールドを選択し、特定のバージョンの Cloud SQL for PostgreSQL を入力します。

  6. [適用] をクリックします。Knowledge Catalog には、Cloud SQL for PostgreSQL アセットのみが表示されます。

Knowledge Catalog には、検索に使用できる組み込みのアスペクト タイプがいくつかあります。

  1. [アスペクト] パネルで、[アスペクト タイプを追加] メニューをクリックします。

  2. 省略可。[SQL Access] を選択して、Cloud SQL の言語で結果をフィルタリングします。詳細については、前述の手順の Cloud SQL アセットを Cloud SQL 言語でフィルタするをご覧ください。

  3. 次のアスペクト タイプを 1 つ以上選択して、検索結果をそのタイプに絞り込みます。

    • Cloud SQL データベース
    • Cloud SQL インスタンス
    • Cloud SQL ビュー
    • Cloud SQL スキーマ
    • Cloud SQL テーブル

  4. [OK] をクリックします。

  5. 結果のテーブルでアセットの名前をクリックすると、そのアセットのメタデータが表示されます。

  6. 省略可: アセットを補正または表示します。ここでは、次の操作を行うことができます。

    • [概要] で [追加] をクリックして、アセットのリッチテキストによる説明を追加します。
    • [アスペクト] で [追加] をクリックして、アスペクトをアセットに適用します。
    • たとえば、インスタンスのメンバー データベースを表示するには、[エントリリスト] タブをクリックし、[検索結果の子エントリをすべて表示] をクリックします（[エントリリスト] タブが表示されない場合、インスタンスにデータベースがありません）。
    • [エンティティの詳細] で、アセットの詳細を確認します。エントリ名をクリックして、他のエントリにドリルダウンします。

ワークフローの例 - インスタンスから列にドリルダウンする

このワークフローの例では、まず Cloud SQL インスタンスを検索して、次にメンバー データベースを表示し、そのデータベース内のテーブルを表示して最後にテーブル内の列を表示します。

  1. Knowledge Catalog の [検索] ページに移動します。

    [検索] に移動

  2. [検索プラットフォームを選択] で、[Knowledge Catalog] を選択します。

  3. [フィルタ] パネルで、[システム]、[Cloud SQL] の順に選択します。または、検索フィールドに「system=Cloud_SQL」と入力します。

  4. インスタンス名を選択します。

  5. [Cloud SQL の詳細] ページで、[エントリリスト] タブをクリックし、[検索結果の子エントリをすべて表示] をクリックします。Knowledge Catalog にインスタンスのデータベースが表示されます。

  6. Cloud SQL データベースの詳細ページで、[エントリリスト] タブをクリックし、[子エントリを検索で表示する] をクリックします。Knowledge Catalog にデータベース内のテーブルが表示されます。

  7. テーブル名を選択し、Cloud SQL テーブルの詳細ページで [スキーマ] をクリックしてテーブルの列を表示します。

  8. 省略可: 列にアスペクト タイプを追加するには、[アスペクトを追加] ボタンをクリックします。

このワークフローは、インスタンスからテーブルにドリルダウンする方法を示しています。検索フィールドに「system=Cloud_SQL AND type=Table」と入力すると、テーブルのリストに直接移動できます。

料金

Knowledge Catalog への Cloud SQL テクニカル メタデータの保存は無料です。API 呼び出しと追加のビジネス メタデータの拡充には、Knowledge Catalog の標準の料金が適用されます。詳細については、Knowledge Catalog の料金ページをご覧ください。

リソースの利用

Knowledge Catalog の統合が有効になっている間、Knowledge Catalog はインスタンスから定期的にデータを抽出します。抽出プロセスには、一定の CPU 使用率が必要です。Knowledge Catalog と準リアルタイムで統合されているインスタンスは、通常、CPU 使用率への影響は最小限です。1 日に 1 回 Knowledge Catalog と統合されるインスタンスの場合、CPU 使用率が高くなることがあります。これは、マシンタイプが小さいインスタンス（共有コアと大規模なスキーマ（10,000 以上のテーブル）を持つマシンなど）で特に顕著です。このようなインスタンスは、抽出プロセス中に CPU の最大 40% を使用できます。

制限事項

このセクションでは、Cloud SQL と Knowledge Catalog の使用に関する制限事項について説明します。

  • 2026 年 4 月 18 日より前に作成されたインスタンスでは、Assured Workloads へのリソースの登録が原因でリソースへのアクセスが制限されているインスタンスでは、Knowledge Catalog と Cloud SQL の統合は無効になります。

  • 使用しているマシンサイズ、バージョン、Cloud SQL エンジンのタイプによっては、インスタンスで Knowledge Catalog を有効にしてから、Cloud SQL リソースが Knowledge Catalog にアセットとして表示されるまで 2 ～ 48 時間かかることがあります。この制限は、 準リアルタイムで説明されているように、インスタンスが準リアルタイムで更新される場合には適用されません。

次の制限事項は、準リアルタイムで説明されているように、インスタンスが準リアルタイムで更新される場合にのみ適用されます。

  • データベースの名前を変更すると、Knowledge Catalog でデータベースの更新のみが準リアルタイムで利用可能になります。データベースとそれぞれのテーブルの基盤となるマッピングは、最終的に Knowledge Catalog で結果整合性が保たれます。
  • インスタンスがメッセージをドロップすると、Knowledge Catalog のデータが結果整合性のある状態になる可能性があります。メッセージがドロップされると、最終的に Knowledge Catalog に更新漏れが表示されます。インスタンスがメッセージをドロップする可能性があるケースは次のとおりです。
    • 短期間に DDL のレートが高いインスタンス。
    • 既存のインスタンスのクローンであるインスタンス。
    • バックアップから復元されたインスタンス。
    • メモリ不足になっているインスタンス。
    • インスタンスまたはデータベースを再起動しているインスタンス。
    • ネットワークの問題が発生しているインスタンス、または Knowledge Catalog で同期プロセスが中断されているインスタンス。

次のステップ