diff --git a/README.en.md b/README.en.md index 7b14b086657141105e25de63d47f69aa28ed9da6..cba02d1a9874c1852b72f67ebb2fbce7438368e5 100644 --- a/README.en.md +++ b/README.en.md @@ -18,7 +18,8 @@ Currently, we are maintaining the following versions of KWDB documentation in di | Branch | Documentation Version | | :----- | :------------------------------------- | -| `master` | KWDB 2.0 | +| `master` | Latest | +| `2.0` | KWDB 2.0 | ## Contact Us diff --git a/README.md b/README.md index caa06ed2a42a2e37d0b6e230569ada921d8351fa..e12d524ac52c9f54fbf9a4882b2049246245f408 100755 --- a/README.md +++ b/README.md @@ -18,7 +18,8 @@ | 文档仓库分支 | 文档版本 | | ----------------- | ---------------------- | -| `master` | KWDB 2.0 | +| `master` | 正在开发的版本 | +| `2.0` | KWDB 2.0 | ## 联系方式 diff --git a/db-administration/data-query/data-query.md b/db-administration/data-query/data-query.md index fd11ae70c5936722da81646fb1c3f2465b08bb58..a3d149f1ea0798d337e4ff870513f6bdc852ba3c 100644 --- a/db-administration/data-query/data-query.md +++ b/db-administration/data-query/data-query.md @@ -67,7 +67,7 @@ KWDB 跨模查询支持以下联合查询: - 嵌套查询 - 以下示例使用相关投影子查询,对设备 ID 与 `tsdb.MonitoringCenter` 的表进行关联,返回相应设备 ID 下的最大状态值。 + 以下示例使用相关投影子查询,对设备 ID 与 `tsdb.MonitoringCenter` 的表进行关联,返回相应设备 ID 下的最新状态。 ```sql SELECT d.deviceID, diff --git a/db-administration/db-object-mgmt/relational-db/table-mgmt-relational.md b/db-administration/db-object-mgmt/relational-db/table-mgmt-relational.md index 9b36825d3c5bc1440b9e68290eaf72b7429ab9b5..cc1d39942c1ac7cd4e6c3dae2f2388f9e065f26a 100644 --- a/db-administration/db-object-mgmt/relational-db/table-mgmt-relational.md +++ b/db-administration/db-object-mgmt/relational-db/table-mgmt-relational.md @@ -475,7 +475,7 @@ CREATE TABLE [IF NOT EXISTS] ### 语法格式 ```sql -SHOW TABLES FROM [][.] [WITH COMMENT]; +SHOW TABLES [FROM ][.] [WITH COMMENT]; ``` ### 参数说明 @@ -491,7 +491,7 @@ SHOW TABLES FROM [][.] [WITH COMMENT]; - 查看当前数据库中的表。 ```sql - show tables; + SHOW TABLES; ``` 执行成功后,控制台输出以下信息: @@ -557,9 +557,9 @@ SHOW TABLES FROM [][.] [WITH COMMENT]; (52 rows) ``` -- 显示带有注释信息的表。 +- 查看带有注释信息的表。 - 以下示例创建一个名为 `users` 的表,并为表添加注释信息。 + 以下示例查看带有注释信息的表。 ```sql -- 1. 为 users 表添加注释。 diff --git a/deployment/docker/docker-deployment.md b/deployment/docker/docker-deployment.md index a59e92a68c0d7f16b3ab0a6eea6f3365193eb83d..391dfb0f7bf0cb2492eacb35448e8707579d6391 100644 --- a/deployment/docker/docker-deployment.md +++ b/deployment/docker/docker-deployment.md @@ -9,7 +9,7 @@ id: docker-deployment 在部署过程中,系统会自动生成相关日志。如果部署时出现错误,用户可以通过查看终端输出或 KWDB 安装目录中 `log` 目录里的日志文件,获取详细的错误信息。 -部署完成后,系统将生成 `/etc/kaiwudb/` 目录。Docker Compose 配置文件 `docker-compose.yml`位于 `/etc/kaiwudb/script` 目录下。部署完成后,用户可以修改 Docker Compose 配置文件 `docker-compose.yml`,配置 KWDB 的启动参数和 CPU 资源占用率。有关定制化部署配置的详细信息,参见[配置集群](./cluster-config-docker.md)。 +部署完成后,系统将生成 `/etc/kaiwudb/` 目录。Docker Compose 配置文件 `docker-compose.yml` 位于 `/etc/kaiwudb/script` 目录下。部署完成后,用户可以修改 Docker Compose 配置文件 `docker-compose.yml`,配置 KWDB 的启动参数和 CPU 资源占用率。有关定制化部署配置的详细信息,参见[配置集群](./cluster-config-docker.md)。 ## 前提条件 diff --git a/quickstart/install-kaiwudb/quickstart-bare-metal.md b/quickstart/install-kaiwudb/quickstart-bare-metal.md index a8d055d0ec164cc33169786da01e4e48fd0d7e90..342567dbd4be97cdd5ec975a1f7df837281f7136 100644 --- a/quickstart/install-kaiwudb/quickstart-bare-metal.md +++ b/quickstart/install-kaiwudb/quickstart-bare-metal.md @@ -89,6 +89,11 @@ tar -zxvf 在部署过程中,系统会自动生成相关日志。如果部署时出现错误,用户可以通过查看终端输出或 KWDB 安装目录中 `log` 目录里的日志文件,获取详细的错误信息。 +部署完成后,系统会将 KWDB 封装成系统服务(名称为 `kaiwudb`),并生成以下文件: + +- `kaiwudb.service`:配置 KWDB 的 CPU 资源占用率。 +- `kaiwudb_env`:配置 KWDB 启动参数。 + ### 前提条件 - 待部署节点的硬件、操作系统、软件依赖和端口满足安装部署要求。 @@ -113,6 +118,7 @@ tar -zxvf rest_port=8080 kaiwudb_port=26257 data_root=/var/lib/kaiwudb + cpu=1 [local] node_addr=192.168.64.128 diff --git a/quickstart/install-kaiwudb/quickstart-docker.md b/quickstart/install-kaiwudb/quickstart-docker.md index 04dd414c9824a25773fbe48ae3b86bde77ce13c1..5be146399074be49abc2ccc2f31266f810177dcd 100644 --- a/quickstart/install-kaiwudb/quickstart-docker.md +++ b/quickstart/install-kaiwudb/quickstart-docker.md @@ -96,8 +96,10 @@ tar -zxvf 在部署过程中,系统会自动生成相关日志。如果部署时出现错误,用户可以通过查看终端输出或 KWDB 安装目录中 `log` 目录里的日志文件,获取详细的错误信息。 -::: warning 提示 -容器部署支持使用 YAML(`.yml`)文件和安装脚本两种方式,使用 YAML(`.yml`)文件进行快速部署时,仅支持非安全模式,登录 KWDB 数据库时需使用非安全连接模式。安装脚本部署支持安全模式和非安全模式。具体部署步骤,参见[容器部署](../../deployment/docker/docker-deployment.md)。 +部署完成后,系统生成 `/etc/kaiwudb/` 目录。Docker Compose 配置文件 `docker-compose.yml` 位于 `/etc/kaiwudb/script` 目录下。部署完成后,用户可以修改 Docker Compose 配置文件 `docker-compose.yml`,配置 KWDB 的启动参数和 CPU 资源占用率。有关定制化部署配置的详细信息,参见[配置集群](../../deployment/docker/cluster-config-docker.md)。 + +::: warning 说明 +支持使用 YAML(`.yml`)文件和安装脚本两种方式部署 KWDB。使用 YAML(`.yml`)文件进行部署时,仅支持非安全模式,登录 KWDB 数据库时需使用非安全连接模式。安装脚本部署支持安全模式和非安全模式。 ::: ### 前提条件 @@ -109,9 +111,9 @@ tar -zxvf - 未配置 `sudo` 免密的普通用户在执行部署脚本时,需要输入密码进行提权。 - 安装用户为非 root 用户时,需要通过 `sudo usermod -aG docker $USER` 命令将用户添加到 `docker` 组。 -### 部署步骤 +### 使用 YAML 文件部署 KWDB -如需部署 KWDB,遵循以下步骤。 +如需使用 YAML 文件部署 KWDB,遵循以下步骤。 1. 在 `kaiwudb_install/packages` 目录下导入 `KaiwuDB.tar` 文件,获取镜像名称。 @@ -171,3 +173,94 @@ tar -zxvf ```shell systemctl enable kaiwudb ``` + +### 使用安装脚本部署 KWDB + +如需使用安装脚本部署 KWDB,遵循以下步骤。 + +1. 登录待部署节点,编辑安装包目录下的 `deploy.cfg` 配置文件,设置安全模式、管理用户、服务端口等信息。 + + ::: warning 说明 + 默认情况下,`deploy.cfg` 配置文件中包含集群配置参数。请删除或注释 `[cluster]` 集群配置项。 + ::: + + 配置文件示例: + + ```yaml + [global] + secure_mode=y + management_user=kaiwudb + rest_port=8080 + kaiwudb_port=26257 + data_root=/var/lib/kaiwudb + cpu=1 + [local] + node_addr=192.168.64.128 + + # [cluster] + # node_addr=192.168.64.129, 192.168.64.130 + # ssh_port=22 + # ssh_user=admin + ``` + + 参数说明: + + - `global`:全局配置 + - `secure_mode`:是否开启安全模式,默认开启安全模式。开启安全模式后,KWDB 生成 TLS 安全证书,作为客户端或应用程序连接数据库的凭证。生成的客户端相关证书存放在 `/etc/kaiwudb/certs` 目录。 + - `management_user`:KWDB 的管理用户,默认为 `kaiwudb`。安装部署后,KWDB 创建相应的管理用户以及和管理用户同名的用户组。 + - `rest_port`:KWDB Web 服务端口,默认为 `8080`。 + - `kaiwudb_port`:KWDB 服务端口,默认为 `26257`。 + - `data_root`:数据目录,默认为 `/var/lib/kaiwudb`。 + - `cpu`: 可选参数,用于指定 KWDB 服务占用当前节点服务器 CPU 资源的比例,默认无限制。取值范围为 `[0,1]`,最大精度为小数点后两位。 + - `local`:本地节点配置 + - `node_addr`:本地节点对外提供服务的 IP 地址,监听地址为 `0.0.0.0`,端口为 KWDB 服务端口。 + +2. 为 `deploy.sh` 脚本添加运行权限。 + + ```shell + chmod +x ./deploy.sh + ``` + +3. 执行单机部署安装命令。 + + ```shell + ./deploy.sh install --single + ``` + + 执行成功后,控制台输出以下信息: + + ```shell + INSTALL COMPLETED: KaiwuDB has been installed successfuly! ... + ``` + +4. 启动 KWDB 节点。 + + ```shell + ./deploy.sh start + ``` + + 执行成功后,控制台输出以下信息: + + ```shell + START COMPLETED: KaiwuDB has started successfuly! ... + ``` + +5. 查看 KWDB 节点状态。 + + ```shell + ./deploy.sh status + ``` + + 或者 + + ```sql + systemctl status kaiwudb + ``` + +6. (可选)配置 KWDB 开机自启动。 + + 配置 KWDB 开机自启动后,如果系统重启,则自动启动 KWDB。 + + ```shell + systemctl enable kaiwudb + ``` diff --git a/release-notes/release-notes.md b/release-notes/release-notes.md index 0916c8f9699139251fc4722f5f8ec6a8adf29714..da0a3d1f4dd1e91b0e717288435a2ebba7a6e04d 100644 --- a/release-notes/release-notes.md +++ b/release-notes/release-notes.md @@ -13,7 +13,7 @@ KWDB 是一款面向 AIoT(Artificial Intelligence of Things,智能物联网 | 版本号 | 发版日期 | | -------- | ---------- | -| 2.0 | 2024.07.31 | +| 2.0 | 2024.08.22 | ## 功能特性 diff --git a/sql-reference/ddl/relational-db/relational-table.md b/sql-reference/ddl/relational-db/relational-table.md index 467593cb7b686c43c45838887ac8a90f5398f7f2..42951f5745bc585c7d453e68e1e3871c04e31a17 100644 --- a/sql-reference/ddl/relational-db/relational-table.md +++ b/sql-reference/ddl/relational-db/relational-table.md @@ -517,7 +517,7 @@ id: relational-table - 查看当前数据库中的表。 ```sql - show tables; + SHOW TABLES; ``` 执行成功后,控制台输出以下信息: @@ -583,9 +583,9 @@ id: relational-table (52 rows) ``` -- 显示带有注释信息的表。 +- 查看带有注释信息的表。 - 以下示例创建一个名为 `users` 的表,并为表添加注释信息。 + 以下示例查看带有注释信息的表。 ```sql -- 1. 为 users 表添加注释。 diff --git a/sql-reference/dml/data-query.md b/sql-reference/dml/data-query.md index 5c813e73203bb8ca7ee014f949b8b53367b9d08b..0c4d14457703b17cfd35067e49feee60fe95f410 100644 --- a/sql-reference/dml/data-query.md +++ b/sql-reference/dml/data-query.md @@ -66,7 +66,7 @@ KWDB 跨模查询支持以下联合查询: - 嵌套查询 - 以下示例使用相关投影子查询,对设备 ID 与 `tsdb.MonitoringCenter` 的表进行关联,返回相应设备 ID 下的最大状态值。 + 以下示例使用相关投影子查询,对设备 ID 与 `tsdb.MonitoringCenter` 的表进行关联,返回相应设备 ID 下的最新状态。 ```sql SELECT d.deviceID,