生成建表SQL

最近更新时间:2024-06-10 01:39:21

我的收藏

1. 接口描述

接口请求域名: dlc.tencentcloudapi.com 。

本接口(CreateTable)用于生成建表SQL。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateTable。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
TableInfo TableInfo 数据表配置信息

3. 输出参数

参数名称 类型 描述
Execution Execution 生成的建表执行语句对象。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 建表

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTable
<公共请求参数>

{
    "TableInfo": {
        "TableBaseInfo": {
            "DatabaseName": "testhyw",
            "TableName": "Table1",
            "DatasourceConnectionName": "DataLakeCatalog"
        },
        "Columns": [
            {
                "Name": "user_id",
                "Type": "int"
            },
            {
                "Name": "birthday",
                "Type": "int"
            },
            {
                "Name": "gender",
                "Type": "int"
            }
        ],
        "Partitions": [
            {
                "Comment": "part",
                "Name": "gender",
                "Type": "string"
            }
        ],
        "Location": "cosn://ricky-1301xxx708/test1/",
        "DataFormat": {
            "CSV": {
                "Format": "CSV",
                "CodeCompress": "None",
                "HeadLines": 1,
                "CSVSerde": {
                    "Quote": "\"",
                    "Separator": ","
                }
            },
            "AVRO": {
                "Format": ""
            },
            "Json": {
                "Format": ""
            },
            "Parquet": {
                "Format": ""
            },
            "TextFile": {
                "Regex": "",
                "Format": ""
            },
            "ORC": {
                "Format": ""
            }
        }
    }
}

输出示例

{
    "Response": {
        "Execution": {
            "SQL": "CREATE EXTERNAL TABLE IF NOT EXISTS `DataLakeCatalog`.`testhyw`.`Table1` (`user_id` int,`birthday` int,`gender` int) PARTITIONED BY (`gender` string)  ROW FORMAT SERDE 'org.apache.hadoop.hive.serde2.OpenCSVSerde' WITH SERDEPROPERTIES ('separatorChar'=',','quoteChar'='\"') STORED AS TEXTFILE LOCATION 'cosn://rickyhu-1301312708/test1/'  TBLPROPERTIES ('skip.header.line.count'='1')"
        },
        "RequestId": "b076c1df-26f0-45b7-84f1-fa4eeca7c83f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.InternalSystemException 业务系统异常,请重试或提工单联系我们。
InvalidParameter 参数错误。
InvalidParameter.InvalidColumnNameLength 字段名称设置错误,字段名称必须小于等于128字节
InvalidParameter.InvalidColumnNumber 字段个数设置错误,字段个数必须小于等于4096
InvalidParameter.InvalidColumnType 字段类型设置错误,仅支持string/tinyint/smallint/int/bigint/boolean/float/double/decimal/timestamp/date/binary/array<>/map<>/struct<>/uniontype<>
InvalidParameter.InvalidDecimalType DecimalType设置非法,Precision必须大于等于Scale,且Precision必须小于38
InvalidParameter.InvalidTableFormat 表格式非法,当前仅支持: TextFile/CSV/Json/Parquet/ORC/AVRO
InvalidParameter.InvalidTableFormatSize 表格式设置错误,只能设置一种格式
InvalidParameter.InvalidTableLocation 表路径设置错误,请检查并重新设置
InvalidParameter.InvalidTableNameLength 表名设置错误,表名长度必须小于等于128字节
InvalidParameter.ParameterNotFoundOrBeNone 找不到参数或参数为空