feat(docs): 完善达梦数据库支持文档
- 更新 .gitignore 文件，添加对 .sql 文件的忽略 - 移除 cache_db.go 中的调试日志相关代码，简化缓存操作逻辑 - 在多个文档中添加达梦 DM8 数据库的支持信息，包括配置、使用注意事项及示例 - 更新 QUICKSTART.md，明确支持的数据库类型及配置示例 - 在 ROADMAP.md 中记录达梦数据库完整支持的进展
This commit is contained in:
+243
-33
@@ -2,7 +2,7 @@
|
||||
|
||||
## 概述
|
||||
|
||||
HoTimeDB是一个基于Golang实现的轻量级ORM框架，参考PHP Medoo设计，提供简洁的数据库操作接口。支持MySQL、SQLite、PostgreSQL等数据库，并集成了缓存、事务、链式查询等功能。
|
||||
HoTimeDB是一个基于Golang实现的轻量级ORM框架，参考PHP Medoo设计，提供简洁的数据库操作接口。支持MySQL、SQLite、PostgreSQL、达梦（DM8）等数据库，并集成了缓存、事务、链式查询等功能。
|
||||
|
||||
## 目录
|
||||
|
||||
@@ -24,6 +24,7 @@ HoTimeDB是一个基于Golang实现的轻量级ORM框架，参考PHP Medoo设计
|
||||
- [事务处理](#事务处理)
|
||||
- [缓存机制](#缓存机制)
|
||||
- [PostgreSQL支持](#postgresql支持)
|
||||
- [达梦数据库支持](#达梦数据库支持)
|
||||
- [高级特性](#高级特性)
|
||||
|
||||
## 快速开始
|
||||
@@ -48,7 +49,7 @@ func createConnection() (master, slave *sql.DB) {
|
||||
|
||||
// 初始化HoTimeDB
|
||||
database := &db.HoTimeDB{
|
||||
Type: "mysql", // 可选：mysql, sqlite3, postgres
|
||||
Type: "mysql", // 可选：mysql, sqlite3, postgres, dm
|
||||
}
|
||||
database.SetConnect(createConnection)
|
||||
```
|
||||
@@ -64,7 +65,7 @@ type HoTimeDB struct {
|
||||
DBName string
|
||||
*cache.HoTimeCache
|
||||
Log *logrus.Logger
|
||||
Type string // 数据库类型：mysql, sqlite3, postgres
|
||||
Type string // 数据库类型：mysql, sqlite3, postgres, dm
|
||||
Prefix string // 表前缀
|
||||
LastQuery string // 最后执行的SQL
|
||||
LastData []interface{} // 最后的参数
|
||||
@@ -212,17 +213,27 @@ user := database.Get("user", "id,name,email", common.Map{
|
||||
```go
|
||||
// 基本插入
|
||||
id := database.Insert("user", common.Map{
|
||||
"name": "张三",
|
||||
"email": "zhangsan@example.com",
|
||||
"age": 25,
|
||||
"status": 1,
|
||||
"created_time[#]": "NOW()", // [#]表示直接插入SQL函数
|
||||
"name": "张三",
|
||||
"email": "zhangsan@example.com",
|
||||
"age": 25,
|
||||
"status": 1,
|
||||
"created_time": Time2Str(time.Now()), // 推荐：使用服务器时间，避免数据库时区问题
|
||||
})
|
||||
|
||||
// 返回插入的ID
|
||||
fmt.Println("插入的用户ID:", id)
|
||||
```
|
||||
|
||||
> **时间字段最佳实践**：建议使用 `Time2Str(time.Now())` 传入服务器时间，而非 `"[#]": "NOW()"` 让数据库执行 `NOW()`。
|
||||
> 原因：`NOW()` 使用数据库服务器时间，当应用服务器与数据库服务器时区不同时会产生偏差；而 `Time2Str(time.Now())` 始终使用应用服务器时间，行为一致，且跨数据库（MySQL / 达梦 / PostgreSQL）完全兼容。
|
||||
>
|
||||
> ```go
|
||||
> import (
|
||||
> "time"
|
||||
> . "code.hoteas.com/golang/hotime/common" // Time2Str 在 common 包中
|
||||
> )
|
||||
> ```
|
||||
|
||||
### 批量插入(Inserts)
|
||||
|
||||
```go
|
||||
@@ -236,10 +247,11 @@ affected := database.Inserts("user", []common.Map{
|
||||
|
||||
fmt.Printf("批量插入 %d 条记录\n", affected)
|
||||
|
||||
// 支持 [#] 标记直接插入 SQL 表达式
|
||||
// 推荐：使用服务器时间（Time2Str）而非数据库函数 NOW()
|
||||
now := Time2Str(time.Now())
|
||||
affected := database.Inserts("log", []common.Map{
|
||||
{"user_id": 1, "action": "login", "created_time[#]": "NOW()"},
|
||||
{"user_id": 2, "action": "logout", "created_time[#]": "NOW()"},
|
||||
{"user_id": 1, "action": "login", "created_time": now},
|
||||
{"user_id": 2, "action": "logout", "created_time": now},
|
||||
})
|
||||
```
|
||||
|
||||
@@ -248,9 +260,9 @@ affected := database.Inserts("log", []common.Map{
|
||||
```go
|
||||
// 基本更新
|
||||
affected := database.Update("user", common.Map{
|
||||
"name": "李四",
|
||||
"email": "lisi@example.com",
|
||||
"updated_time[#]": "NOW()",
|
||||
"name": "李四",
|
||||
"email": "lisi@example.com",
|
||||
"modify_time": Time2Str(time.Now()), // 推荐：服务器时间
|
||||
}, common.Map{
|
||||
"id": 1,
|
||||
})
|
||||
@@ -291,6 +303,12 @@ affected := database.Upsert("user",
|
||||
// INSERT INTO "user" (id,name,email,login_count) VALUES ($1,$2,$3,$4)
|
||||
// ON CONFLICT (id) DO UPDATE SET name=EXCLUDED.name, email=EXCLUDED.email, login_count=EXCLUDED.login_count
|
||||
|
||||
// 达梦 DM8 生成:
|
||||
// MERGE INTO "user" USING (SELECT ? AS "id", ? AS "name", ...) src
|
||||
// ON ("user"."id" = src."id")
|
||||
// WHEN MATCHED THEN UPDATE SET "name"=src."name", "email"=src."email", ...
|
||||
// WHEN NOT MATCHED THEN INSERT ("id","name","email","login_count") VALUES (src."id", ...)
|
||||
|
||||
// 使用 [#] 标记直接 SQL 更新
|
||||
affected := database.Upsert("user",
|
||||
common.Map{
|
||||
@@ -349,8 +367,8 @@ user := database.Table("user").
|
||||
affected := database.Table("user").
|
||||
Where("id", 1).
|
||||
Update(common.Map{
|
||||
"name": "新名称",
|
||||
"updated_time[#]": "NOW()",
|
||||
"name": "新名称",
|
||||
"modify_time": Time2Str(time.Now()),
|
||||
})
|
||||
|
||||
// 链式删除
|
||||
@@ -458,14 +476,14 @@ HoTimeDB支持丰富的条件查询语法，类似于Medoo：
|
||||
### 直接SQL
|
||||
|
||||
```go
|
||||
// 直接插入SQL表达式（注意防注入）
|
||||
"created_time[#]": "> DATE_SUB(NOW(), INTERVAL 1 DAY)"
|
||||
|
||||
// 字段直接赋值（不使用参数化查询）
|
||||
"update_time[#]": "NOW()"
|
||||
|
||||
// 直接SQL片段
|
||||
// 直接SQL片段（通常用于复杂条件，时间推荐用 Go 计算）
|
||||
"[##]": "user.status = 1 AND user.level > 0"
|
||||
|
||||
// 时间范围条件：推荐在 Go 侧计算，避免跨库 NOW() 差异
|
||||
"created_time[>]": Time2Str(time.Now().AddDate(0, 0, -1)) // 一天前
|
||||
|
||||
// 如必须用数据库函数（不跨库时可用，但不推荐）
|
||||
"update_time[#]": "NOW()"
|
||||
```
|
||||
|
||||
## JOIN操作
|
||||
@@ -637,10 +655,10 @@ success := database.Action(func(tx db.HoTimeDB) bool {
|
||||
|
||||
// 创建订单
|
||||
orderId := tx.Insert("order", common.Map{
|
||||
"user_id": 1,
|
||||
"amount": 100,
|
||||
"status": "paid",
|
||||
"created_time[#]": "NOW()",
|
||||
"user_id": 1,
|
||||
"amount": 100,
|
||||
"status": "paid",
|
||||
"created_time": Time2Str(time.Now()),
|
||||
})
|
||||
|
||||
if orderId == 0 {
|
||||
@@ -721,6 +739,182 @@ database.SetConnect(func(err ...*common.Error) (master, slave *sql.DB) {
|
||||
|
||||
所有这些差异由框架自动处理，无需手动调整代码。
|
||||
|
||||
## 达梦数据库支持
|
||||
|
||||
HoTimeDB 原生支持**达梦数据库 DM8**，驱动已内置于 `vendor/gitee.com/chunanyong/dm`，无需额外安装。
|
||||
|
||||
### 达梦配置
|
||||
|
||||
在 `config.json` 中配置：
|
||||
|
||||
```json
|
||||
{
|
||||
"db": {
|
||||
"dm": {
|
||||
"host": "127.0.0.1",
|
||||
"port": "5236",
|
||||
"user": "SYSDBA",
|
||||
"password": "your_password",
|
||||
"name": "TEST",
|
||||
"prefix": ""
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
代码配置方式：
|
||||
|
||||
```go
|
||||
import (
|
||||
"code.hoteas.com/golang/hotime/db"
|
||||
_ "gitee.com/chunanyong/dm" // 达梦驱动（已在 vendor 中）
|
||||
)
|
||||
|
||||
database := &db.HoTimeDB{
|
||||
Type: "dm", // 或 "dameng"
|
||||
Prefix: "", // 表前缀（可选）
|
||||
}
|
||||
|
||||
database.SetConnect(func(err ...*common.Error) (master, slave *sql.DB) {
|
||||
// name 字段即为 schema（默认搜索路径）
|
||||
dsn := "dm://SYSDBA:your_password@127.0.0.1:5236?schema=TEST"
|
||||
master, _ = sql.Open("dm", dsn)
|
||||
return master, master
|
||||
})
|
||||
```
|
||||
|
||||
> **schema 说明**：`?schema=TEST` 将当前会话的默认搜索 schema 设置为 `TEST`。
|
||||
> 所有不带 schema 前缀的表名均在该 schema 下查找和创建。
|
||||
> 建议为应用创建独立的专用 schema，避免直接使用 `SYSDBA` 默认 schema。
|
||||
|
||||
### 与 MySQL/PostgreSQL 的差异对比
|
||||
|
||||
| 特性 | MySQL | PostgreSQL | 达梦 DM8 |
|
||||
|------|-------|------------|---------|
|
||||
| 标识符引号 | \`name\` | "name" | "name" |
|
||||
| 占位符 | ? | $1, $2... | ? |
|
||||
| Upsert | ON DUPLICATE KEY UPDATE | ON CONFLICT DO UPDATE | MERGE INTO ... USING |
|
||||
| 自增列 | AUTO_INCREMENT | SERIAL | IDENTITY(1,1) |
|
||||
| 文本类型 | TEXT | TEXT | TEXT / CLOB |
|
||||
| 时间赋值（推荐） | `Time2Str(time.Now())` | `Time2Str(time.Now())` | `Time2Str(time.Now())` |
|
||||
| 时间函数（不推荐） | `NOW()` | `NOW()` | `NOW()` |
|
||||
| 分页语法 | LIMIT m, n | LIMIT n OFFSET m | LIMIT m, n 或 LIMIT n OFFSET m |
|
||||
|
||||
所有这些差异由框架自动处理，业务代码无需修改。
|
||||
|
||||
### Upsert 在达梦中的行为
|
||||
|
||||
达梦不支持 MySQL 的 `ON DUPLICATE KEY UPDATE` 和 PostgreSQL 的 `ON CONFLICT`，框架会自动生成 `MERGE INTO` 语句：
|
||||
|
||||
```go
|
||||
// 调用方式与其他数据库完全一致
|
||||
affected := database.Upsert("admin",
|
||||
common.Map{
|
||||
"name": "张三",
|
||||
"phone": "13800000001",
|
||||
"password": "abc123",
|
||||
"role_id": 1,
|
||||
},
|
||||
common.Slice{"phone"}, // 唯一键（冲突检测）
|
||||
common.Slice{"name", "password", "role_id"}, // 冲突时更新的字段
|
||||
)
|
||||
|
||||
// 达梦自动生成：
|
||||
// MERGE INTO "admin" USING (SELECT ? AS "name", ? AS "phone", ...) src
|
||||
// ON ("admin"."phone" = src."phone")
|
||||
// WHEN MATCHED THEN UPDATE SET "name" = src."name", ...
|
||||
// WHEN NOT MATCHED THEN INSERT (...) VALUES (src....)
|
||||
```
|
||||
|
||||
### 达梦注意事项
|
||||
|
||||
#### 1. 标识符大小写敏感
|
||||
|
||||
达梦对双引号包裹的标识符大小写敏感。框架统一使用**小写**创建和访问表/列，确保一致性：
|
||||
|
||||
```sql
|
||||
-- ✅ 正确：框架自动生成，小写标识符
|
||||
SELECT * FROM "admin" WHERE "id" = ?
|
||||
|
||||
-- ❌ 错误：大小写不一致会导致 "无效的表或视图名" 错误
|
||||
SELECT * FROM "ADMIN" WHERE "ID" = ?
|
||||
```
|
||||
|
||||
> 使用 DM 管理工具手动创建表时，建议使用双引号包裹小写名称，与框架保持一致。
|
||||
|
||||
#### 2. 保留字冲突
|
||||
|
||||
达梦有大量保留字（如 `admin`、`user`、`order`、`key`、`value` 等），直接使用这些名称作为表名或列名会报语法错误。
|
||||
**框架已自动为所有标识符加双引号**，一般情况下无需手动处理。
|
||||
|
||||
如果在原生 SQL（`Query`/`Exec`）中使用保留字，需要手动加引号：
|
||||
|
||||
```go
|
||||
// 原生 SQL 中需要手动加双引号
|
||||
results := database.Query(`SELECT "id", "name" FROM "admin" WHERE "state" = ?`, 1)
|
||||
```
|
||||
|
||||
#### 3. schema 与 USER_TABLES 的关系
|
||||
|
||||
连接达梦时使用 `?schema=TEST`，DM 的 `USER_TABLES` 视图只显示当前**登录用户**（如 SYSDBA）所属 schema 的表，而非当前会话 schema 的表。
|
||||
|
||||
框架内部已改用 `COUNT(*)` 方式直接探查表可访问性，避免 schema 错配问题。
|
||||
|
||||
如果在自定义代码中检测表是否存在，**不要用 USER_TABLES**，改用：
|
||||
|
||||
```go
|
||||
// ✅ 推荐：直接探查表可访问性
|
||||
res := database.Query(`SELECT COUNT(*) as cnt FROM "your_table"`)
|
||||
exists := len(res) > 0
|
||||
|
||||
// ❌ 不推荐：USER_TABLES 可能显示当前会话 schema 之外的表
|
||||
res := database.Query(`SELECT TABLE_NAME FROM USER_TABLES WHERE TABLE_NAME='your_table'`)
|
||||
```
|
||||
|
||||
#### 4. DDL 建表建议
|
||||
|
||||
手动建表时，列定义与 MySQL 的区别：
|
||||
|
||||
```sql
|
||||
-- 达梦建表示例
|
||||
CREATE TABLE "admin" (
|
||||
"id" INT IDENTITY(1,1) PRIMARY KEY, -- 自增（MySQL: AUTO_INCREMENT）
|
||||
"name" VARCHAR(100),
|
||||
"phone" VARCHAR(20),
|
||||
"content" CLOB, -- 长文本（MySQL: TEXT/LONGTEXT）
|
||||
"create_time" TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||
"modify_time" TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||
CONSTRAINT "uk_admin_phone" UNIQUE ("phone")
|
||||
);
|
||||
|
||||
-- 索引
|
||||
CREATE INDEX "idx_admin_state" ON "admin" ("state");
|
||||
```
|
||||
|
||||
#### 5. 日期时间函数差异
|
||||
|
||||
部分日期函数在达梦中语法不同，使用 `[##]` 直接SQL时需注意：
|
||||
|
||||
| 功能 | 推荐（Go侧） | MySQL `[##]`/原生SQL | 达梦 DM8 `[##]`/原生SQL |
|
||||
|------|------------|---------------------|----------------------|
|
||||
| 当前时间赋值 | `Time2Str(time.Now())` ✅ | `NOW()` | `NOW()` |
|
||||
| 一天前（时间范围查询） | `Time2Str(time.Now().AddDate(0,0,-1))` ✅ | `DATE_SUB(NOW(), INTERVAL 1 DAY)` | `DATEADD(DAY, -1, NOW())` |
|
||||
| 时间戳转字符串 | `Time2Str(time.Unix(ts, 0))` ✅ | `FROM_UNIXTIME(ts)` | 不支持，需 Go 侧处理 |
|
||||
|
||||
> **强烈推荐**：时间字段赋值和时间范围计算都在 Go 侧完成（使用 `Time2Str`、`time.Now().Add()` 等），传入参数化的字符串值。这样完全规避数据库时区设置差异，也无需关心各数据库函数的语法不同。
|
||||
|
||||
#### 6. 使用 IN 查询时的注意事项
|
||||
|
||||
IN 查询在达梦中与 MySQL 行为一致，框架已统一处理：
|
||||
|
||||
```go
|
||||
// 正常使用，框架自动展开
|
||||
results := database.Select("article", "*", common.Map{
|
||||
"id": []int{1, 2, 3},
|
||||
})
|
||||
// 生成: WHERE "id" IN (?, ?, ?)
|
||||
```
|
||||
|
||||
## 高级特性
|
||||
|
||||
### 调试模式
|
||||
@@ -758,8 +952,8 @@ database.SetConnect(createConnection)
|
||||
// 执行查询SQL
|
||||
results := database.Query("SELECT * FROM user WHERE age > ? AND status = ?", 18, 1)
|
||||
|
||||
// 执行更新SQL
|
||||
result, err := database.Exec("UPDATE user SET last_login = NOW() WHERE id = ?", 1)
|
||||
// 执行更新SQL（原生 SQL 中也建议使用服务器时间）
|
||||
result, err := database.Exec("UPDATE user SET last_login = ? WHERE id = ?", Time2Str(time.Now()), 1)
|
||||
if err.GetError() == nil {
|
||||
affected, _ := result.RowsAffected()
|
||||
fmt.Println("影响行数:", affected)
|
||||
@@ -783,7 +977,7 @@ if err.GetError() == nil {
|
||||
| `[~~]` | 手动LIKE | `"name[~~]": "%张%"` | `name LIKE '%张%'` |
|
||||
| `[<>]` | BETWEEN | `"age[<>]": [18,60]` | `age BETWEEN 18 AND 60` |
|
||||
| `[><]` | NOT BETWEEN | `"age[><]": [18,25]` | `age NOT BETWEEN 18 AND 25` |
|
||||
| `[#]` | 直接SQL | `"time[#]": "NOW()"` | `time = NOW()` |
|
||||
| `[#]` | 直接SQL表达式 | `"balance[#]": "balance + 1"` | `balance = balance + 1` |
|
||||
| `[##]` | SQL片段 | `"[##]": "a > b"` | `a > b` |
|
||||
| `[#!]` | 不等于直接SQL | `"status[#!]": "1"` | `status != 1` |
|
||||
| `[!#]` | 不等于直接SQL | `"status[!#]": "1"` | `status != 1` |
|
||||
@@ -822,12 +1016,28 @@ A6: 使用 `nil` 作为值，查询时使用 `"field": nil` 表示 `IS NULL`。
|
||||
### Q7: PostgreSQL 和 MySQL 语法有区别吗？
|
||||
A7: 框架会自动处理差异（占位符、引号等），代码无需修改。
|
||||
|
||||
### Q8: 达梦数据库和 MySQL 的代码使用方式一样吗？
|
||||
A8: 基本一样。切换数据库类型只需修改 `Type` 字段和连接字符串，业务查询代码完全不用改。唯一需要注意的是：
|
||||
- 原生 SQL（`Query`/`Exec`）中的标识符需要手动加双引号
|
||||
- `MERGE INTO` 等 DM 特有 DDL 需要按 DM 语法书写
|
||||
- 检测表是否存在时，不要用 `USER_TABLES`，改用直接 `COUNT(*)` 查询
|
||||
|
||||
### Q9: 表名或列名用了达梦保留字怎么办？
|
||||
A9: 框架所有自动生成的 SQL 都会对标识符加双引号，无需手动处理。但在原生 SQL 中使用保留字（如 `admin`、`user`、`order`）时，必须手动加双引号，否则会报语法错误。
|
||||
|
||||
### Q10: 达梦数据库中 INSERT 后如何获取自增 ID？
|
||||
A10: 框架的 `Insert` 方法已支持从达梦原生驱动获取 `LastInsertId`，与 MySQL 使用方式完全一致：
|
||||
```go
|
||||
id := database.Insert("user", common.Map{"name": "张三"})
|
||||
fmt.Println("新插入的ID:", id)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
*文档版本: 2.0*
|
||||
*最后更新: 2026年1月*
|
||||
*文档版本: 2.1*
|
||||
*最后更新: 2026年3月*
|
||||
|
||||
> 本文档基于HoTimeDB源码分析生成，如有疑问请参考源码实现。该ORM框架参考了PHP Medoo的设计理念，但根据Golang语言特性进行了适配和优化。
|
||||
> 本文档基于HoTimeDB源码分析生成，如有疑问请参考源码实现。该ORM框架参考了PHP Medoo的设计理念，根据Golang语言特性进行了适配和优化，并新增了对达梦（DM8）国产数据库的完整支持。
|
||||
|
||||
**更多参考：**
|
||||
- [HoTimeDB API 参考](HoTimeDB_API参考.md) - API 速查手册
|
||||
|
||||
Reference in New Issue
Block a user