black1552/gin-base
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 65 Wiki Activity

feat(database): 添加 ClickHouse 数据库驱动支持

Browse Source 
- 实现了完整的 ClickHouse 驱动，包括连接、查询、插入、更新、删除等基本操作
- 添加了 ClickHouse 特有的数据类型转换和 SQL 过滤功能
- 实现了表结构查询和字段信息获取功能
- 添加了 Ping 检查和错误处理机制
- 增加了对 UPDATE 和 DELETE 语句的语法转换以适配 ClickHouse
- 添加了批量插入操作的支持
- 新增了 14 个测试用例文件用于验证数据库相关功能
This commit is contained in:
maguodong
2026-04-08 15:34:51 +08:00
parent 70ad831041
commit 398e732301
109 changed files with 5275 additions and 545 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/gf-source/README.md
+69
View File
@@ -0,0 +1,69 @@
# GF-Source 自维护代码
这个目录包含了从 GoFrame (GF) 框架复制并修改的 DAO 生成工具源码，已将所有 `gdb` 相关引用替换为项目自定义的 `database` 包。
## 📁 目录结构
```
gf-source/
├── internal/ # 内部工具包
│ ├── consts/ # 常量定义（从 GF internal/consts 复制）
│ └── utility/ # 工具函数
│ ├── mlog/ # 日志工具
│ └── utils/ # 通用工具
├── templates/ # 代码生成模板
│ ├── consts_gen_dao_template_dao.go
│ ├── consts_gen_dao_template_do.go
│ ├── consts_gen_dao_template_entity.go
│ └── consts_gen_dao_template_table.go
├── gendao*.go # DAO 生成核心逻辑
├── go.mod # 子模块依赖
└── go.sum
```
## 🔧 主要修改
### 1. 数据库接口替换
- ✅ `github.com/gogf/gf/v2/database/gdb` → `git.magicany.cc/black1552/gin-base/database`
- ✅ `gdb.DB` → `database.DB`
- ✅ `gdb.ConfigNode` → `database.ConfigNode`
- ✅ `gdb.AddConfigNode()` → `database.AddConfigNode()`
- ✅ `gdb.Instance()` → `database.Instance()`
- ✅ `g.DB()` → `database.Database()`
### 2. 内部包路径修改
- ✅ `github.com/gogf/gf/cmd/gf/v2/internal/consts` → `git.magicany.cc/black1552/gin-base/cmd/gf-source/internal/consts`
- ✅ `github.com/gogf/gf/cmd/gf/v2/internal/utility/mlog` → `git.magicany.cc/black1552/gin-base/cmd/gf-source/internal/utility/mlog`
- ✅ `github.com/gogf/gf/cmd/gf/v2/internal/utility/utils` → `git.magicany.cc/black1552/gin-base/cmd/gf-source/internal/utility/utils`
### 3. 包名统一
- ✅ 所有 gendao 相关文件统一为 `package gendao`
- ✅ 模板文件移至 `templates/` 子目录（避免包名冲突）
## 📦 编译
```bash
cd cmd/gf-source
go build .
```
## ⚠️ 注意事项
1. **这是参考代码**：这个目录主要用于参考 GF 的 DAO 生成逻辑，实际使用的是 `cmd/gin-dao-gen/main.go`
2. **不要直接导入**：这个子模块有独立的 go.mod，不应该被主项目直接导入
3. **保持同步**：如果 GF 更新了 DAO 生成逻辑，需要手动同步这些文件并重新应用修改
## 🔄 更新流程
如果需要从 GF 更新代码：
1. 从 `D:\web-object\gf\cmd\gf\internal\cmd\gendao` 复制最新文件
2. 运行批量替换脚本将 `gdb` 改为 `database`
3. 运行批量替换脚本将 internal 路径改为本项目路径
4. 测试编译确保没有错误
## 📝 相关文件
- 主程序：`cmd/gin-dao-gen/main.go`
- 数据库包：`database/`
- 配置文件：`config/config.toml`
cmd/gf-source/go.mod
+12
View File
@@ -0,0 +1,12 @@
module git.magicany.cc/black1552/gin-base/cmd/gf-source
go 1.25.0
require (
git.magicany.cc/black1552/gin-base v0.0.0
github.com/gogf/gf/v2 v2.10.0
github.com/olekukonko/tablewriter v1.1.4
golang.org/x/mod v0.33.0
)
replace git.magicany.cc/black1552/gin-base => ../..
cmd/gf-source/internal/consts/consts_gen_dao_template_dao.go
+12 -13
View File
@@ -15,6 +15,7 @@ package {{.TplPackageName}}
import (
"{{.TplImportPrefix}}/internal"
"git.magicany.cc/black1552/gin-base/database"
)
// {{.TplTableNameCamelLowerCase}}Dao is the data access object for the table {{.TplTableName}}.
@@ -37,16 +38,16 @@ var (
{{if .TplTableSharding -}}
// {{.TplTableNameCamelLowerCase}}ShardingHandler is the handler for sharding operations.
// You can fill this sharding handler with your custom implementation.
func {{.TplTableNameCamelLowerCase}}ShardingHandler(m *gdb.Model) *gdb.Model {
m = m.Sharding(gdb.ShardingConfig{
Table: gdb.ShardingTableConfig{
func {{.TplTableNameCamelLowerCase}}ShardingHandler(m *database.Model) *database.Model {
m = m.Sharding(database.ShardingConfig{
Table: database.ShardingTableConfig{
Enable: true,
Prefix: "{{.TplTableShardingPrefix}}",
// Replace Rule field with your custom sharding rule.
// Or you can use "&gdb.DefaultShardingRule{}" for default sharding rule.
Rule: nil,
},
Schema: gdb.ShardingSchemaConfig{},
Schema: database.ShardingSchemaConfig{},
})
return m
}
@@ -65,9 +66,7 @@ package internal
import (
"context"
"github.com/gogf/gf/v2/database/gdb"
"github.com/gogf/gf/v2/frame/g"
"git.magicany.cc/black1552/gin-base/database"
)
// {{.TplTableNameCamelCase}}Dao is the data access object for the table {{.TplTableName}}.
@@ -75,7 +74,7 @@ type {{.TplTableNameCamelCase}}Dao struct {
table string // table is the underlying table name of the DAO.
group string // group is the database configuration group name of the current DAO.
columns {{.TplTableNameCamelCase}}Columns // columns contains all the column names of Table for convenient usage.
handlers []gdb.ModelHandler // handlers for customized model modification.
handlers []database.ModelHandler // handlers for customized model modification.
}
// {{.TplTableNameCamelCase}}Columns defines and stores column names for the table {{.TplTableName}}.
@@ -89,7 +88,7 @@ var {{.TplTableNameCamelLowerCase}}Columns = {{.TplTableNameCamelCase}}Columns{
}
// New{{.TplTableNameCamelCase}}Dao creates and returns a new DAO object for table data access.
func New{{.TplTableNameCamelCase}}Dao(handlers ...gdb.ModelHandler) *{{.TplTableNameCamelCase}}Dao {
func New{{.TplTableNameCamelCase}}Dao(handlers ...database.ModelHandler) *{{.TplTableNameCamelCase}}Dao {
return &{{.TplTableNameCamelCase}}Dao{
group: "{{.TplGroupName}}",
table: "{{.TplTableName}}",
@@ -99,8 +98,8 @@ func New{{.TplTableNameCamelCase}}Dao(handlers ...gdb.ModelHandler) *{{.TplTable
}
// DB retrieves and returns the underlying raw database management object of the current DAO.
func (dao *{{.TplTableNameCamelCase}}Dao) DB() gdb.DB {
return g.DB(dao.group)
func (dao *{{.TplTableNameCamelCase}}Dao) DB() database.DB {
return database.Database(dao.group)
}
// Table returns the table name of the current DAO.
@@ -119,7 +118,7 @@ func (dao *{{.TplTableNameCamelCase}}Dao) Group() string {
}
// Ctx creates and returns a Model for the current DAO. It automatically sets the context for the current operation.
func (dao *{{.TplTableNameCamelCase}}Dao) Ctx(ctx context.Context) *gdb.Model {
func (dao *{{.TplTableNameCamelCase}}Dao) Ctx(ctx context.Context) *database.Model {
model := dao.DB().Model(dao.table)
for _, handler := range dao.handlers {
model = handler(model)
@@ -133,7 +132,7 @@ func (dao *{{.TplTableNameCamelCase}}Dao) Ctx(ctx context.Context) *gdb.Model {
//
// Note: Do not commit or roll back the transaction in function f,
// as it is automatically handled by this function.
func (dao *{{.TplTableNameCamelCase}}Dao) Transaction(ctx context.Context, f func(ctx context.Context, tx gdb.TX) error) (err error) {
func (dao *{{.TplTableNameCamelCase}}Dao) Transaction(ctx context.Context, f func(ctx context.Context, tx database.TX) error) (err error) {
return dao.Ctx(ctx).Transaction(ctx, f)
}
`
cmd/gf-source/internal/consts/consts_gen_dao_template_entity.go
+1 -1
View File
@@ -8,7 +8,7 @@ package consts
const TemplateGenDaoEntityContent = `
// =================================================================================
// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT. {{.TplCreatedAtDatetimeStr}}
// Code generated and maintained by Gen CLI tool. DO NOT EDIT. {{.TplCreatedAtDatetimeStr}}
// =================================================================================
package {{.TplPackageName}}
cmd/gf-source/internal/consts/consts_gen_dao_template_table.go
+3 -4
View File
@@ -15,20 +15,19 @@ package {{.TplPackageName}}
import (
"context"
"github.com/gogf/gf/v2/database/gdb"
"git.magicany.cc/black1552/gin-base/database"
)
// {{.TplTableNameCamelCase}} defines the fields of table "{{.TplTableName}}" with their properties.
// This map is used internally by GoFrame ORM to understand table structure.
var {{.TplTableNameCamelCase}} = map[string]*gdb.TableField{
var {{.TplTableNameCamelCase}} = map[string]*database.TableField{
{{.TplTableFields}}
}
// Set{{.TplTableNameCamelCase}}TableFields registers the table fields definition to the database instance.
// db: database instance that implements gdb.DB interface.
// schema: optional schema/namespace name, especially for databases that support schemas.
func Set{{.TplTableNameCamelCase}}TableFields(ctx context.Context, db gdb.DB, schema ...string) error {
func Set{{.TplTableNameCamelCase}}TableFields(ctx context.Context, db database.DB, schema ...string) error {
return db.GetCore().SetTableFields(ctx, "{{.TplTableName}}", {{.TplTableNameCamelCase}}, schema...)
}
cmd/gf-source/templates/consts_gen_dao_template_dao.go
+1 -2
View File
@@ -67,7 +67,6 @@ import (
"context"
"git.magicany.cc/black1552/gin-base/database"
"github.com/gogf/gf/v2/frame/g"
)
// {{.TplTableNameCamelCase}}Dao is the data access object for the table {{.TplTableName}}.
@@ -100,7 +99,7 @@ func New{{.TplTableNameCamelCase}}Dao(handlers ...database.ModelHandler) *{{.Tpl
// DB retrieves and returns the underlying raw database management object of the current DAO.
func (dao *{{.TplTableNameCamelCase}}Dao) DB() database.DB {
return g.DB(dao.group)
return database.Database(dao.group)
}
// Table returns the table name of the current DAO.
cmd/gf-source/templates/consts_gen_dao_template_table.go
-1
View File
@@ -31,5 +31,4 @@ var {{.TplTableNameCamelCase}} = map[string]*database.TableField{
func Set{{.TplTableNameCamelCase}}TableFields(ctx context.Context, db database.DB, schema ...string) error {
return db.GetCore().SetTableFields(ctx, "{{.TplTableName}}", {{.TplTableNameCamelCase}}, schema...)
}
`