Table Schema Action
Request
GET /api/<db>/<table>/_schema
Description
用于获取指定表的表结构信息。该接口目前用于 Spark/Flink Doris Connector 中,获取 Doris 的表结构信息。
Path parameters
<db>
指定数据库
<table>
指定表
Query parameters
无
Request body
无
Response
- http 接口返回如下:
{
"msg": "success",
"code": 0,
"data": {
"properties": [{
"type": "INT",
"name": "k1",
"comment": "",
"aggregation_type":""
}, {
"type": "INT",
"name": "k2",
"comment": "",
"aggregation_type":"MAX"
}],
"keysType":UNIQUE_KEYS,
"status": 200
},
"count": 0
}
- http v2 接口返回如下:
{
"msg": "success",
"code": 0,
"data": {
"properties": [{
"type": "INT",
"name": "k1",
"comment": ""
}, {
"type": "INT",
"name": "k2",
"comment": ""
}],
"keysType":UNIQUE_KEYS,
"status": 200
},
"count": 0
}
注意:区别为http
方式比http v2
方式多返回aggregation_type
字段,http v2
开启是通过enable_http_server_v2
进行设置,具体参数说明详见fe 参数设置
Examples
通过 http 获取指定表的表结构信息。
GET /api/db1/tbl1/_schema
Response:
{
"msg": "success",
"code": 0,
"data": {
"properties": [{
"type": "INT",
"name": "k1",
"comment": "",
"aggregation_type":""
}, {
"type": "INT",
"name": "k2",
"comment": "",
"aggregation_type":"MAX"
}],
"keysType":UNIQUE_KEYS,
"status": 200
},
"count": 0
}通过 http v2 获取指定表的表结构信息。
GET /api/db1/tbl1/_schema
Response:
{
"msg": "success",
"code": 0,
"data": {
"properties": [{
"type": "INT",
"name": "k1",
"comment": ""
}, {
"type": "INT",
"name": "k2",
"comment": ""
}],
"keysType":UNIQUE_KEYS,
"status": 200
},
"count": 0
}