Browse Source

fix:修改export文档,格式化readme

master
Morning.Chen 11 months ago
parent
commit
dbdf3c6851
  1. 36
      README.md

36
README.md

@ -47,8 +47,12 @@ String tableId = operation.createTable("HelloTable", "#分组Id(可选)");
### 更新表数据
数据的格式采用csv文件存储,格式如下,假设文件名为data.csv,其内容为(其中第一行是表头,第一行之后是表数据):
数据的格式采用csv文件存储,格式如下:
假设文件名为data.csv,其内容为(其中第一行是表头,第一行之后是表数据)
表头行字段中可以将字段类型(目前支持字符串文本string、日期或时间date、数字类型number(不区分大小写))写在字段后,用#分隔,不带类型则默认为文本
主键字段在末尾添加#key(不区分大小写),可与字段类型连用。(主键唯一,多主键可以自行拼接成一个新的主键。)
```
@ -65,6 +69,7 @@ String tableId = operation.createTable("HelloTable", "#分组Id(可选)");
**踩坑记录:**
**1、数据中可能含有换行符的,转换数据时需要全局处理类似符号,否则可能导致格式错误**
**2、数据中可能含有英文引号的,注意不要和数据的引号冲突**
**注意:** 当前默认为全量覆盖表数据,如需切换到增量更新,参考接口/api/v1/datasource/table/modify。
@ -220,11 +225,16 @@ operation.reset();
请求类型:POST
请求参数: ``` {"tableName":"#表名","groupId":"#分组Id(可选)","updateMode":1(可选1,2,3或不上传默认为1)} ```
说明:
updateMode: 更新方式
1:全量更新:用全新的数据替换旧的全部数据;
2:增量更新:新增新数据,旧数据不受影响;
3:替换更新:(必须声明主键)按主键替换相同主键的数据,之前没有的数据直接新增。(主键处理见csv文件说明)
1:全量更新:用全新的数据替换旧的全部数据(数据可以做到新增、修改、删除,但是耗费资源较多,表数据量大时可能会比较慢,表数据量小时推荐使用,每次替换大规模数据时推荐使用);
2:增量更新:新增新数据,旧数据不受影响(数据无法更新、删除,只能新增,记录历史数据无需修改和删除时推荐使用,效率最高);
3:替换更新:(必须声明主键)按主键替换相同主键的数据,之前没有的数据直接新增。(主键处理见csv文件说明)(数据只能替换、新增,不能删除,每次更新会修改少量数据时推荐使用)
返回值:
```json
@ -253,7 +263,9 @@ updateMode: 更新方式
**注意:获取数据上传地址后,使用put请求调用,csv文件使用二进制上传**
#### 标记表数据已上传完成
## 注意:创建表的动作是异步处理的,因此有可能存在调用标记数据上传完成接口时表未创建完成的情况,推荐在调用前等待3秒
请求地址:```/api/v1/datasource/table/upload/finish```
请求类型:POST
@ -317,7 +329,7 @@ updateMode: 更新方式
请求类型:POST
请求参数: ``` {"tableId":"#表Id"} ```
请求参数: ``` {"tableId":"#表Id", "type": 1(说明:可不传,不传时默认为0,导出csv文件,传1则导出excel文件)} ```
返回值:
```json
@ -328,12 +340,23 @@ updateMode: 更新方式
}
```
注:
1、导出只可以导出分析表(数据源表、仪表板、故事板不支持);
2、导出超过一万行的表时需要消耗您的导出次数,如您的可导出次数为0,请联系管理员购买;
3、使用自动化导出导致花费预想之外的费用(例如代码问题导致连续导出了几十次),如果是用户自己使用不当导致,不可退款;
4、导出失败不会消耗导出次数。
#### 批量导出分析表数据
请求地址:```/api/v1/export/batch```
请求类型:POST
请求参数: ``` {"tableIds":["#表a Id", "#表b Id", ...]} ```
请求参数: ``` {"tableIds":["#表a Id", "#表b Id", ...], "type": 1(说明:可不传,不传时默认为0,导出csv文件,传1则导出excel文件)} ```
返回值:
```json
@ -343,6 +366,7 @@ updateMode: 更新方式
"success":true
}
```
注: 同/export接口注意事项
#### 获取店铺信息
请求地址:```/api/v1/store/info```

Loading…
Cancel
Save