Merge pull request #225 from FederatedAI/develop-1.8.0

Develop 1.8.0
FederatedAI · Apr 15, 2022 · e138ea4 · e138ea4
2 parents c51a051 + 8468b9f
commit e138ea4
Show file tree

Hide file tree

Showing 31 changed files with 482 additions and 418 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,3 +1,9 @@
+# Release 1.8.0
+## Major Features and Improvements
+Optimize the model migration function to reduce user operation steps;
+Add version compatibility check in component center to support multiple parties to use different versions;
+Add data table disable/enable function, and support batch delete disable table
+
 # Release 1.7.2
 ## Major Features and Improvements
 * Separate the base connection address of the data storage table from the data table information, and compatible with historical versions;

diff --git a/doc/cli/table.md b/doc/cli/table.md
@@ -8,19 +8,18 @@ Query information about the fate table (real storage address, number, schema, et
 flow table info [options]
 ```
 
-**Options**
+**options** 
 
-| parameter name | required | type | description
-| :-------- | :--- | :----- | -------------- |
-| table-name | yes | string | fate table name |
-| namespace | yes | string | fate table namespace |
-
-**return parameters** 
+| parameters    | short-format  | long-format | required  | type   | description    |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| table_name | `-t`   |`--table-name`   |yes   | string | fate table name     |
+| namespace | `-n`   |`--namespace`   | yes |string   | fate table namespace |
 
+**returns**
 | parameter name | type | description |
 | :------ | :----- | -------- |
 | retcode | int | return code |
-| retmsg | string | return message |
+| retmsg | string | return information |
 | data | object | return data |
 
 Sample
@@ -56,14 +55,14 @@ You can delete table data with table delete
 flow table delete [options]
 ```
 
-**Options**
+**Options** 
 
-| parameter name | required | type | description |
-| :-------- | :--- | :----- | -------------- |
-| table-name | yes | string | fate table name |
-| namespace | yes | string | fate table namespace |
+| parameters    | short-format  | long-format | required  | type   | description    |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| table_name | `-t`   |`--table-name`   |yes   | string | fate table name     |
+| namespace | `-n`   |`--namespace`   | yes |string   | fate table namespace |
 
-**return parameters** 
+**returns**
 
 | parameter name | type | description |
 | :------ | :----- | -------- |
@@ -92,13 +91,17 @@ Real storage addresses can be mapped to fate storage tables via table bind
 flow table bind [options]
 ```
 
-Note: conf_path is the parameter path, the specific parameters are as follows
+**options** 
 
-**Options**
+| parameters | short format | long format | required | type | description |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| conf_path | `-c` | `--conf-path` | yes | string | configuration-path |
 
-| parameter name | required | type | description |
+Note: conf_path is the parameter path, the specific parameters are as follows
+
+| parameter_name | required | type | description |
 | :------------- | :--- | :----- | ------------------------------------- |
-| table-name | yes | string | fate table name |
+| name | yes | string | fate table name |
 | namespace | yes | string | fate table namespace |
 | engine | yes | string | storage engine, supports "HDFS", "MYSQL", "PATH" |
 | yes | object | real storage address |
@@ -108,7 +111,7 @@ Note: conf_path is the parameter path, the specific parameters are as follows
 | id_column | no | string | id field |
 | feature_column | no | array | feature_field |
 
-**Example** 
+**Sample** 
 
 - hdfs
 
@@ -162,12 +165,49 @@ Note: conf_path is the parameter path, the specific parameters are as follows
     }
 }
 ```
-**return parameters** 
+**return**
 
 | parameter name | type | description |
 | :------ | :----- | -------- |
 | retcode | int | return code |
-| retmsg | string | return message |
+| retmsg | string | return information |
+| data | object | return data |
+
+Sample
+
+```json
+{
+    "data": {
+        "namespace": "xxx",
+        "table_name": "xxx"
+    },
+    "retcode": 0,
+    "retmsg": "success"
+}
+```
+
+
+### disable
+
+Tables can be made unavailable by table disable
+
+```bash
+flow table disable [options]
+```
+
+**Options** 
+
+| parameters | short-format | long-format | required | type | description |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| table_name | `-t` | `--table-name` | yes | string | fate table name |
+| namespace | `-n` |`--namespace` | yes |string | fate table namespace |
+
+**returns**
+
+| parameter name | type | description |
+| :------ | :----- | -------- |
+| retcode | int | return code |
+| retmsg | string | return information |
 | data | object | return data |
 
 Sample
@@ -181,4 +221,80 @@ Sample
     "retcode": 0,
     "retmsg": "success"
 }
-```
+```
+
+### enable
+
+Tables can be made available with table enable
+
+```bash
+flow table enable [options]
+```
+
+**Options** 
+
+| parameters | short-format | long-format | required | type | description |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| table_name | `-t` | `--table-name` | yes | string | fate table name |
+| namespace | `-n` |`--namespace` | yes |string | fate table namespace |
+
+
+**returns**
+
+| parameter name | type | description |
+| :------ | :----- | -------- |
+| retcode | int | return code |
+| retmsg | string | return information |
+| data | object | return data |
+
+Sample
+
+```json
+{
+    "data": [{
+        "namespace": "xxx",
+        "table_name": "xxx"
+    }],
+    "retcode": 0,
+    "retmsg": "success"
+}
+```
+
+### disable-delete
+
+Tables that are currently unavailable can be deleted with disable-delete
+
+```bash
+flow table disable-delete 
+```
+
+
+**return**
+
+| parameter name | type | description |
+| :------ | :----- | -------- |
+| retcode | int | return-code |
+| retmsg | string | return information |
+| data | object | return data |
+
+Sample
+
+```json
+{
+  "data": [
+    {
+      "namespace": "xxx",
+      "table_name": "xxx"
+    },
+    {
+      "namespace": "xxx",
+      "table_name": "xxx"
+    }
+  ],
+  "retcode": 0,
+  "retmsg": "success"
+}
+```
+
+
+
diff --git a/doc/cli/table.zh.md b/doc/cli/table.zh.md
@@ -10,10 +10,10 @@ flow table info [options]
 
 **选项** 
 
-| 参数名    | 必选 | 类型   | 说明           |
-| :-------- | :--- | :----- | -------------- |
-| table-name      | 是   | string | fate表名       |
-| namespace | 是   | string | fate表命名空间 |
+| 参数    | 短格式 | 长格式 | 必选 | 类型   | 说明           |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| table_name | `-t`   |`--table-name`   |是   | string | fate表名       |
+| namespace | `-n`   |`--namespace`   | 是 |string   | fate表命名空间 |
 
 **返回**
 
@@ -58,10 +58,10 @@ flow table delete [options]
 
 **选项** 
 
-| 参数名    | 必选 | 类型   | 说明           |
-| :-------- | :--- | :----- | -------------- |
-| table-name      | 是   | string | fate表名       |
-| namespace | 是   | string | fate表命名空间 |
+| 参数    | 短格式 | 长格式 | 必选 | 类型   | 说明           |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| table_name | `-t`   |`--table-name`   |是   | string | fate表名       |
+| namespace | `-n`   |`--namespace`   | 是 |string   | fate表命名空间 |
 
 **返回**
 
@@ -92,13 +92,17 @@ flow table delete [options]
 flow table bind [options]
 ```
 
-注: conf_path为参数路径，具体参数如下
-
 **选项** 
 
+| 参数    | 短格式 | 长格式 | 必选 | 类型   | 说明           |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| conf_path | `-c`   |`--conf-path`   |是   | string | 配置路径  |
+
+注: conf_path为参数路径，具体参数如下
+
 | 参数名         | 必选 | 类型   | 说明                                  |
 | :------------- | :--- | :----- | ------------------------------------- |
-| table-name           | 是   | string | fate表名                              |
+| name           | 是   | string | fate表名                              |
 | namespace      | 是   | string | fate表命名空间                        |
 | engine         | 是   | string | 存储引擎, 支持"HDFS", "MYSQL", "PATH" |
 | adress         | 是   | object | 真实存储地址                          |
@@ -181,4 +185,114 @@ flow table bind [options]
     "retcode": 0,
     "retmsg": "success"
 }
+```
+
+
+### disable
+
+可通过table disable将表置为不可用状态
+
+```bash
+flow table disable [options]
+```
+
+**选项** 
+
+| 参数    | 短格式 | 长格式 | 必选 | 类型   | 说明           |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| table_name | `-t`   |`--table-name`   |是   | string | fate表名       |
+| namespace | `-n`   |`--namespace`   | 是 |string   | fate表命名空间 |
+
+**返回**
+
+| 参数名  | 类型   | 说明     |
+| :------ | :----- | -------- |
+| retcode | int    | 返回码   |
+| retmsg  | string | 返回信息 |
+| data    | object | 返回数据 |
+
+样例
+
+```json
+{
+    "data": {
+        "namespace": "xxx",
+        "table_name": "xxx"
+    },
+    "retcode": 0,
+    "retmsg": "success"
+}
+```
+
+### enable
+
+可通过table enable将表置为可用状态
+
+```bash
+flow table enable [options]
+```
+
+**选项** 
+
+| 参数    | 短格式 | 长格式 | 必选 | 类型   | 说明           |
+| :-------- | :--- | :--- | :--- | :----- | -------------- |
+| table_name | `-t`   |`--table-name`   |是   | string | fate表名       |
+| namespace | `-n`   |`--namespace`   | 是 |string   | fate表命名空间 |
+
+
+**返回**
+
+| 参数名  | 类型   | 说明     |
+| :------ | :----- | -------- |
+| retcode | int    | 返回码   |
+| retmsg  | string | 返回信息 |
+| data    | object | 返回数据 |
+
+样例
+
+```json
+{
+    "data": [{
+        "namespace": "xxx",
+        "table_name": "xxx"
+    }],
+    "retcode": 0,
+    "retmsg": "success"
+}
+```
+
+### disable-delete
+
+可通过disable-delete删除当前不可用的表
+
+```bash
+flow table disable-delete 
+```
+
+
+**返回**
+
+| 参数名  | 类型   | 说明     |
+| :------ | :----- | -------- |
+| retcode | int    | 返回码   |
+| retmsg  | string | 返回信息 |
+| data    | object | 返回数据 |
+
+样例
+
+```json
+{
+  "data": [
+    {
+      "namespace": "xxx",
+      "table_name": "xxx"
+    },
+    {
+      "namespace": "xxx",
+      "table_name": "xxx"
+    }
+  ],
+  "retcode": 0,
+  "retmsg": "success"
+}
 ```