文档首页/云数据库 GaussDB/API参考/API（推荐）/诊断优化/识别SQL文本中的表信息 - IdentifyingTableInformationinSQLText
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

识别SQL文本中的表信息 - IdentifyingTableInformationinSQLText

功能介绍

识别SQL文本中的表信息。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/{project_id}/instances/{instance_id}/parse/schema-table

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

sql_text

是

String

参数解释：

SQL文本。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

否

String

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

响应参数

表4 响应Body参数

参数

参数类型

描述

database_tables

Array of objects

参数解释：

表信息列表。详情请参见表5。

表5 DatabaseSchemaTable

参数

参数类型

描述

table_name

String

参数解释：

表名称。

取值范围：

不涉及。

schema_name

String

参数解释：

schema名称。

取值范围：

不涉及。

请求示例

识别SQL文本中的表信息。

POST https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/3d39c18788b54a919bab633874c159dfin14/instances/3d39c18788b54a919bab633874c159dfin01/parse/schema-table
{
  "sql_text": "SELECT u.username, COUNT(o.id) AS total_orders FROM public.users u LEFT JOIN sales.orders o ON u.id = o.user_id GROUP BY u.username ORDER BY total_orders DESC;"  
}

响应示例

{
  "database_tables": [
    {
      "table_name": "users",
      "schema_name": "public"
    },
    {
      "table_name": "orders",
      "schema_name": "sales"
    },
    {
      "table_name": "products",
      "schema_name": "inventory"
    },
    {
      "table_name": "payments",
      "schema_name": "finance"
    }
  ]
}

状态码

错误码

请参见错误码。

父主题：诊断优化