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

Knowledge Catalog の統合は、すべての新しい AlloyDB クラスタでデフォルトで有効になっています。これにより、メタデータの保存、管理、アクセスを可能にするプラットフォームである Knowledge Catalog を使用して、AlloyDB for PostgreSQL リソースを検索して管理できます。この統合により、AlloyDB メタデータを検出して把握し、次のユースケースをサポートできます。

分析: 依存関係を把握し、さまざまなユースケースへの適合性を評価します。
変更管理: メタデータの変更を効果的に追跡して管理します。
スキーマの進化: スキーマの変更をモニタリングして計画します。

Knowledge Catalog は、AlloyDB クラスタ、インスタンス、データベース、テーブル、列、ビューから次のメタデータを自動的に取得します。

名前
ロケーション（リージョン）
ラベル（クラスタとインスタンス用）
Dataplex 統合が有効（クラスタの場合）
データベースのバージョン
マシンの CPU 数（インスタンスの場合）
可用性タイプ（インスタンスの場合）
文字セット（データベースの場合）
照合順序（データベースの場合）
オーナー
説明（テーブル、ビュー、列、外部キー用）
タイプ（クラスタ、インスタンス、マシンの場合）
列
- データ型
- モード
主キー
外部キー
- 参照テーブル
- 列のマッピング
作成時間
最終更新日時

メタデータ検出の種類

Knowledge Catalog のメタデータ検出は、AlloyDB などの接続されたデータソースをスキャンして、テーブル、ビュー、データベースなどのデータアセットを特定する自動プロセスです。次に、Knowledge Catalog は、スキーマ、説明、ロケーションなどのアセットから技術メタデータを Knowledge Catalog に抽出します。

このプロセスはメタデータを準リアルタイムで同期し、カタログとソースシステムの同期を維持します。AlloyDB の場合、クラスタとインスタンスのメタデータはデフォルトで検出されます。新しいクラスタでは、データベース、スキーマ、テーブル、ビューのメタデータの検出がデフォルトで有効になっています。このデフォルトが実装される前（2026 年 2 月 26 日）に作成されたクラスタの場合は、手動で統合を有効にします。

キーワード検索と自然言語検索

Knowledge Catalog は、キーワード検索と自然言語検索をサポートしています。

キーワード検索では、特定のキーワード、フィルタ、定義された構文を使用してリソースを検索できます。たとえば、すべての AlloyDB データベースを表示するには、「system=AlloyDB AND type=Database」と入力します。
自然言語検索（プレビュー）は、AI を使用してセマンティッククエリを理解します。普段使う言葉でリソースを検索できるため、複雑な構文を使用する必要はありません。たとえば、「List all AlloyDB tables related to sales」などのクエリを入力します。

詳細については、Knowledge Catalog の検索構文をご覧ください。

例: AlloyDB データベーススキーマの検出

メタデータ検出プロセスを理解するために、Knowledge Catalog インテグレーションが有効になっている user-data-cluster という名前の AlloyDB クラスタの例を考えてみましょう。このクラスタのプライマリインスタンス内には、profiles という名前のデータベースがあり、このデータベースにはテーブル customers（id、email、signup_date）とビュー active_users（id、email）が含まれます。

AlloyDB は Knowledge Catalog に準リアルタイムで同期されるため、次のリソースを使用できます。

クラスタ
列
データベース
インスタンス
テーブル
ビュー

検出が完了したら、 Google Cloud コンソールの Knowledge Catalog ページまたは API を使用して、これらのアセット（customers テーブルと active_users）を検索します。スキーマを表示して、追加のビジネスメタデータまたは運用メタデータで拡充します。

アスペクトを使用してメタデータを拡充する

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

カスタムアスペクトタイプを作成したら、AlloyDB アセットにアスペクトを追加します。AlloyDB アセットにアスペクトを追加すると、次のことが可能になります。

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

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

メタデータ検出ワークフロー

クラスタとインスタンスのリソースは、デフォルトで取り込まれ、検出可能になります。データベース、スキーマ、テーブル、ビューのリソースを取り込んで検出する手順は次のとおりです。

AlloyDB API を使用して、AlloyDB クラスタの Knowledge Catalog インテグレーションを有効にします（まだ有効になっていない場合）。これは、2026 年 2 月 26 日より前に作成されたクラスタで必要です。
Google Cloud コンソールの Knowledge Catalog 検索ページを使用して、AlloyDB アセットを検索します。詳細については、Knowledge Catalog でリソースを検索するをご覧ください。
AlloyDB アセットにコンテキストを追加するには、アセットにアスペクトを追加します。アスペクトは、データガバナンスや分析に役立つカスタムメタデータエントリです。たとえば、アスペクトを使用して、個人を特定できる情報（PII）を含む列にラベルを付けます。詳細については、アスペクトを管理してメタデータを拡充するをご覧ください。
AlloyDB リソース間を、クラスタ > データベース > スキーマ > テーブルまたはビュー > 列の階層で移動します。この階層により、データランドスケープを詳細に把握できます。詳細については、Knowledge Catalog でリソースを検索するをご覧ください。

始める前に

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

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

Verify that billing is enabled for your Google Cloud project.

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

Verify that billing is enabled for your Google Cloud project.

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

Dataplex API を有効にする
権限を確認してください。

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

必要な IAM のロール

このセクションでは、リソースの検索と検索結果へのアクセスに必要なロールと権限について説明します。

検索結果にアクセスするために必要なロール

Knowledge Catalog で AlloyDB メタデータを検索して表示するには、プリンシパルに AlloyDB リソースを表示する権限（dataplex.projects.search 権限を含む）が必要です。

プリンシパル（ユーザー、グループ、サービスアカウントなど）にこれらの権限を付与するには、AlloyDB リソースを含むプロジェクトに対する AlloyDB 閲覧者（roles/alloydb.viewer）IAM ロールを割り当てます。

Knowledge Catalog のオペレーション	AlloyDB リソース	必要なロールまたは権限
AlloyDB リソースを検索する	クラスタ	`alloydb.clusters.get`
	列	`alloydb.databases.get`
	インスタンス	`alloydb.instances.get`
	データベース	`alloydb.databases.get`
	テーブル	`alloydb.databases.get`
	ビュー	`alloydb.databases.get`

AlloyDB 閲覧者の事前定義ロールを使用しない場合は、alloydb.clusters.get、alloydb.instances.get、alloydb.databases.get の権限を含むカスタムロールを割り当てます。

ロールの付与の詳細については、アクセス権の管理をご覧ください。AlloyDB IAM ロールの詳細については、AlloyDB の IAM ロールと権限をご覧ください。

エントリの検索に必要なロール

検索に使用するプロジェクトに対する次の IAM ロールが 1 つ以上必要です。

Dataplex Catalog 管理者（roles/dataplex.catalogAdmin）
Dataplex Catalog 編集者（roles/dataplex.catalogEditor）
Dataplex Catalog 閲覧者（roles/dataplex.catalogViewer）

検索結果に対する権限は、選択したプロジェクトにかかわらずチェックされます。詳細については、Knowledge Catalog でデータアセットを検索するをご覧ください。

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

デフォルトでは、Knowledge Catalog はクラスタとインスタンスのリソースを取り込んで検出します。メタデータの鮮度は準リアルタイムです。

新しい AlloyDB クラスタを作成すると、データベース、スキーマ、テーブル、ビューのリソースに対する Knowledge Catalog インテグレーションがデフォルトで有効になります。このメタデータの同期を防ぐには、インテグレーションを無効にします。

統合を有効にすると、AlloyDB メタデータ（データベース、スキーマ、テーブルなど）の Cloud Storage バケットへの定期的な同期、または Pub/Sub トピックへの準リアルタイム同期が有効になり、Knowledge Catalog で使用できるようになります。この機能は、プライマリクラスタにのみ適用されます。クロスリージョンレプリケーションに使用されるセカンダリクラスタは、データベース、スキーマ、テーブル、ビューのメタデータに対する Knowledge Catalog の統合をサポートしていません。

これらのリソースのメタデータの鮮度は、クラスタの作成または復元された日時によって異なります。

準リアルタイム: 2026 年 4 月 3 日以降に作成または復元されたクラスタは、メタデータを Knowledge Catalog に準リアルタイムで同期します。更新は 5 分以内にナレッジカタログで利用可能になります。通常、抽出プロセスには数秒かかります。
数時間ごと: 2026 年 2 月 26 日から 2026 年 4 月 3 日の間に作成または復元されたクラスタは、数時間ごとに Knowledge Catalog のメタデータを更新します。更新は、最長で 48 時間以内にナレッジカタログに反映されます。通常、抽出プロセスには数分かかりますが、完了までの時間は CPU サイズとテーブル数によって異なります。

Knowledge Catalog との統合を無効にして AlloyDB を作成する

この統合は、Google Cloud CLI または AlloyDB API を使用してクラスタを作成または更新するときに制御できます。

gcloud

gcloud alloydb clusters create コマンドを使用して AlloyDB クラスタを作成します。--enable-dataplex-integration フラグを省略すると、データベース、スキーマ、テーブル、ビューのメタデータに対して Knowledge Catalog インテグレーションがデフォルトで有効になります。この呼び出しのパラメータの完全なリストについては、gcloud alloydb clusters create をご覧ください。クラスタの設定の詳細については、クラスタとインスタンスの設定を表示するをご覧ください。

クラスタ ID には機密情報や個人を特定できる情報を含めないでください。クラスタ ID は、システムログ、モニタリングダッシュボード、サポート通信など、さまざまな運用コンテキストで表示される可能性があります。クラスタ名にプロジェクト ID を含める必要はありません。この処理は必要に応じて（ログファイルなどで）自動的に行われます。

データベース、スキーマ、テーブル、ビューのリソースの Knowledge Catalog インテグレーションを無効にするには、--no-enable-dataplex-integration フラグを指定します。

gcloud alloydb clusters create CLUSTER_ID \
    --password=PASSWORD \
    --region=REGION \
    --no-enable-dataplex-integration

次のように置き換えます。

CLUSTER_ID: 作成するクラスタの ID。クラスタ ID の先頭は英小文字にする必要があり、その後に英小文字、数字、ハイフンを続けることが可能です。
PASSWORD: デフォルトの postgres ユーザーに使用するパスワード。
REGION: クラスタのリージョンの ID。

REST

POST メソッドを使用して AlloyDB クラスタを作成します。リクエストで dataplexConfig を省略すると、データベース、スキーマ、テーブル、ビューのメタデータに対して Knowledge Catalog インテグレーションがデフォルトで有効になります。この呼び出しで使用できるパラメータの完全なリストについては、メソッド: projects.locations.clusters.create をご覧ください。クラスタの設定の詳細については、クラスタとインスタンスの設定を表示するをご覧ください。

データベース、スキーマ、テーブル、ビューのリソースの Knowledge Catalog インテグレーションを無効にするには、リクエスト本文に "dataplexConfig": { "enabled": false } を含めます。

{
  "databaseVersion": "DATABASE_VERSION",
  "initialUser": {
    "user": "INITIAL_USERNAME",
    "password": "INITIAL_USER_PASSWORD"
  },
  "labels": {
    "test": "alloydb-cluster-full"
  },
  "dataplexConfig" : {
    "enabled" : false
  }
}

次のように置き換えます。

DATABASE_VERSION: データベースバージョンの列挙型文字列（例: POSTGRES_16）。
INITIAL_USERNAME: デフォルトの postgres ユーザーに使用するユーザー名。
INITIAL_USER_PASSWORD: デフォルトの postgres ユーザーに使用するパスワード。

次の HTTP メソッドと URL を使用します。

POST https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID

次のように置き換えます。

PROJECT_ID: クラスタが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号。
LOCATION_ID: クラスタのリージョンの ID。
CLUSTER_ID: 作成するクラスタの ID。クラスタ ID の先頭は英小文字にする必要があり、その後に英小文字、数字、ハイフンを続けることが可能です。

次のいずれかの方法でリクエストを送信します。

curl（Linux、macOS、Cloud Shell）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

    curl -X POST \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"

PowerShell（Windows）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters?cluster_id=CLUSTER_ID"| Select-Object -Expand Content

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

レスポンス

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

AlloyDB クラスタで Knowledge Catalog インテグレーションを有効にする

既存のクラスタで Knowledge Catalog の統合を有効にするには、次のいずれかの手順を使用します。

gcloud

既存のクラスタで Knowledge Catalog の統合を有効にするには、--enable-dataplex-integration フラグを指定して gcloud alloydb clusters update コマンドを使用します。

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --enable-dataplex-integration

次のように置き換えます。

CLUSTER_ID: クラスタの名前。
REGION: クラスタのリージョンの ID。

REST

既存のクラスタの特定のフィールドを更新するには、projects.locations.clusters resource で PATCH メソッドを使用します。

次の HTTP メソッドと URL を使用します。

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

次のように置き換えます。

PROJECT_ID: クラスタが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号。
LOCATION_ID: クラスタのリージョンの ID。
CLUSTER_ID: クラスタの名前。

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

{
  "dataplexConfig": {
    "enabled": true
  }
}

次のいずれかの方法でリクエストを送信します。

curl（Linux、macOS、Cloud Shell）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

    curl -X PATCH \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
        "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"

PowerShell（Windows）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

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

レスポンス

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

AlloyDB クラスタで Knowledge Catalog インテグレーションを確認する

既存のクラスタで Knowledge Catalog の統合が有効になっていることを確認するには、次のいずれかの操作を行います。

gcloud

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

gcloud alloydb clusters describe CLUSTER_ID --region=REGION

次のように置き換えます。

CLUSTER_ID: クラスタ ID。
REGION: クラスタのリージョンの ID。

出力には、YAML 形式の dataplexConfig セクションが含まれます。enabled が true の場合、Knowledge Catalog の統合が有効になります。

dataplexConfig:
  enabled: true

REST

既存のクラスタで Knowledge Catalog インテグレーションが有効になっていることを確認するには、GET メソッドを使用します。

次の HTTP メソッドと URL を使用します。

GET https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID

次のように置き換えます。

PROJECT_ID: クラスタが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号。
LOCATION_ID: クラスタのリージョンの ID。
CLUSTER_ID: クラスタ ID。

次のいずれかの方法でリクエストを送信します。

curl（Linux、macOS、Cloud Shell）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"

PowerShell（Windows）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID"| Select-Object -Expand Content

dataplexConfig メッセージを含む Cluster proto 全体の JSON レスポンスが返されます。

{
  "dataplexConfig": {
    "enabled": true
  }
}

AlloyDB クラスタで Knowledge Catalog インテグレーションを無効にする

AlloyDB クラスタで Knowledge Catalog の統合を無効にすると、クラスタとインスタンスのメタデータのみが使用可能になります。

gcloud

gcloud alloydb clusters update コマンドに --no-enable-dataplex-integration フラグを指定して、統合を無効にします。

gcloud alloydb clusters update CLUSTER_ID \
    --region=REGION \
    --no-enable-dataplex-integration

次のように置き換えます。

CLUSTER_ID: クラスタの ID。
REGION: クラスタのリージョンの ID。

REST

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

次の HTTP メソッドと URL を使用します。

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled

次のように置き換えます。

PROJECT_ID: クラスタが含まれている Google Cloud プロジェクトの ID またはプロジェクト番号。
LOCATION_ID: クラスタのリージョンの ID。
CLUSTER_ID: クラスタ ID。

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

{
  "dataplexConfig": {
    "enabled": false
  }
}

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

curl（Linux、macOS、Cloud Shell）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"

PowerShell（Windows）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?updateMask=dataplexConfig.enabled"| Select-Object -Expand Content

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

レスポンス

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

アスペクトを使用して AlloyDB アセットを拡充する

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

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

AlloyDB アセットを検索する

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

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

[検索] に移動
[検索プラットフォームの選択] で、[Knowledge Catalog] を選択します。
[フィルタ] パネルで [システム] をクリックし、[AlloyDB] を選択します。
省略可。[タイプエイリアス] で、次のいずれかのタイプエイリアスを選択すると、特定のタイプの AlloyDB アセットで検索結果をフィルタできます。
- データベース
- データベーススキーマ
- クラスタ
- インスタンス
- サービス
- テーブル
- ビュー
注: サービスは、AlloyDB インスタンスのタイプエイリアスです。

クエリを使用してキーワード検索を行う

Knowledge Catalog の検索フィールドを使用して、キーワード検索クエリを実行します。たとえば、「system=AlloyDB AND type=Database」と入力すると、すべての AlloyDB データベースが表示されます。

詳細については、Knowledge Catalog の検索構文をご覧ください。

すべての AlloyDB アセットを表示するには、「system=AlloyDB」と入力します。

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

system=AlloyDB AND type=Database

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

system=AlloyDB AND type=Table

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

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

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

次のように置き換えます。

QUERY_STRING: 次のリストを使用して、クエリする AlloyDB アセットタイプに応じたクエリ文字列を特定します。
- alloydb-database
- alloydb-cluster
- alloydb-instance
- alloydb-table
- alloydb-schema
- alloydb-view

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

type="projects/1234567890/locations/global/entryTypes/alloydb-cluster"

アスペクトタイプで検索する

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

アスペクトタイプで検索する手順は次のとおりです。

[アスペクト] パネルで、[アスペクトタイプを追加] メニューをクリックします。
省略可。[AlloyDB Access] を選択して、AlloyDB 言語で結果をフィルタします。
次のアスペクトタイプを 1 つ以上選択して、検索結果をそのタイプに絞り込みます。
- AlloyDB データベース
- AlloyDB クラスタ
- AlloyDB インスタンス
- AlloyDB ビュー
- AlloyDB スキーマ
- AlloyDB テーブル
[OK] をクリックします。
結果のテーブルでアセットの名前をクリックすると、そのアセットのメタデータが表示されます。
省略可: アセットを拡充または表示します。アセットを拡充または表示するには、次の方法があります。
- アセットのリッチテキストによる説明を追加するには、[概要] で [追加] をクリックします。
- アセットにアスペクトを追加するには、[アスペクト] で [追加] をクリックします。
- インスタンスのメンバーデータベースを表示するには、[エントリリスト] タブをクリックし、[検索結果の子エントリをすべて表示] をクリックします。[エントリリスト] タブが表示されない場合、そのクラスタにはデータベースがありません。
- [エンティティの詳細] で、アセットの詳細を確認します。エントリ名をクリックして、他のエントリにドリルダウンします。

AlloyDB の自然言語検索

自然言語検索（プレビュー）は、AI を使用してセマンティッククエリを理解します。普段使う言葉でリソースを検索できるため、複雑な構文を使用する必要はありません。たとえば、「List all AlloyDB tables related to sales」などのクエリを入力します。

詳細については、Knowledge Catalog の検索構文をご覧ください。

AlloyDB の構文検索

キーワード検索では、特定のキーワード、フィルタ、定義された構文を使用してリソースを検索できます。たとえば、「system=AlloyDB AND type=Database」と入力すると、すべての AlloyDB データベースが表示されます。

詳細については、Knowledge Catalog の検索構文をご覧ください。

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

クラスタから列にドリルダウンする手順は次のとおりです。

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

[検索] に移動
[検索プラットフォームを選択] で、[Knowledge Catalog] を選択します。
[フィルタ] パネルで、[システム]、[AlloyDB] の順に選択します。または、検索フィールドに「system=AlloyDB」と入力します。
クラスタ名を選択します。
[AlloyDB details] ページで、[エントリリスト] タブをクリックし、[検索結果の子エントリをすべて表示] をクリックします。Knowledge Catalog にクラスタ内のデータベースが表示されます。

注: [エントリリスト] タブが表示されない場合は、[検索] ページに戻って別のクラスタを選択します。
[AlloyDB database details] ページで、[エントリリスト] タブをクリックし、[子エントリを検索で表示する] をクリックします。Knowledge Catalog にクラスタ内のテーブルが表示されます。
テーブル名を選択し、[AlloyDB table details] ページで [スキーマ] をクリックすると、テーブルの列が表示されます。
省略可: 列にアスペクトタイプを追加するには、[アスペクトを追加] ボタンをクリックします。

料金

Knowledge Catalog に AlloyDB テクニカルメタデータを保存する場合、料金は発生しません。API 呼び出しと追加のビジネスメタデータの拡充には、Knowledge Catalog の標準の料金が適用されます。詳細については、ナレッジカタログの料金ページをご覧ください。

リソースの利用

Knowledge Catalog は、AlloyDB クラスタから定期的にメタデータを抽出します。この抽出プロセスでは、クラスタの CPU リソースが消費されます。CPU 使用率は通常最小限です。たとえば、大規模なスキーマ（100,000 個以上のテーブルを含むスキーマなど）を管理する小さいマシンタイプ（n2-highmem-2-icelake など）のクラスタでは、抽出中に CPU 使用率が最大 5% 増加する可能性があります。

制限事項

この統合では、データベースあたり最大 100 万個のテーブルと、テーブルあたり平均 150 個の列がサポートされます。これらの上限のいずれかを超えると、データベース、スキーマ、テーブル、ビューなどのリソースのメタデータは抽出されません。Knowledge Catalog では、クラスタとインスタンスのメタデータのみが使用可能です。
クラスタが最初に作成されたとき、すべてのメタデータの Knowledge Catalog への初回同期には最長で 48 時間かかることがあります。最初の同期の後、後続の更新は準リアルタイムで利用できます。
データベースでメタデータの変更率が高い場合（1 秒あたり 100 件以上の DDL 変更）、Knowledge Catalog との準リアルタイムのメタデータ同期が一時停止し、再開までに最大 30 分かかることがあります。
メタデータの変更率が高い、ネットワークの問題、同期プロセスの中断などの理由で更新が欠落した場合でも、48 時間以内に Knowledge Catalog に表示されます。
インスタンスが存在しない場合や実行されていない場合、メタデータが削除されるまでに 7 日かかることがあります。
データベースの名前を変更すると、データベースの更新のみが Knowledge Catalog で準リアルタイムで使用可能になります。データベースとそれぞれのテーブルの基盤となるマッピングは、48 時間以内に Knowledge Catalog で更新されます。

Knowledge Catalog を使用して AlloyDB リソースを管理する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メタデータ検出の種類

キーワード検索と自然言語検索

例: AlloyDB データベース スキーマの検出

アスペクトを使用してメタデータを拡充する

メタデータ検出ワークフロー

始める前に

必要な IAM のロール

検索結果にアクセスするために必要なロール

エントリの検索に必要なロール

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

Knowledge Catalog との統合を無効にして AlloyDB を作成する

gcloud

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

レスポンス

AlloyDB クラスタで Knowledge Catalog インテグレーションを有効にする

gcloud

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

レスポンス

AlloyDB クラスタで Knowledge Catalog インテグレーションを確認する

gcloud

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

AlloyDB クラスタで Knowledge Catalog インテグレーションを無効にする

gcloud

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

レスポンス

アスペクトを使用して AlloyDB アセットを拡充する

AlloyDB アセットを検索する

クエリを使用してキーワード検索を行う

アスペクト タイプで検索する

AlloyDB の自然言語検索

AlloyDB の構文検索

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

料金

リソースの利用

制限事項

次のステップ

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

例: AlloyDB データベーススキーマの検出

アスペクトタイプで検索する