chore: 新增升级指南,更新jdbc配置

Author: scottsut

source/_data/sidebar.yml

@@ -18,5 +18,6 @@ docs:
     chart_plugin: chart_plugin.html
     jdbc: jdbc.html
   others:
+    upgrade: upgrade.html
     tenant_management_mode: tenant-management-mode.html
     migration: migration.html

source/docs/jdbc.md

@@ -8,36 +8,42 @@ datart release package 中默认只提供了 `MySQL 8.0` 的 JDBC 驱动文件
 
 准备对应数据库的 JDBC 驱动 jar 包，放到服务端 `lib/` 路径下，重启服务即可生效
 
-## 2. 扩展JDBC数据源
+## 2. 扩展 JDBC 数据源
 
-datart并没有穷举所有的JDBC数据库类型，这个做法也有一定难度。对于不在默认支持列表中的数据库，可通过简单几步配置就可以支持。
+datart 并没有穷举所有的 JDBC 数据库类型，这个做法也有一定难度。对于不在默认支持列表中的数据库，可通过简单几步配置就可以支持。
 
-+ 找到 `conf/jdbc-driver-ext.yml` 文件，添加关键配置，然后重启程序。
-+ 以下以添加 `impala` 为例，在`conf/jdbc-driver-ext.yml`中添加以下配置。
+- 找到 `conf/jdbc-driver-ext.yml` 文件，添加关键配置，然后重启程序。
+- 以下以添加 `impala` 为例，在`conf/jdbc-driver-ext.yml`中添加以下配置。
 
 ```yaml
 IMPALA:
   db-type: "impala"
   name: "impala"
-  literal-quote: "'"
-  identifier-quote: "`"
-#  literal-end-quote: "`"
-#  identifier-end-quote: "'"
-#  driver-class: "com.mysql.cj.jdbc.Driver" 
-#  url-prefix:
-#  quote-identifiers: 
+  literal-quote: "`"
+  identifier-quote: "'"
+  literal-end-quote: "`"
+  identifier-end-quote: "'"
+  driver-class: "com.mysql.cj.jdbc.Driver"
+  url-prefix:
+  quote-identifiers:
+  sql-dialect:
+  adapter-class:
+  support-sql-limit:
 ```
 
 配置说明
 
 - **`db-type` : 必填,数据库类型，唯一**
 - **`name` : 必填,数据库名称，唯一**
 - **`literal-quote`: 必填,字符型参数引号。**
-- **`identifier-quote`: 必填，SQL字段/列名引号。**
+- **`identifier-quote`: 必填，SQL 字段/列名引号。**
 - `literal-end-quote` : 非必填，当字符型参数引号左右不一样时需要填写。
-- `identifier-end-quote`: 非必填，当SQL字段/列名引号左右不一致时，需要填写。如Sql Server使用的 `[`,`]`
+- `identifier-end-quote`: 非必填，当 SQL 字段/列名引号左右不一致时，需要填写。如 Sql Server 使用的 `[`,`]`
 - `driver-class` : 非必填，驱动类名称。可在数据源界面指定。
-- `url-prefix`: 非必填，url连接串前缀。可在数据源界面配置。
-- `quote-identifiers`: 非必填，列名是否加引号，默认true。
+- `url-prefix`: 非必填，url 连接串前缀。可在数据源界面配置。
+- `quote-identifiers`: 非必填，列名是否加引号，默认 true。
+- `sql-dialect`: 非必填，calcite 方言类名称。
+- `adapter-class`: 非必填，JDBC 适配器类名称。
+- `support-sql-limit`: 非必填，是否支持 `limit` 语法，默认 false。
 
-配置完成后，按照第一段描述添加驱动文件，重启服务端。刷新页面，就可以在JDBC数据源下找到刚才添加的 `impala` 数据库
+配置完成后，按照第一段描述添加驱动文件，重启服务端。刷新页面，就可以在 JDBC 数据源下找到刚才添加的 `impala` 数据库

source/docs/upgrade.md

@@ -0,0 +1,35 @@
+---
+title: 升级指南
+---
+
+# Docker 部署升级
+
+```shell
+# 更新镜像
+docker pull datart/datart
+# 停止与删除旧版本容器
+docker stop datart_container_name
+docker rm datart_container_name
+# 使用新版本镜像启动容器
+docker run -d --name datart -v your_path/datart.conf:/datart/config/datart.conf -v your_path/files:/datart/files -p 8080:8080 datart/datart
+```
+
+# 本地部署升级
+
+1. 从 [Github](https://github.com/running-elephant/datart/releases) 或 [Gitee](https://gitee.com/running-elephant/datart/releases) 下载新版本安装包
+2. 解压安装包到新的目录，不要覆盖旧版本 datart 服务路径
+3. 拷贝旧版本 datart 服务路径下的 `logs` 和 `files` 文件夹到新目录中
+4. 重新配置新版本 datart 服务，参考[部署](index)章节的说明
+5. 启动服务，完成升级
+
+# 注意事项
+
+- 每次升级之前，请备份 datart 应用数据库，有备无患
+- 每次升级之前，请阅读新版本 release note 中的不兼容变更，以免造成生产事故
+- 正常情况下升级失败时程序会自动回滚数据库到当前使用版本；如遇到异常情况，可以使用备份的数据库脚本回滚数据库
+
+# alpha 版本升级指南
+
+由于 alpha 版本没有提供自动升级程序，因此使用 alpha 版本的用户需要先手动升级到 beta.0 版本，然后按照[本地部署升级](#本地部署升级)章节的步骤升级到最新版本
+
+在 [Github](https://github.com/running-elephant/datart/releases) 和 [Gitee](https://gitee.com/running-elephant/datart/releases) 中， 每一个 alpha 版本的 release note 里都提供了数据库升级须知，供参考

themes/navy/languages/en.yml

@@ -41,6 +41,7 @@ sidebar:
     others: 其他
     tenant_management_mode: 租户管理模式
     migration: 资源迁移
+    upgrade: 升级指南
 
 
     overview: Overview