diff --git a/README.md b/README.md index 67e3006..0af763f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,18 @@ # API数据源使用示例 -**注意:** 数据源表的数据更新的时候,会根据实际情况启动使用该数据源表的分析表的更新,最小更新间隔为1个小时。 +**支持版本:** 仅企业版支持API数据源。 -*举例:当10点更新了一张数据源表,当表数据写入完成后,会立即更新到九数云中,如果10点10分再次更新这张表,则需要在11点的时候,才会将最新的数据更新到九数云中,13点15的时候再次更新这张表的数据,则在数据写入完成后,会立即更新到九数云中。* +**更新间隔:** 数据源表的数据更新的时候,会根据实际情况启动使用该数据源表的分析表的更新,最小更新间隔为1个小时。*举例:当10点更新了一张数据源表,当表数据写入完成后,会立即更新到九数云中,如果10点10分再次更新这张表,则需要在11点的时候,才会将最新的数据更新到九数云中,13点15的时候再次更新这张表的数据,由于在这之前的1个小时没有任何的更新,因此在数据写入完成后,会立即更新到九数云中。* + +## accessKeyId和accessKeySecret的获取 +参考帮助文档:[获取accessKeyId和accessKeySecret](https://help.fanruan.com/jiushuyun/doc-view-140.html) ## 调用示例代码 +```Authentication```表示的是传入accessKeyId和accessKeySecret参数,获取临时令牌的操作,可以自行调用其中的RestApi,不是必须使用该类。 + +```DatasourceOperation```表示的是可以对API数据源进行的若干操作的集合,可以自行调用其中的RestApi,不是必须使用该类。 + ### 开启API数据源 ```java @@ -36,6 +43,17 @@ String tableId = operation.createTable("HelloTable", "#分组Id(可选)"); ### 更新表数据 +数据的格式采用csv文件存储,格式如下,假设文件名为data.csv,其内容为(其中第一行是表头,第一行之后是表数据): + +``` +"合同签约时间(Year Month Day)","城市","国家","客户名称","省份","回款金额","合同金额" +"18/1/2016","杭州市","中国","浙江臻善科技有限公司","浙江省","1200000","1200000" +"1/8/2016","郑州市","中国","杭州明佑电子有限公司","河南省","100800","100800" +"1/4/2016","西安市","中国","西北工业大学","陕西省","430000","430000" +``` + +**注意:** 当前暂时不支持追加数据,仅支持全部替换数据。 + ```java Authentication authentication = new Authentication("#key", "#secret"); DatasourceOperation operation = new DatasourceOperation(authentication); @@ -145,7 +163,7 @@ operation.reset(); { "success": true, "code": "200", - "data": [{"id":"#tableId", "name": "#tableName"}] + "data": [{"id":"#tableId","name":"#tableName"}] } ``` @@ -154,7 +172,7 @@ operation.reset(); 请求类型:POST -请求参数: ``` {"groupId":"#分组Id", "groupName":"#新的分组名"} ``` +请求参数: ``` {"groupId":"#分组Id","groupName":"#新的分组名"} ``` 返回值: ```json @@ -170,7 +188,7 @@ operation.reset(); 请求类型:POST -请求参数: ``` {"tableName":"#表名", "groupId":"#分组Id(可选)"} ``` +请求参数: ``` {"tableName":"#表名","groupId":"#分组Id(可选)"} ``` 返回值: ```json @@ -212,12 +230,12 @@ operation.reset(); } ``` -#### 修改数据源表名(暂未启用) +#### 修改数据源表名 请求地址:```/api/v1/datasource/table/modify``` 请求类型:POST -请求参数: ``` {"tableId":"#表Id", "tableName":"#新的表名"} ``` +请求参数: ``` {"tableId":"#表Id","tableName":"#新的表名"} ``` 返回值: ```json diff --git a/screenshots/api_datasource_effect.png b/screenshots/api_datasource_effect.png index 07a5220..bbc5ff6 100644 Binary files a/screenshots/api_datasource_effect.png and b/screenshots/api_datasource_effect.png differ diff --git a/src/main/java/com/fanruan/hihidata/datasource/server/ProjectConstants.java b/src/main/java/com/fanruan/hihidata/datasource/server/ProjectConstants.java index 9940774..af18b72 100644 --- a/src/main/java/com/fanruan/hihidata/datasource/server/ProjectConstants.java +++ b/src/main/java/com/fanruan/hihidata/datasource/server/ProjectConstants.java @@ -6,5 +6,5 @@ package com.fanruan.hihidata.datasource.server; */ public class ProjectConstants { - public static final String BASE_URI = "https://test.jiushuyun.com/decision"; + public static final String BASE_URI = "https://work.jiushuyun.com/decision"; }