本页面上的部分或全部信息可能不适用于 Cloud de Confiance by S3NS。如需了解详情，请参阅与 Google Cloud 的区别。

使用 Knowledge Catalog 管理 Cloud SQL 资源

MySQL | PostgreSQL | SQL Server

本页面介绍了如何使用 Knowledge Catalog 搜索和管理 Cloud SQL 资源。

知识目录是一个用于存储、管理和访问元数据的平台。知识目录会自动从 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 的集成：

创建时间：2026 年 4 月 18 日当天或之后

注意：2026 年 3 月 19 日至 2026 年 4 月 18 日期间创建的一小部分实例也属于此类别。如需确认在此期间创建的实例是否属于此类别，请参阅验证 Cloud SQL 实例上的 Knowledge Catalog 集成。
版本：Cloud SQL for MySQL 8.0 版或更高版本
网络架构：新网络架构

如果您的实例不符合上述所有条件，请参阅每天一次。

如果实例满足所有这些条件，系统会创建包含时间戳记表的实例，以跟踪资产的创建和更新时间。时间戳表是 mysql 数据库中的 resource_timestamps 表。您可以在 Cloud de Confiance 控制台中通过 Cloud SQL 查询时间戳表。当您的实例发生 DDL 或架构更改时，集成会查询时间戳表以识别最近更改的资源，然后近乎实时地将最新的架构更新加载到 Knowledge Catalog。在极少数情况下（例如网络不稳定时），Knowledge Catalog 可能会遗漏更新。虽然这种情况很少见，但任何遗漏的更改最终都会保持一致，通常在 24 小时内。如需详细了解可能导致错过更改的场景，请参阅本页上的限制。

查看实例中已运行的查询时，您会看到支持 Knowledge Catalog 集成的查询。您可以通过这些查询中包含的 --Dataplex 注释来识别它们。如需查看实例的查询，请参阅查看活跃查询。

您可以停用集成，然后按照更新实例中的说明稍后重新启用它。

每天一次

对于满足以下任何条件的实例，都可以启用与 Knowledge Catalog 的集成：

创建时间：2026 年 4 月 18 日之前
版本：低于 8.0 的 Cloud SQL for MySQL 版本
网络架构：旧网络架构

如果您的实例是在 2026 年 4 月 18 日之后创建的，则默认启用与 Knowledge Catalog 的集成。对于 2026 年 4 月 18 日之前创建的实例，您可以在现有 Cloud SQL 实例上启用 Knowledge Catalog 集成。

启用与 Knowledge Catalog 的集成后，满足以下任一条件的实例的元数据通常会在 Knowledge Catalog 中每天刷新一次左右。您可以停用 Knowledge Catalog 集成，并根据需要重新启用它。

准备工作

In the Cloud de Confiance console, on the project selector page, select or create a Cloud de Confiance 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.
Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector
Verify that billing is enabled for your Cloud de Confiance project.
为项目启用 Dataplex API。

启用 Dataplex API
请检查权限。

您需要特定的 Identity and Access Management (IAM) 角色和权限才能搜索条目并将其附加到 Cloud SQL 资产。如需了解详情，请参阅 Knowledge Catalog 所需的 IAM 角色和权限。

Knowledge Catalog 所需的 IAM 角色和权限

Cloud SQL 使用 cloudsql.schemas.view 权限来提供对 Knowledge Catalog 上元数据的访问权限。

如需提供此权限，请创建可提供此权限的自定义角色，或使用具有此权限的预定义角色之一。

如需了解详情，请参阅预定义的 Cloud SQL IAM 角色。

创建启用了 Knowledge Catalog 集成的实例

默认情况下，新实例会与 Knowledge Catalog 集成。如需创建启用了 Knowledge Catalog 集成的新实例，只需创建新实例即可。如需创建近乎实时集成 Knowledge Catalog 的实例，新实例必须满足以下所有条件：

创建时间：2026 年 4 月 18 日当天或之后

注意：2026 年 3 月 19 日至 2026 年 4 月 18 日期间创建的一小部分实例也属于此类别。如需确认在此期间创建的实例是否属于此类别，请参阅验证 Cloud SQL 实例上的 Knowledge Catalog 集成。
版本：Cloud SQL for MySQL 8.0 版或更高版本
网络架构：新网络架构

如果您想为具有较早数据库版本或旧网络架构的新实例启用近乎实时的 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：实例的数据库版本（例如 MYSQL_8_0）。如需查看可用字符串的完整列表，请参阅 SqlDatabaseVersion
MACHINE_TYPE：实例的机器类型
REGION_NAME：实例的区域名称

此示例基于 Linux。

REST v1

创建实例

使用此示例创建已启用集成的实例。如需查看此调用可用的完整参数列表，请参阅 instances.insert 页面。

在使用任何请求数据之前，请先进行以下替换：

PROJECT_ID：包含实例的 Cloud de Confiance 项目的 ID 或项目编号
INSTANCE_NAME：实例的名称
REGION_NAME：实例的区域名称
DATABASE_VERSION：数据库版本的枚举字符串（例如 POSTGRES_13）。如需查看可用字符串的完整列表，请参阅 SqlDatabaseVersion。
PASSWORD：root 用户的密码
MACHINE_TYPE：机器（层级）类型的枚举字符串，例如：db-custom-[CPUS]-[MEMORY_MBS]
EDITION_TYPE：您的 Cloud SQL 版本

HTTP 方法和网址：

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
  }
}

如需发送您的请求，请展开以下选项之一：

curl（Linux、macOS 或 Cloud Shell）

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI，或者使用了 Cloud Shell，这会使您自动登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 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://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 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://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances" | Select-Object -Expand Content

您应该收到类似以下内容的 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：包含实例的 Cloud de Confiance 项目的 ID 或项目编号
INSTANCE_NAME：实例的名称
REGION_NAME：实例的区域名称
DATABASE_VERSION：数据库版本的枚举字符串（例如 POSTGRES_13）。如需查看可用字符串的完整列表，请参阅 SqlDatabaseVersion。
PASSWORD：root 用户的密码
MACHINE_TYPE：机器（层级）类型的枚举字符串，例如：db-custom-[CPUS]-[MEMORY_MBS]
EDITION_TYPE：您的 Cloud SQL 版本

HTTP 方法和网址：

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
  }
}

如需发送您的请求，请展开以下选项之一：

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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances" | Select-Object -Expand Content

您应该收到类似以下内容的 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 日之前
版本：低于 8.0 的 Cloud SQL for MySQL 版本
网络架构：旧网络架构

您还可以按照本部分中的更新说明操作，在之前已与 Knowledge Catalog 近乎实时集成的实例上重新启用 Knowledge Catalog 集成。重新启用集成后，近乎实时的数据最多需要 10 分钟才能开始显示在 Knowledge Catalog 中。

如需在现有 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：包含实例的 Cloud de Confiance 项目的 ID 或项目编号
INSTANCE_NAME：实例的名称

HTTP 方法和网址：

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

请求 JSON 正文：

{
  "settings":
  {
    "enableDataplexIntegration": 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://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 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://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

您应该收到类似以下内容的 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 页面。

在使用任何请求数据之前，请先进行以下替换：

PROJECT_ID：包含实例的 Cloud de Confiance 项目的 ID 或项目编号
INSTANCE_NAME：实例的名称

HTTP 方法和网址：

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

请求 JSON 正文：

{
  "settings":
  {
    "enableDataplexIntegration": 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

您应该收到类似以下内容的 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 替换为实例名称。在输出中，查找设为 true 的配置设置 enableDataplexIntegration。

REST v1

在使用任何请求数据之前，请先进行以下替换：

PROJECT_ID：项目 ID
INSTANCE_ID：实例 ID

HTTP 方法和网址：

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

如需发送您的请求，请展开以下选项之一：

curl（Linux、macOS 或 Cloud Shell）

执行以下命令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

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

REST v1beta4

在使用任何请求数据之前，请先进行以下替换：

PROJECT_ID：项目 ID
INSTANCE_ID：实例 ID

HTTP 方法和网址：

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

如需发送您的请求，请展开以下选项之一：

curl（Linux、macOS 或 Cloud Shell）

执行以下命令：

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

执行以下命令：

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

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_ID" | Select-Object -Expand Content

您应该收到类似以下内容的 JSON 响应：

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

在 Cloud SQL 实例上停用 Knowledge Catalog 集成

如需在 Cloud SQL 实例上停用 Knowledge Catalog 集成，请按照以下过程之一操作。在近乎实时集成的实例上停用 Knowledge Catalog 集成最多需要 10 分钟。

控制台

在 Cloud de Confiance 控制台中，前往 Cloud SQL 实例页面。

转到“Cloud SQL 实例”
如需打开实例的概览页面，请点击实例名称。
点击修改。
在自定义实例部分中，展开显示配置选项菜单。
在标志和参数部分中，清除启用 Knowledge Catalog 集成复选框。
点击保存。

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：包含实例的 Cloud de Confiance 项目的 ID 或项目编号
INSTANCE_NAME：实例的名称

HTTP 方法和网址：

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

请求 JSON 正文：

{
  "settings":
  {
    "enableDataplexIntegration": 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

您应该收到类似以下内容的 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：包含实例的 Cloud de Confiance 项目的 ID 或项目编号
INSTANCE_NAME：实例的名称

HTTP 方法和网址：

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

请求 JSON 正文：

{
  "settings":
  {
    "enableDataplexIntegration": 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME"

PowerShell (Windows)

注意：以下命令假定您已使用您的用户账号通过运行 gcloud init 或 gcloud auth login 登录 gcloud CLI。您可以运行 gcloud auth list 来检查当前活跃的账号。

将请求正文保存在名为 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://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME" | Select-Object -Expand Content

您应该收到类似以下内容的 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 资产

切面类型是可重复使用的资源，可用作切面的模板。切面类型可帮助您避免重复性工作和不完整的切面。您可以使用知识目录创建所需的切面类型。

创建自定义切面类型后，您可以将切面关联到 Cloud SQL 资产。通过将切面关联到 Cloud SQL 资产，您可以执行以下操作：

将业务元数据添加到资产
按业务元数据和其他自定义元数据搜索资产

如需详细了解如何创建切面类型并将切面附加到 Cloud SQL，请参阅管理切面并丰富元数据。

搜索 Cloud SQL 资产

使用 Cloud de Confiance 控制台中的 Knowledge Catalog 搜索页面可搜索 Cloud SQL 资产。

前往知识目录搜索页面。

转到搜索
在选择搜索平台中，选择 Knowledge Catalog。
在过滤条件面板中，点击系统，然后选择 Cloud SQL。
可选。在类型别名中，您可以通过选择以下一种或多种类型别名，将搜索结果过滤为特定类型的 Cloud SQL 资产：
- 数据库
- 服务
- 表格
- 查看
注意：服务是 Cloud SQL 实例的类型别名。

使用查询执行搜索

您还可以使用知识目录中的搜索字段执行搜索查询。如需查看所有 Cloud SQL 资产，请输入 system=Cloud_SQL。

然后，您可以输入特定关键字。例如，如需查看所有 Cloud SQL 数据库，请输入以下查询：

system=Cloud_SQL AND type=Database

如需查看所有 Cloud SQL 表，请输入以下查询：

system=Cloud_SQL AND type=Table

您还可以使用复杂的括号和逻辑运算符 AND 和 OR 来表示复杂表达式。如需详细了解可在搜索字段中使用的表达式，请参阅知识目录的搜索语法。

您可以直接在搜索字段中输入用于特定 Cloud SQL 资产的搜索查询。查询字符串的格式如下：

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

根据您要查询的 Cloud SQL 引擎和资产类型，将 QUERY_STRING 替换为查询字符串。请使用下表确定合适的查询字符串。

Cloud SQL 引擎	查询字符串
Cloud SQL for MySQL	`cloudsql-mysql-database` `cloudsql-mysql-instance` `cloudsql-mysql-table` `cloudsql-mysql-view` 注意：MySQL 不支持架构。
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 资产

默认情况下，知识目录会显示所有 Cloud SQL 资产。若要仅过滤 Cloud SQL for MySQL、Cloud SQL for PostgreSQL 或 SQL Server 的资产，请执行以下步骤。

在切面面板中，点击添加更多切面类型菜单。
选择 SQL Access。
点击确定。
点击 playlist_add 修改切面按钮。在 SQL Access 页面中，执行以下操作：
- 在方言字段中，选择 MySQL 以过滤 Cloud SQL for MySQL 资产。
- 可选。选择版本字段，然后输入特定版本的 Cloud SQL for MySQL。
点击应用。知识目录仅会显示 Cloud SQL for MySQL 资产。

按切面类型搜索

知识目录包含一些内置的方面类型，您可以使用这些方面类型执行搜索。

在切面面板中，点击添加更多切面类型菜单。
可选。选择 SQL 访问权限以按 Cloud SQL 方言过滤结果。如需了解详情，请参阅上一个步骤按 Cloud SQL 方言过滤 Cloud SQL 资产。
选择一个或多个以下切面类型，以将搜索结果限制为该类型。
- Cloud SQL 数据库
- Cloud SQL 实例
- Cloud SQL 视图
- Cloud SQL 架构
- Cloud SQL 表
点击确定。
在结果表中，点击资产的名称以查看该资产的元数据。
可选：优化或查看资产。您可以执行以下任一操作：
- 在概览中，点击添加以添加资产的富文本说明。
- 在切面中，点击添加以将某个切面附加到资产。
- 例如，如需查看成员数据库，请点击条目列表标签页，然后点击在搜索结果中显示所有子条目。如果条目列表标签页未显示，则表示该实例没有数据库。
- 在条目详情中，查看资产的完整详情。点击条目名称可展开细目至其他条目。

示例工作流 - 从实例展开细目至列

在此示例工作流中，您首先搜索 Cloud SQL 实例，然后查看成员数据库，再查看该数据库中的一个表，最后查看该表中的列。

前往知识目录搜索页面。

转到搜索
对于选择搜索平台选项，选择 Knowledge Catalog。
在过滤条件面板中，选择系统，然后选择 Cloud SQL。或者，在搜索字段中输入 system=Cloud_SQL。
选择实例名称。
在 Cloud SQL 详情页面上，点击条目列表标签页，然后点击在搜索结果中显示所有子条目。知识目录会显示实例中的数据库。

注意：如果没有条目列表标签页，请返回搜索页面，然后选择其他实例。
在 Cloud SQL database details 页面上，点击条目列表标签页，然后点击查看搜索结果中的子条目。Knowledge Catalog 会显示数据库中的表。
选择表名称，然后在 Cloud SQL table details 页面上，点击架构以查看表列。
可选：如需向列添加某个切面类型，请点击添加切面按钮。

此工作流演示了如何从实例展开细目至表。您可以通过在搜索字段中输入 system=Cloud_SQL AND type=Table 直接前往表列表。

价格

在 Knowledge Catalog 中存储 Cloud SQL 技术元数据无需付费。对于 API 调用和额外的业务元数据丰富化，适用标准 Knowledge Catalog 价格。如需了解详情，请参阅 Knowledge Catalog 价格页面。

资源使用情况

启用 Knowledge Catalog 集成后，Knowledge Catalog 会定期从您的实例中提取数据。提取过程需要占用一定量的 CPU。与 Knowledge Catalog 近乎实时集成的实例以及 2026 年 4 月 18 日之后创建的其他实例通常对 CPU 使用率的影响最小。对于 2026 年 4 月 18 日之前创建的大多数实例（包括 2026 年 3 月 19 日之前创建的所有实例），CPU 使用率可以更高。对于具有较小机器类型的实例（例如具有共享核心和较大架构 [10,000 个或更多表] 的机器），这一点尤其明显，因为这些实例在提取过程中最多可以利用 40% 的 CPU。

限制

本部分列出了使用 Cloud SQL 和知识目录的限制。

对于在 2026 年 4 月 18 日之前创建的实例，如果因在 Assured Workloads 中注册资源而限制对资源的访问权限，系统会停用 Knowledge Catalog 与 Cloud SQL 的集成。
在实例上启用 Knowledge Catalog 后，Cloud SQL 资源可能需要 2 到 48 小时才能作为资产显示在 Knowledge Catalog 中，具体取决于机器大小、版本以及使用的 Cloud SQL 引擎的类型。如果您的实例近乎实时地更新（如近乎实时中所述），则此限制不适用。
您配置为高可用性 (HA) 的实例在创建后不会自动启用 Knowledge Catalog。如果您为已启用 Knowledge Catalog 的实例启用高可用性，那么除非您关闭 Knowledge Catalog，否则 Knowledge Catalog 会保持启用状态。

如果您删除 Cloud SQL for MySQL 数据库、表或视图，然后使用以前的名称重新创建该数据库、表或视图，则属于原始数据库、表或视图的所有现有 Knowledge Catalog 条目都会保留在 Knowledge Catalog 中。当您对 Cloud SQL for PostgreSQL 或 SQL Server 数据库执行相同的删除和重新创建操作时，系统会从知识目录中移除相应条目，这是预期的行为。
当您对 Cloud SQL for MySQL 数据库执行 TRUNCATE 操作时，所有知识目录条目都会从数据库中移除。

以下限制仅适用于实例近乎实时更新的情况，如近乎实时中所述：

重命名数据库后，知识目录中仅会近乎实时地显示数据库更新。数据库和所有相应表的底层映射最终将在 Knowledge Catalog 中保持一致。
对于已启用 VPC Service Controls 的实例，不支持近乎实时的 Knowledge Catalog 集成。
实例可能会丢弃消息，这会导致 Knowledge Catalog 中的数据最终保持一致。如果消息被丢弃，最终会在 Knowledge Catalog 中显示错过的更新。以下情况可能会导致实例丢弃消息：
- 在短时间内 DDL 执行率较高的实例。
- 现有实例的克隆实例。
- 从备份恢复的实例。
- 内存即将耗尽的实例。
- 正在重启或重启其数据库的实例。
- 遇到网络问题或与 Knowledge Catalog 的同步进程中断的实例。

使用 Knowledge Catalog 管理 Cloud SQL 资源

知识目录集成数据新鲜度

近乎实时

每天一次

准备工作

Knowledge Catalog 所需的 IAM 角色和权限

创建启用了 Knowledge Catalog 集成的实例

gcloud

创建实例

REST v1

创建实例

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

REST v1beta4

创建实例

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

在现有 Cloud SQL 实例上启用 Knowledge Catalog 集成

gcloud

更新实例

REST v1

更新实例

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

REST v1beta4

更新实例

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

验证 Cloud SQL 实例上的 Knowledge Catalog 集成

gcloud

REST v1

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

REST v1beta4

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

在 Cloud SQL 实例上停用 Knowledge Catalog 集成

控制台

gcloud

REST v1

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

REST v1beta4

curl（Linux、macOS 或 Cloud Shell）

PowerShell (Windows)

通过切面丰富 Cloud SQL 资产

搜索 Cloud SQL 资产

使用查询执行搜索

按 Cloud SQL 方言过滤 Cloud SQL 资产

按切面类型搜索

示例工作流 - 从实例展开细目至列

价格

资源使用情况

限制

后续步骤