数据开发治理平台 WeData
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据开发治理平台 WeData > API 文档 > 数据集成相关接口 > 生成建hive表的sql

生成建hive表的sql

最近更新时间：2024-04-16 15:28:15

我的收藏

本页目录：

1. 接口描述

接口请求域名： wedata.tencentcloudapi.com 。

生成建hive表的sql

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：GenHiveTableDDLSql。
Version 是 String 公共参数，本接口取值：2021-08-20。
Region 是 String 公共参数，详见产品支持的 地域列表。
ProjectId 是 String 项目id
示例值：1486446569620893696
SinkDatabase 是 String 目标数据库
示例值：test_hive
Id 否 String 节点id
MsType 否 String 元数据类型(MYSQL、ORACLE)
示例值：MYSQL
DatasourceId 否 String 数据源id
示例值：915669
SourceDatabase 否 String 来源库名
示例值：test_mysql
TableName 否 String 来源表名
示例值：table_test
SinkType 否 String 目标表元数据类型(HIVE、GBASE)
示例值：HIVE
SchemaName 否 String 源端schema名称
示例值：test_schema
SourceFieldInfoList.N 否 Array of SourceFieldInfo 上游节点的字段信息
Partitions.N 否 Array of Partition 分区字段
示例值：pt
Properties.N 否 Array of Property 建表属性
TableMode 否 Integer 建表模式，0:向导模式，1:ddl
示例值：0
TableVersion 否 String DLC表版本，v1/v2
示例值：v1
UpsertFlag 否 Boolean 是否upsert写入
示例值：true
TableComment 否 String 表描述信息
示例值：hghe
AddDataFiles 否 Integer 增加的文件数量阈值, 超过值将触发小文件合并
示例值：1000
AddEqualityDeletes 否 Integer 增加的Equality delete数量阈值, 超过值将触发小文件合并
示例值：1000
AddPositionDeletes 否 Integer 增加的Position delete数量阈值, 超过值将触发小文件合并
示例值：1000
AddDeleteFiles 否 Integer 增加的delete file数量阈值
示例值：1000
TargetDatasourceId 否 String 下游节点数据源ID
示例值：123
UpsertKeys.N 否 Array of String dlc upsert主键
TableBaseInfo 否 TableBaseInfo dlc表治理信息
SinkSchemaName 否 String 目标端schema名称
示例值：public

3. 输出参数

参数名称 类型 描述
DDLSql String 生成的ddl语句
示例值：CREATE TABLE IF NOT EXISTS test_hive.test_table(id bigint comment '主键id',name string comment '名称',len decimal(5,2),a1 bigint)row format delimited fields terminated by '\t' STORED AS PARQUET;
Data String 生成的ddl语句。与DDLSql相同含义，优先取Data，如果Data为空，则取DDLSql。
注意：此字段可能返回 null，表示取不到有效值。
示例值：CREATE TABLE IF NOT EXISTS test_hive.test_table(id bigint comment '主键id',name string comment '名称',len decimal(5,2),a1 bigint)row format delimited fields terminated by '\t' STORED AS PARQUET;
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 GenHiveTableDDLSql

生成建hive表的sql

输入示例

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

{
    "Id": "",
    "ProjectId": "1486446569620893696",
    "MsType": "MYSQL",
    "DatasourceId": "915669",
    "SourceDatabase": "source_database_name",
    "TableName": "test_table_name",
    "SinkDatabase": "sink_database_name",
    "SinkType": "HIVE",
    "SchemaName": "test_schema_name",
    "SourceFieldInfoList": [
        {
            "FieldName": "name",
            "FieldType": "string",
            "Alias": "name"
        }
    ],
    "Partitions": [
        {
            "Transform": "identity",
            "Name": "id",
            "TransformArgs": [
                ""
            ]
        }
    ],
    "Properties": [
        {
            "Key": "format-version",
            "Value": "2"
        }
    ],
    "TableMode": 0,
    "TableVersion": "abc",
    "UpsertFlag": true,
    "TableComment": "表注释",
    "AddDataFiles": 0,
    "AddEqualityDeletes": 0,
    "AddPositionDeletes": 0,
    "AddDeleteFiles": 0,
    "TargetDatasourceId": "915792"
}

输出示例

{
    "Response": {
        "DDLSql": "CREATE TABLE IF NOT EXISTS `test_hive`.`test_table`(`id` bigint comment '主键id',`name` string comment '名称',`len` decimal(5,2),`a1` bigint)row format delimited fields terminated by '\\t' STORED AS PARQUET;",
        "Data": "CREATE TABLE IF NOT EXISTS `test_hive`.`test_table`(`id` bigint comment '主键id',`name` string comment '名称',`len` decimal(5,2),`a1` bigint)row format delimited fields terminated by '\\t' STORED AS PARQUET;",
        "RequestId": "53042adf-3bf5-4d52-aa48-9b91ef2ccaa7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
中国站