Identifying Table Information in SQL Text

Function

This API is used to identify table information in SQL text. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. After the request is processed, the value of X-Subject-Token in the message header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Language. Constraints N/A Range zh-cn en-us Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
sql_text	Yes	String	Definition SQL text. Constraints N/A Range N/A Default Value N/A
instance_id	No	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Response Parameters

**Table 4** Response body parameters
Parameter	Type	Description
database_tables	Array of objects	Definition Table information list. For details, see Table 5.

**Table 5** DatabaseSchemaTable
Parameter	Type	Description
table_name	String	Definition Table name. Range N/A
schema_name	String	Definition Schema name. Range N/A

Example Request

Identifying table information in SQL text

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

Example Response

{
  "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"
    }
  ]
}