diff --git a/about-kaiwudb/supported-features.md b/about-kaiwudb/supported-features.md index 8cc026a72d1ee2d1142df1e5aefc93a1cefab96f..445b5e31c70925dec82d2aed5ea5855dc3ead77c 100644 --- a/about-kaiwudb/supported-features.md +++ b/about-kaiwudb/supported-features.md @@ -233,12 +233,12 @@ id: supported-features | 功能 | 企业版 | 社区版 | | --- | --- | --- | -| [加密传输](../db-operation/security/transport-encryption.md) | Y | Y | -| [基于用户名和密码的身份鉴别](../db-operation/security/identity-authn.md#基于用户名和密码的身份鉴别) | Y | Y | -| [基于主机的认证](../db-operation/security/identity-authn.md#基于主机的认证) | Y | Y | -| [创建、修改、查看、删除、管理用户和角色](../db-operation/security/user-role-mgmt.md) | Y | Y | -| [授予、撤销、查看权限](../db-operation/security/privilege-mgmt.md) | Y | Y | -| [开启、禁用审计功能、创建、修改、查看、删除审计策略](../db-operation/security/audit-mgmt.md) | Y | Y | +| [加密传输](../db-security/transport-encryption.md) | Y | Y | +| [基于用户名和密码的身份鉴别](../db-security/identity-authn.md#基于用户名和密码的身份鉴别) | Y | Y | +| [基于主机的认证](../db-security/identity-authn.md#基于主机的认证) | Y | Y | +| [创建、修改、查看、删除、管理用户和角色](../db-security/user-role-mgmt.md) | Y | Y | +| [授予、撤销、查看权限](../db-security/privilege-mgmt.md) | Y | Y | +| [开启、禁用审计功能、创建、修改、查看、删除审计策略](../db-security/audit-mgmt.md) | Y | Y | ## 数据库监控 diff --git a/db-operation/cluster-settings-config.md b/db-operation/cluster-settings-config.md index a45ab3bbd627ed8b7506b174842701c40da4d6cf..2f7e6dac02283fbbb0887315652d5d59c2a4ce40 100644 --- a/db-operation/cluster-settings-config.md +++ b/db-operation/cluster-settings-config.md @@ -76,7 +76,7 @@ id: cluster-settings-config | `--log-file-max-size` | 单个日志文件大小达到阈值以后,KWDB 创建新的日志文件并输出日志到新文件。
默认值:`10MiB` | | `--log-file-verbosity` | 讲指定日志级别及以上的日志输出到日志文件,例如:`--log-file-verbosity=WARNING`。
默认值:`INFO` | | `--logtostderr` | 将指定日志级别及以上的日志输出到 stderr,例如 `--logtostderr=ERROR`。
- 当未指定参数取值时,KWDB 将所有级别的日志输出到 stderr。
- 当配置为 `--logtostderr=NONE` 时,表示禁止输出日志到 stderr。 | -| `--sql-audit-dir` | 安全审计日志的位置。默认情况下,SQL 审核日志与 KWDB 生成的其他日志写入同一目录。有关更多信息,参见[审计日志](./security/audit-mgmt.md#审计日志)。 | +| `--sql-audit-dir` | 安全审计日志的位置。默认情况下,SQL 审核日志与 KWDB 生成的其他日志写入同一目录。有关更多信息,参见[审计日志](../db-security/audit-mgmt.md#审计日志)。 | ### 参数配置 diff --git a/db-operation/db-operation-overview.md b/db-operation/db-operation-overview.md index 015dd245df42a0d3c64dcde5d7ee2d0da5ef47ff..1dbe2a1dab1ab24fa643fcf661929f1bde3733d2 100644 --- a/db-operation/db-operation-overview.md +++ b/db-operation/db-operation-overview.md @@ -5,7 +5,7 @@ id: log-mgmt # 数据库运维概述 -本节面向所有使用 KaiwuDB 数据库的用户,主要是数据库管理员和应用程序开发人员。本节包括以下内容: +本节面向所有使用 KWDB 数据库的用户,主要是数据库管理员和应用程序开发人员。本节包括以下内容: - [集群规划](./cluster-planning.md) - [存储管理](./storage-mgmt.md) @@ -13,17 +13,10 @@ id: log-mgmt - [日志管理](./log-mgmt.md) - [时区管理](./timezone-mgmt.md) - [集群高可用](./cluster-ha.md) -- 集群安全 - - [安全概述](./security/security-overview.md) - - [加密传输](./security/transport-encryption.md) - - [身份鉴别](./security/identity-authn.md) - - [角色和成员管理](./security/user-role-mgmt.md) - - [权限管理](./security/privilege-mgmt.md) - - [审计管理](./security/audit-mgmt.md) - [容灾和备份](./backup-and-restore.md) - [故障排查](./db-operation-troubleshooting.md) - 错误码 - [错误码概述](./error-code/error-code-overview.md) - - [KaiwuDB 专有错误码](./error-code/error-code-kaiwudb.md) + - [KWDB 专有错误码](./error-code/error-code-kaiwudb.md) - [PostgreSQL 错误码](./error-code/error-code-postgresql.md) - [KaiwuDB JDBC Driver 错误码](./error-code/error-code-jdbc-driver.md) diff --git a/db-operation/log-mgmt.md b/db-operation/log-mgmt.md index aa6d124fd36968865c7071e9f53286c649f87be8..43f9623aec3140545d244df89ffa960c6c9eaa6f 100644 --- a/db-operation/log-mgmt.md +++ b/db-operation/log-mgmt.md @@ -12,5 +12,5 @@ id: log-mgmt | 时序引擎日志 | 记录时序引擎的运行状态,日志名以 `TsEngine` 开头。 | KWDB 用户数据目录下的 `logs` 子目录,默认路径为 `/var/lib/kaiwudb/logs`。| | 关系引擎日志 | 记录关系引擎的运行状态,日志名以 `kwbase-rocksdb` 开头。| KWDB 用户数据目录下的 `logs` 子目录,默认路径为 `/var/lib/kaiwudb/logs`。 | | 非存储日志 | 记录非存储引擎的运行状态,日志名以 `kwbase.log` 开头。| KWDB 用户数据目录下的 `logs` 子目录,默认路径为 `/var/lib/kaiwudb/logs`。 | -| 审计日志 | 数据库活动和操作的详细记录。默认情况下,审计功能关闭。开启审计功能后,系统自动审计系统级操作。有关审计日志和审计功能的更多信息,参见[审计管理](./security/audit-mgmt.md)。 | KWDB 用户数据目录下的 `logs` 子目录,默认路径为 `/var/lib/kaiwudb/logs`。部署完成后,KWDB 支持修改部署生成的 `kaiwudb_env` 文件或 `docker-compose.yml` 文件 中的 `--sql-audit-dir` 参数,指定审计日志的位置。 | +| 审计日志 | 数据库活动和操作的详细记录。默认情况下,审计功能关闭。开启审计功能后,系统自动审计系统级操作。有关审计日志和审计功能的更多信息,参见[审计管理](../db-security/audit-mgmt.md)。 | KWDB 用户数据目录下的 `logs` 子目录,默认路径为 `/var/lib/kaiwudb/logs`。部署完成后,KWDB 支持修改部署生成的 `kaiwudb_env` 文件或 `docker-compose.yml` 文件 中的 `--sql-audit-dir` 参数,指定审计日志的位置。 | | 错误日志 | 记录时序引擎崩溃时的信息。| - | diff --git a/db-operation/security/audit-mgmt.md b/db-security/audit-mgmt.md similarity index 100% rename from db-operation/security/audit-mgmt.md rename to db-security/audit-mgmt.md diff --git a/db-operation/security/security-overview.md b/db-security/db-security-overview.md similarity index 93% rename from db-operation/security/security-overview.md rename to db-security/db-security-overview.md index 07d939670cad467e3bec52fa1bc6e2a6e499744d..61b11d5a48ea6ade0d6b8187f66b6257dbd1aa85 100644 --- a/db-operation/security/security-overview.md +++ b/db-security/db-security-overview.md @@ -1,16 +1,15 @@ --- -title: 集群安全概述 -id: security-overview +title: 数据库安全概述 +id: db-security-overview --- -# 集群安全概述 +# 数据库安全概述 KWDB 提供了一系列的安全功能,确保用户数据的保密性、完整性和可用性。 -![](../../static/db-operation/BTZLbo7Q0os3VlxOd8zcPcrwntg.png) +![](../static/db-security/BTZLbo7Q0os3VlxOd8zcPcrwntg.png) - **加密传输**:KWDB 支持使用 SSL/TLS 协议对客户端和服务器之间的数据传输进行加密,确保数据在传输过程中不被窃取或篡改,提高了数据传输的安全性。 - - **身份鉴别**:KWDB 通过基于用户名和密码的身份鉴别以及灵活的主机认证规则,确保数据库访问的安全性。 - 基于用户名和密码的身份鉴别:用户在登录时需要提供正确的用户名和密码,系统将验证其凭证以允许访问。 - 基于主机的认证:KWDB 支持用户通过系统参数配置对指定用户和指定 IP 地址范围配置基于证书、密码的认证,无条件允许或拒绝连接等认证规则,实现对主机的访问的精确管理。 @@ -18,5 +17,4 @@ KWDB 提供了一系列的安全功能,确保用户数据的保密性、完整 - 基于角色的权限管理:管理员可以创建不同的角色,并为每个角色分配特定的权限。通过将用户和角色分配到适当的角色中,实现对用户权限的管理,从而简化权限管理流程,确保安全性。 - 细粒度的对象级权限控制:KWDB 允许管理员对数据库中的对象,例如数据库、表,进行细粒度的权限控制。管理员可以精确地指定用户或角色可以访问的数据库对象,以及可以执行的操作类型。 - 动态权限调整:管理员可以随时根据需要调整用户或角色的权限,包括增加、修改或撤销权限,及时响应业务需求或安全策略的变化,确保系统的灵活性和安全性。 - - **审计管理**:审计管理是 KWDB 安全管理的核心组成部分。通过全面记录数据库活动和用户操作,KWDB 能够帮助用户实时监控数据库的安全状态,并生成详尽的审计日志。这些审计日志可以帮助用户追溯安全事件的发生原因,加强对数据库的监控和管理。 diff --git a/db-operation/security/identity-authn.md b/db-security/identity-authn.md similarity index 100% rename from db-operation/security/identity-authn.md rename to db-security/identity-authn.md diff --git a/db-operation/security/privilege-mgmt.md b/db-security/privilege-mgmt.md similarity index 100% rename from db-operation/security/privilege-mgmt.md rename to db-security/privilege-mgmt.md diff --git a/db-operation/security/transport-encryption.md b/db-security/transport-encryption.md similarity index 100% rename from db-operation/security/transport-encryption.md rename to db-security/transport-encryption.md diff --git a/db-operation/security/user-role-mgmt.md b/db-security/user-role-mgmt.md similarity index 98% rename from db-operation/security/user-role-mgmt.md rename to db-security/user-role-mgmt.md index 1d5c90f44f619129d5d497fc06528ac602b7f0b3..ec9c4b40796af81d06fa03802302303cfc75f8d7 100644 --- a/db-operation/security/user-role-mgmt.md +++ b/db-security/user-role-mgmt.md @@ -3,11 +3,9 @@ title: 角色和成员管理 id: user-role-mgmt --- -KWDB 提供多层次、细粒度的权限机制,确保只有授权的用户和角色才能访问和操作数据库中的数据和对象。 - # 角色和成员管理 -KWDB 使用角色(Role)来管理用户权限。角色是权限的集合,用户可以通过赋予角色来获得相应的权限。这样有助于简化权限管理,方便对用户进行分组和管理。 +KWDB 提供多层次、细粒度的权限机制,确保只有授权的用户和角色才能访问和操作数据库中的数据和对象。KWDB 使用角色(Role)来管理用户权限。角色是权限的集合,用户可以通过赋予角色来获得相应的权限。这样有助于简化权限管理,方便对用户进行分组和管理。 ## 创建角色 diff --git a/development/connect-kaiwudb/connect-mybatis-plus.md b/development/connect-kaiwudb/connect-mybatis-plus.md index 914d10534a4cf2beaaa1456dce70a3a9a9de4d84..c554f3df3a0e6dac917bc4b5ab8910f169943047 100644 --- a/development/connect-kaiwudb/connect-mybatis-plus.md +++ b/development/connect-kaiwudb/connect-mybatis-plus.md @@ -13,7 +13,7 @@ id: connect-mybatis-plus - [安装 Java](https://docs.oracle.com/en/java/javase/22/install/overview-jdk-installation.html)(1.8 及以上版本)。 - [安装 Maven](https://maven.apache.org/install.html)(3.6 及以上版本)。 -- 安装 KaiwuDB 数据库、配置数据库认证方式、创建数据库、创建具有表级别及以上操作权限的用户。 +- 安装 KWDB 数据库、配置数据库认证方式、创建数据库、创建具有表级别及以上操作权限的用户。 - 获取 KaiwuDB JDBC 驱动包。 - 获取 MyBatis-Plus 驱动包。 diff --git a/faqs/faqs.md b/faqs/faqs.md index e5b34c50e60b58b2ddea0ea12b5d87e4ea5b5790..def14832983f3c0fc39b91a5524feb85861d5424 100644 --- a/faqs/faqs.md +++ b/faqs/faqs.md @@ -105,7 +105,7 @@ id: faqs ## 监控 FAQ ::: warning 说明 -目前,KaiwuDB 监控平台是企业版特性。如需了解 KaiwuDB 监控平台的更多详细信息,[联系](https://cs.kaiwudb.com/support/) KaiwuDB 技术支持人员。 +目前,KaiwuDB 监控平台是企业版特性。如需了解 KaiwuDB 监控平台的更多详细信息,[联系](https://cs.kaiwudb.com/support/) KWDB 技术支持人员。 ::: - **问题描述** diff --git a/release-notes/release-notes.md b/release-notes/release-notes.md index 82fe66b431f2ddf85fe71bb2b54a0e14e50a18fd..0916c8f9699139251fc4722f5f8ec6a8adf29714 100644 --- a/release-notes/release-notes.md +++ b/release-notes/release-notes.md @@ -60,7 +60,7 @@ KWDB 是一款面向 AIoT(Artificial Intelligence of Things,智能物联网 - 支持开启、关闭数据库审计操作,支持审计 DDL 操作、DML 操作、DCL 操作、DQL 操作。 - 支持客户端与服务器端通过 HTTPS 等方式进行加密通信。 -有关数据库安全的更多详细信息,参见[集群安全概述](../db-operation/security/security-overview.md)。 +有关数据库安全的更多详细信息,参见[数据库安全概述](../db-security/db-security-overview.md)。 ### 数据库兼容 diff --git a/sql-reference/ddl/relational-db/relational-database.md b/sql-reference/ddl/relational-db/relational-database.md index 342f736be6cbc1f360d2fb14261ee51043bde850..9e89cba3a4dbd7a4c2b4f6a5867c005e550ae963 100644 --- a/sql-reference/ddl/relational-db/relational-database.md +++ b/sql-reference/ddl/relational-db/relational-database.md @@ -1,9 +1,9 @@ --- -title: 关系数据库 +title: 数据库 id: relational-database --- -# 数据库对象 +# 数据库 ## 创建数据库 diff --git a/sql-reference/ddl/ts-db/ts-database.md b/sql-reference/ddl/ts-db/ts-database.md index 330c49e4b9fd0df35474f2a8be623eee6d6e6c07..c42e8285d4d7cf5ab2db6183addaeee8c79adc9e 100644 --- a/sql-reference/ddl/ts-db/ts-database.md +++ b/sql-reference/ddl/ts-db/ts-database.md @@ -1,5 +1,5 @@ --- -title: 时序数据库 +title: 数据库 id: ts-database --- diff --git a/sql-reference/other-sql-statements/transactions-sql.md b/sql-reference/other-sql-statements/transactions-sql.md index 931c65217677230743495c6135204bdeaf3e0fb8..b85286a271dd20dc550553bfec9225837fa6da85 100644 --- a/sql-reference/other-sql-statements/transactions-sql.md +++ b/sql-reference/other-sql-statements/transactions-sql.md @@ -471,8 +471,8 @@ CREATE TABLE 事务之间可以使用保存点名称相互嵌套。在嵌套结构中,`RELEASE SAVEPOINT` 和 `ROLLBACK TO SAVEPOINT` 语句都可以指向更高层级的保存点。在这种情况下,系统会自动释放、回滚嵌套结构内的所有保存点。 - - 当回滚先前的保存点后,系统也会将该保存点之后输入的语句进行回滚。有关详细信息,参见[释放保存点](#释放保存点)。 - - 当释放先前的保存点后,系统会将在保存点之后输入的语句进行提交。有关详细信息,参见[回滚事务](#回滚事务)。 + - 当回滚先前的保存点后,系统也会将该保存点之后输入的语句进行回滚。有关详细信息,参见[回滚事务](#回滚事务)。 + - 当释放先前的保存点后,系统会将在保存点之后输入的语句进行提交。有关详细信息,参见[释放保存点](#释放保存点)。 - 自动重试事务的保存点。 diff --git a/static/db-operation/BTZLbo7Q0os3VlxOd8zcPcrwntg.png b/static/db-security/BTZLbo7Q0os3VlxOd8zcPcrwntg.png similarity index 100% rename from static/db-operation/BTZLbo7Q0os3VlxOd8zcPcrwntg.png rename to static/db-security/BTZLbo7Q0os3VlxOd8zcPcrwntg.png