查询结果、标识和错误¶
数字code=200成功封套下data字段如下。query_id用于状态/取消;statement_id用于成功保存结果读取/详情/画像,不能互换。
字段 |
类型 |
当前含义 |
|---|---|---|
query_id |
string |
执行记录ID,可省略 |
db_name |
string |
run为执行库;/query/result固定清空,应从describe读取库 |
statement_id |
string |
保存结果ID,失败时可为空 |
status |
string |
success、failed、running、killed等操作状态,不能只看外层HTTP |
err_msg |
string |
可读执行错误,可省略 |
offset / limit |
integer |
当前扫描位置与窗口 |
total |
integer |
本次返回行数,非全结果基数 |
rows_affected |
integer |
受影响行数 |
truncated |
boolean |
是否因结果行数窗口截断 |
columns |
array(对象数组) |
name、type;type为数据库列数据类型 |
result |
array(二维数组) |
每个单元格含String和Valid,Valid=false为SQL NULL |
empty_set |
object |
无行集合等反馈,msg为Query OK, N row(s) affected |
行列/empty_set未设置时可省略。原始DTO没有elapsed_ms字段,SDK中出现该属性默认值不能视为当前handler计时事实。HTTP SQL处理错误通常整数code/message,身份/通用回退可为字符串code/msg;WS业务错误另外为data.err,不混用。
SQL HTTP错误除权限提示等专门分支外可直接使用err.Error();结果不存在的当前文本为SQL editor result is not found。不能承诺所有message随界面语言本地化,客户端按code/状态识别错误,文本仅作可读说明。
API请求结果读取时默认limit=1000,正值未由该helper强制封顶;与run的首窗口算法分开。保存结果读取先确认属于当前用户的成功操作,再通过当前actor会话读取,不能把任意statement_id当公共下载能力。