diff --git a/README.md b/README.md index 86795697..58125e6a 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Workflow: [![Test by push](https://github.com/EdurtIO/dbm/actions/workflows/push-compile-test.yml/badge.svg)](https://github.com/EdurtIO/dbm/actions/workflows/push-compile-test.yml) -[![Publish New Release](https://github.com/EdurtIO/dbm/actions/workflows/upload-to-release.yml/badge.svg)](https://github.com/EdurtIO/dbm/actions/workflows/upload-to-release.yml) +[![Publish New Release](https://github.com/EdurtIO/dbm/actions/workflows/publish-release.yml/badge.svg)](https://github.com/EdurtIO/dbm/actions/workflows/upload-to-release.yml) [![Publish docs via GitHub Pages](https://github.com/EdurtIO/dbm/actions/workflows/publish-docs.yml/badge.svg)](https://github.com/EdurtIO/dbm/actions/workflows/publish-docs.yml) diff --git a/docs/docs/assets/images/query/clear_history.png b/docs/docs/assets/images/query/clear_history.png new file mode 100644 index 00000000..d43fc3ff Binary files /dev/null and b/docs/docs/assets/images/query/clear_history.png differ diff --git a/docs/docs/assets/images/query/query_ddl.png b/docs/docs/assets/images/query/query_ddl.png new file mode 100644 index 00000000..b9fbaf50 Binary files /dev/null and b/docs/docs/assets/images/query/query_ddl.png differ diff --git a/docs/docs/assets/images/query/query_error.png b/docs/docs/assets/images/query/query_error.png new file mode 100644 index 00000000..376ce195 Binary files /dev/null and b/docs/docs/assets/images/query/query_error.png differ diff --git a/docs/docs/assets/images/query/query_history.png b/docs/docs/assets/images/query/query_history.png new file mode 100644 index 00000000..8b5aa598 Binary files /dev/null and b/docs/docs/assets/images/query/query_history.png differ diff --git a/docs/docs/development/version/1.14.0-development.md b/docs/docs/development/version/1.14.0-development.md new file mode 100644 index 00000000..6a4c4c06 --- /dev/null +++ b/docs/docs/development/version/1.14.0-development.md @@ -0,0 +1,39 @@ +--- +template: overrides/main.html +icon: material/gesture-tap-button +--- + +DBM Version for `1.14.0` is development! + +!!! danger "Warning" + + The development version will not be released. If you need to experience, please pull the source code for local compilation. We will not release this version until the end of the final development work!!! + +#### Enhancement + +--- + + +#### UI + +--- + + +#### Optimize + +---- + + +#### Docs + +--- + + +#### Bug + +--- + + +#### Contributors (In no particular order) + +--- diff --git a/docs/docs/reference/query/query_history.md b/docs/docs/reference/query/query_history.md new file mode 100644 index 00000000..1c207a58 --- /dev/null +++ b/docs/docs/reference/query/query_history.md @@ -0,0 +1,40 @@ +--- +template: overrides/main.html +--- + +The query history function is mainly used to mark some of our query records for each data source. + +!!! warning + + Currently supports up to `100` query history, we will expand this function to support more data storage in the future! + +Move the mouse to the top menu `Query` and wait for the drop-down options to appear, click `History` to enter the query history interface, which is similar to the following page + +![Query History](/assets/images/query/query_history.png) + +On the top right side of the page we can see the button, which is used to clear all the query history, when clicked, the query history displayed here will be cleared! + +#### Field Description + +--- + +|Field| Meaning | +|---|----------------------------------------------------------------------------------| +|ID| The MD5 tag generated by this query is used to mark the uniqueness of this query | +|Server| The remote service tag (i.e. the data source) of the query call | +|State| The current query status, 1: query failed, 0: query successful | +|StartTime| Query the start timestamp | +|EndTime| Query the end timestamp | +|ElapsedTime| The total time spent on this query (in milliseconds) | + +!!! warning "Warning" + + In the list, we can see that we use special colors to highlight the records that failed to query + +:octicons-search-16: The button is used to view the SQL statement of this query + +![Query DDL](/assets/images/query/query_ddl.png) + +:warning: The button is used to view the error information after this execution fails, it only takes effect after the query fails + +![Query Error](/assets/images/query/query_error.png) diff --git a/docs/docs/reference/query/query_history.zh.md b/docs/docs/reference/query/query_history.zh.md new file mode 100644 index 00000000..2ac9676b --- /dev/null +++ b/docs/docs/reference/query/query_history.zh.md @@ -0,0 +1,40 @@ +--- +template: overrides/main.html +--- + +查询历史功能主要用于标记我们对每个数据源的一些查询记录. + +!!! warning + + 目前最多支持 `100` 条查询历史,后续我们会扩展该功能支持更多的数据存储! + +鼠标移向顶部菜单 `Query` 等待下拉选择项出来后, 点击 `History` 即可进入查询历史界面, 它类似于以下页面 + +![Query History](/assets/images/query/query_history.png) + +在页面顶部右侧我们可以看到 按钮, 它用于清理所有的查询历史, 当点击后此处展示的查询历史将被全部清空! + +#### 字段描述 + +--- + +|字段| 含义 | +|---|----------------------------| +|ID| 此次查询生成的MD5标记, 用于标记此次查询的唯一性 | +|Server| 查询调用的远程服务标记(即数据源) | +|State| 本次查询状态, 1: 查询失败, 0: 查询成功 | +|StartTime| 查询开始时间戳 | +|EndTime| 查询结束时间戳 | +|ElapsedTime| 本次查询总耗时时间(单位毫秒) | + +!!! warning "注意" + + 在列表中我们可以看到, 查询失败的记录我们使用特殊颜色进行高亮展示 + +:octicons-search-16: 按钮用于查看本次查询的SQL语句 + +![Query DDL](/assets/images/query/query_ddl.png) + +:warning: 按钮用于查看本次执行失败后的错误信息, 它只在查询失败后生效 + +![Query Error](/assets/images/query/query_error.png) diff --git a/docs/docs/reference/2.Get-Started-Query.md b/docs/docs/reference/query/query_query.md similarity index 100% rename from docs/docs/reference/2.Get-Started-Query.md rename to docs/docs/reference/query/query_query.md diff --git a/docs/docs/reference/2.Get-Started-Query.zh.md b/docs/docs/reference/query/query_query.zh.md similarity index 99% rename from docs/docs/reference/2.Get-Started-Query.zh.md rename to docs/docs/reference/query/query_query.zh.md index 69b7141c..ef9d998d 100644 --- a/docs/docs/reference/2.Get-Started-Query.zh.md +++ b/docs/docs/reference/query/query_query.zh.md @@ -7,6 +7,7 @@ template: overrides/main.html ##### 重定向查询 --- + 单击 顶部菜单栏中的菜单，出现下一个窗口 ![](http://images.edurt.io/2021/09/26/16326381423772.jpg) diff --git a/docs/docs/development/version/1.13.0-development.md b/docs/docs/release/1.13.0-20220329.md similarity index 82% rename from docs/docs/development/version/1.13.0-development.md rename to docs/docs/release/1.13.0-20220329.md index 2fce7e7e..0ba0b6a3 100644 --- a/docs/docs/development/version/1.13.0-development.md +++ b/docs/docs/release/1.13.0-20220329.md @@ -3,11 +3,9 @@ template: overrides/main.html icon: material/gesture-tap-button --- -DBM Version for `1.13.0` is development! +DBM Version for `1.13.0` is released! -!!! danger "Warning" - - The development version will not be released. If you need to experience, please pull the source code for local compilation. We will not release this version until the end of the final development work!!! +Release Time: `2022-03-29` #### Enhancement @@ -33,7 +31,7 @@ DBM Version for `1.13.0` is development! - Add the total number of rows returned from the query result ![Query result](/assets/images/1.13.0/query_result.png) - Supports highlighting of abnormal data in query history execution - ![img.png](/assets/images/1.13.0/abnormal_execution_highlighting.png) + ![img.png](/assets/images/query/query_history.png) #### Optimize @@ -50,6 +48,9 @@ DBM Version for `1.13.0` is development! --- +- Add install docs +- Add query history docs + #### Bug --- @@ -57,6 +58,7 @@ DBM Version for `1.13.0` is development! - Fix the problem of clearing multi-partition data - Fix run dev Last few GCs - Fixed editor state not resetting after cancel execution +- Fix README.md file script pointing error #### Contributors (In no particular order) diff --git a/docs/docs/release/1.13.0-20220329.zh.md b/docs/docs/release/1.13.0-20220329.zh.md new file mode 100644 index 00000000..ef0afe10 --- /dev/null +++ b/docs/docs/release/1.13.0-20220329.zh.md @@ -0,0 +1,67 @@ +--- +template: overrides/main.html +icon: material/gesture-tap-button +--- + +DBM `1.13.0` 版本发布! + +发布时间: `2022-03-29` + +#### 功能 (增强) + +--- + +- 元数据管理删除数据库支持快速输入数据库名称 + ![Quickly enter](/assets/images/1.13.0/quickly_enter.jpg) +- 添加 `EXPLAIN AST`, `EXPLAIN SYNTAX`, `EXPLAIN PLAN`, `EXPLAIN PIPELINE`, `EXPLAIN ESTIMATE`, `EXPLAIN TABLE OVERRIDE` + ![EXPLAIN ...](/assets/images/1.13.0/explain.jpg) +- 查询结果可导出为 CSV 文件 + ![Export](/assets/images/1.13.0/export.png) +- 支持删除数据库时删除表 + ![img.png](/assets/images/1.13.0/delete_table_on_database.png) + +#### UI + +--- + +- 元数据管理服务请求失败状态为红色 + ![Service failure](/assets/images/1.13.0/service_failure.png) +- 元数据管理菜单添加了要显示的子菜单数量 + ![Submenus count](/assets/images/1.13.0/submenus_count.png) +- 添加查询结果返回的总行数 + ![Query result](/assets/images/1.13.0/query_result.png) +- 支持查询历史执行中异常数据的高亮显示 + ![img.png](/assets/images/query/query_history.png) + +#### 优化 + +---- + +- 优化元数据管理删除数据列 + ![img.png](/assets/images/1.13.0/delete_column.png) +- 优化查询结果展示表 + ![Table](/assets/images/1.13.0/table.png) +- 删除数据分区的优化数据排列 + ![img.png](/assets/images/1.13.0/clean_partitions.png) + +#### 文档 + +--- + +- 添加安装文档 +- 添加查询历史文档 + +#### Bug + +--- + +- 修复清除多分区数据的问题 +- 修复 run dev Last few GCs +- 修复了取消执行后编辑器状态不重置的问题 +- 修复 README.md 文件脚本指向错误 + +#### 贡献者（排名不分先后） + +--- + +- @qianmoQ diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 4e5e6703..01478f2d 100755 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -112,6 +112,8 @@ markdown_extensions: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg +use_directory_urls: false + plugins: - search - i18n: @@ -128,6 +130,8 @@ plugins: Installation: 安装 Datasource: 数据源 Query: 查询 + History: 历史 + Management: 管理 Monitor: 监控 Processor: 进程 Release Note: 发布日志 @@ -139,13 +143,17 @@ nav: - Home: index.md - Getting started: - Installation: reference/get_started/install.md - - Datasource: reference/get_started_datasource.md - - Query: reference/2.Get-Started-Query.md + - Query: + - Query: reference/query/query_query.md + - History: reference/query/query_history.md + - Management: + - Datasource: reference/get_started_datasource.md - Monitor: - - Processor: reference/Monitor-Processor.md + - Processor: reference/Monitor-Processor.md - Release Note: - - Development Version: development/version/1.13.0-development.md - - 1.12.0 (latest): release/1.12.0-20220318.md + - Development Version: development/version/1.14.0-development.md + - 1.13.0 (latest): release/1.13.0-20220329.md + - 1.12.0: release/1.12.0-20220318.md - 1.11.0: release/1.11.0-20220222.md - 1.10.0: release/1.10.0-20220127.md - 1.9.0: release/1.9.0-20211130.md diff --git a/electron-builder.yml b/electron-builder.yml index cf09c7f6..e8f4fe3f 100644 --- a/electron-builder.yml +++ b/electron-builder.yml @@ -20,6 +20,7 @@ releaseInfo: --- - Add install docs + - Add query history docs #### Optimize @@ -36,6 +37,7 @@ releaseInfo: - Fix the problem of clearing multi-partition data - Fix run dev Last few GCs - Fixed editor state not resetting after cancel execution + - Fix README.md file script pointing error #### UI