Skip to content

Commit b1a3e3e

Browse files
authored
Merge pull request #5 from morningman/doris-ui-doc2
Check all rest apis and implement docs
2 parents cf13cac + 671843a commit b1a3e3e

46 files changed

Lines changed: 1158 additions & 462 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/en/administrator-guide/colocation-join.md‎

Lines changed: 13 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -359,58 +359,19 @@ The API is implemented on the FE side and accessed using `fe_host: fe_http_port`
359359
Return the internal Colocation info in JSON format:
360360
361361
{
362-
"colocate_meta": {
363-
"groupName2Id": {
364-
"g1": {
365-
"dbId": 10005,
366-
"grpId": 10008
367-
}
368-
},
369-
"group2Tables": {},
370-
"table2Group": {
371-
"10007": {
372-
"dbId": 10005,
373-
"grpId": 10008
374-
},
375-
"10040": {
376-
"dbId": 10005,
377-
"grpId": 10008
378-
}
379-
},
380-
"group2Schema": {
381-
"10005.10008": {
382-
"groupId": {
383-
"dbId": 10005,
384-
"grpId": 10008
385-
},
386-
"distributionColTypes": [{
387-
"type": "INT",
388-
"len": -1,
389-
"isAssignedStrLenInColDefinition": false,
390-
"precision": 0,
391-
"scale": 0
392-
}],
393-
"bucketsNum": 10,
394-
"replicationNum": 2
395-
}
396-
},
397-
"group2BackendsPerBucketSeq": {
398-
"10005.10008": [
399-
[10004, 10002],
400-
[10003, 10002],
401-
[10002, 10004],
402-
[10003, 10002],
403-
[10002, 10004],
404-
[10003, 10002],
405-
[10003, 10004],
406-
[10003, 10004],
407-
[10003, 10004],
408-
[10002, 10004]
409-
]
410-
},
411-
"unstableGroups": []
362+
"msg": "success",
363+
"code": 0,
364+
"data": {
365+
"infos": [
366+
["10003.12002", "10003_group1", "10037, 10043", "1", "1", "int(11)", "true"]
367+
],
368+
"unstableGroupIds": [],
369+
"allGroupIds": [{
370+
"dbId": 10003,
371+
"grpId": 12002
372+
}]
412373
},
413-
"status": "OK"
374+
"count": 0
414375
}
415376
```
416377
2. Mark Group as Stable or Unstable
@@ -436,7 +397,7 @@ The API is implemented on the FE side and accessed using `fe_host: fe_http_port`
436397
The interface can force the number distribution of a group.
437398
438399
```
439-
POST /api/colocate/bucketseq?db_id=10005&group_id= 10008
400+
POST /api/colocate/bucketseq?db_id=10005&group_id=10008
440401
441402
Body:
442403
[[10004,10002],[10003,10002],[10002,10004],[10003,10002],[10002,10004],[10003,10002],[10003,10004],[10003,10004],[10003,10004],[10002,10004]]

‎docs/zh-CN/administrator-guide/colocation-join.md‎

Lines changed: 14 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -358,58 +358,19 @@ Doris 提供了几个和 Colocation Join 有关的 HTTP Restful API,用于查
358358
返回以 Json 格式表示内部 Colocation 信息。
359359
360360
{
361-
"colocate_meta": {
362-
"groupName2Id": {
363-
"g1": {
364-
"dbId": 10005,
365-
"grpId": 10008
366-
}
367-
},
368-
"group2Tables": {},
369-
"table2Group": {
370-
"10007": {
371-
"dbId": 10005,
372-
"grpId": 10008
373-
},
374-
"10040": {
375-
"dbId": 10005,
376-
"grpId": 10008
377-
}
378-
},
379-
"group2Schema": {
380-
"10005.10008": {
381-
"groupId": {
382-
"dbId": 10005,
383-
"grpId": 10008
384-
},
385-
"distributionColTypes": [{
386-
"type": "INT",
387-
"len": -1,
388-
"isAssignedStrLenInColDefinition": false,
389-
"precision": 0,
390-
"scale": 0
391-
}],
392-
"bucketsNum": 10,
393-
"replicationNum": 2
394-
}
395-
},
396-
"group2BackendsPerBucketSeq": {
397-
"10005.10008": [
398-
[10004, 10002],
399-
[10003, 10002],
400-
[10002, 10004],
401-
[10003, 10002],
402-
[10002, 10004],
403-
[10003, 10002],
404-
[10003, 10004],
405-
[10003, 10004],
406-
[10003, 10004],
407-
[10002, 10004]
408-
]
409-
},
410-
"unstableGroups": []
361+
"msg": "success",
362+
"code": 0,
363+
"data": {
364+
"infos": [
365+
["10003.12002", "10003_group1", "10037, 10043", "1", "1", "int(11)", "true"]
366+
],
367+
"unstableGroupIds": [],
368+
"allGroupIds": [{
369+
"dbId": 10003,
370+
"grpId": 12002
371+
}]
411372
},
412-
"status": "OK"
373+
"count": 0
413374
}
414375
```
415376
@@ -436,7 +397,7 @@ Doris 提供了几个和 Colocation Join 有关的 HTTP Restful API,用于查
436397
该接口可以强制设置某一 Group 的数分布。
437398
438399
```
439-
POST /api/colocate/bucketseq?db_id=10005&group_id= 10008
400+
POST /api/colocate/bucketseq?db_id=10005&group_id=10008
440401
441402
Body:
442403
[[10004,10002],[10003,10002],[10002,10004],[10003,10002],[10002,10004],[10003,10002],[10003,10004],[10003,10004],[10003,10004],[10002,10004]]
@@ -445,4 +406,4 @@ Doris 提供了几个和 Colocation Join 有关的 HTTP Restful API,用于查
445406
```
446407
其中 Body 是以嵌套数组表示的 BucketsSequence 以及每个 Bucket 中分片分布所在 BE 的 id。
447408
448-
注意,使用该命令,可能需要将 FE 的配置 `disable_colocate_relocate` 和 `disable_colocate_balance` 设为 true。即关闭系统自动的 Colocation 副本修复和均衡。否则可能在修改后,会被系统自动重置。
409+
注意,使用该命令,可能需要将 FE 的配置 `disable_colocate_relocate` 和 `disable_colocate_balance` 设为 true。即关闭系统自动的 Colocation 副本修复和均衡。否则可能在修改后,会被系统自动重置。

‎docs/zh-CN/administrator-guide/http-actions/fe/bootstrap-action.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ under the License.
5959
```
6060
{
6161
"msg": "OK",
62-
"code": 200,
62+
"code": 0,
6363
"data": null,
6464
"count": 0
6565
}
@@ -72,7 +72,7 @@ under the License.
7272
```
7373
{
7474
"msg": "OK",
75-
"code": 200,
75+
"code": 0,
7676
"data": {
7777
"queryPort": 9030,
7878
"rpcPort": 9020,
@@ -96,7 +96,7 @@ under the License.
9696
Response:
9797
{
9898
"msg": "OK",
99-
"code": 200,
99+
"code": 0,
100100
"data": null,
101101
"count": 0
102102
}
@@ -110,7 +110,7 @@ under the License.
110110
Response:
111111
{
112112
"msg": "OK",
113-
"code": 200,
113+
"code": 0,
114114
"data": {
115115
"queryPort": 9030,
116116
"rpcPort": 9020,

‎docs/zh-CN/administrator-guide/http-actions/fe/cancel-load.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ under the License.
5757
```
5858
{
5959
"msg": "OK",
60-
"code": 200,
60+
"code": 0,
6161
"data": null,
6262
"count": 0
6363
}
@@ -67,7 +67,7 @@ under the License.
6767
6868
```
6969
{
70-
"msg": "Error msg",
70+
"msg": "Error msg...",
7171
"code": 1,
7272
"data": null,
7373
"count": 0
@@ -84,7 +84,7 @@ under the License.
8484
Response:
8585
{
8686
"msg": "OK",
87-
"code": 200,
87+
"code": 0,
8888
"data": null,
8989
"count": 0
9090
}

‎docs/zh-CN/administrator-guide/http-actions/fe/check-decommission-action.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ TODO
5757
```
5858
{
5959
"msg": "OK",
60-
"code": 200,
60+
"code": 0,
6161
"data": ["192.168.10.11:9050", "192.168.10.11:9050"],
6262
"count": 0
6363
}
@@ -73,7 +73,7 @@ TODO
7373
Response:
7474
{
7575
"msg": "OK",
76-
"code": 200,
76+
"code": 0,
7777
"data": ["192.168.10.11:9050"],
7878
"count": 0
7979
}

‎docs/zh-CN/administrator-guide/http-actions/fe/check-storage-type-action.md‎

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,15 @@ under the License.
3232

3333
## Description
3434

35-
用于检查指定数据库下的表的存储格式是行存还是列存
35+
用于检查指定数据库下的表的存储格式否是行存格式。(行存格式已废弃)
3636

3737
## Path parameters
3838

3939
无
4040

4141
## Query parameters
4242

43-
* db
43+
* `db`
4444

4545
指定数据库
4646

@@ -50,8 +50,35 @@ under the License.
5050

5151
## Response
5252

53-
TODO
54-
53+
```
54+
{
55+
"msg": "success",
56+
"code": 0,
57+
"data": {
58+
"tbl2": {},
59+
"tbl1": {}
60+
},
61+
"count": 0
62+
}
63+
```
64+
65+
如果表名后由内容,则会显示存储格式为行存的 base 或者 rollup 表。
66+
5567
## Examples
5668

57-
TODO
69+
1. 检查指定数据库下表的存储格式是否为行存
70+
71+
```
72+
GET /api/_check_storagetype
73+
74+
Response:
75+
{
76+
"msg": "success",
77+
"code": 0,
78+
"data": {
79+
"tbl2": {},
80+
"tbl1": {}
81+
},
82+
"count": 0
83+
}
84+
```

‎docs/zh-CN/administrator-guide/http-actions/fe/connection-action.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ connection id 可以通过 MySQL 命令 `show processlist;` 中的 id 列查看
5555
```
5656
{
5757
"msg": "OK",
58-
"code": 200,
58+
"code": 0,
5959
"data": {
6060
"query_id": "b52513ce3f0841ca-9cb4a96a268f2dba"
6161
},
@@ -73,7 +73,7 @@ connection id 可以通过 MySQL 命令 `show processlist;` 中的 id 列查看
7373
Response:
7474
{
7575
"msg": "OK",
76-
"code": 200,
76+
"code": 0,
7777
"data": {
7878
"query_id": "b52513ce3f0841ca-9cb4a96a268f2dba"
7979
},

‎docs/zh-CN/administrator-guide/http-actions/fe/get-ddl-stmt-action.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ under the License.
5757
```
5858
{
5959
"msg": "OK",
60-
"code": 200,
60+
"code": 0,
6161
"data": {
6262
"create_partition": ["ALTER TABLE `tbl1` ADD PARTITION ..."],
6363
"create_table": ["CREATE TABLE `tbl1` ...],
@@ -77,7 +77,7 @@ under the License.
7777
Response
7878
{
7979
"msg": "OK",
80-
"code": 200,
80+
"code": 0,
8181
"data": {
8282
"create_partition": [],
8383
"create_table": ["CREATE TABLE `tbl1` (\n `k1` int(11) NULL COMMENT \"\",\n `k2` int(11) NULL COMMENT \"\"\n) ENGINE=OLAP\nDUPLICATE KEY(`k1`, `k2`)\nCOMMENT \"OLAP\"\nDISTRIBUTED BY HASH(`k1`) BUCKETS 1\nPROPERTIES (\n\"replication_num\" = \"1\",\n\"version_info\" = \"1,0\",\n\"in_memory\" = \"false\",\n\"storage_format\" = \"DEFAULT\"\n);"],

0 commit comments

Comments
 (0)