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

- 实现了完整的 ClickHouse 驱动，包括连接、查询、插入、更新、删除等基本操作 - 添加了 ClickHouse 特有的数据类型转换和 SQL 过滤功能 - 实现了表结构查询和字段信息获取功能 - 添加了 Ping 检查和错误处理机制 - 增加了对 UPDATE 和 DELETE 语句的语法转换以适配 ClickHouse - 添加了批量插入操作的支持 - 新增了 14 个测试用例文件用于验证数据库相关功能
2026-04-08 15:34:51 +08:00
parent 70ad831041
commit 398e732301
109 changed files with 5275 additions and 545 deletions
@@ -0,0 +1,52 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+// Package sqlitecgo implements database.Driver, which supports operations for database SQLite.
+//
+// Note:
+//  1. Using sqlitecgo is for building a 32-bit Windows operating system
+//  2. You need to set the environment variable CGO_ENABLED=1 and make sure that GCC is installed
+//     on your path. windows gcc: https://jmeubank.github.io/tdm-gcc/
+package sqlitecgo
+
+import (
+	_ "github.com/mattn/go-sqlite3"
+
+	"git.magicany.cc/black1552/gin-base/database"
+)
+
+// Driver is the driver for sqlite database.
+type Driver struct {
+	*database.Core
+}
+
+const (
+	quoteChar = "`"
+)
+
+func init() {
+	if err := database.Register(`sqlite`, New()); err != nil {
+		panic(err)
+	}
+}
+
+// New create and returns a driver that implements database.Driver, which supports operations for SQLite.
+func New() database.Driver {
+	return &Driver{}
+}
+
+// New creates and returns a database object for sqlite.
+// It implements the interface of database.Driver for extra database driver installation.
+func (d *Driver) New(core *database.Core, node *database.ConfigNode) (database.DB, error) {
+	return &Driver{
+		Core: core,
+	}, nil
+}
+
+// GetChars returns the security char for this type of database.
+func (d *Driver) GetChars() (charLeft string, charRight string) {
+	return quoteChar, quoteChar
+}
@@ -0,0 +1,29 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package sqlitecgo
+
+import (
+	"context"
+
+	"git.magicany.cc/black1552/gin-base/database"
+	"github.com/gogf/gf/v2/text/gstr"
+)
+
+// DoFilter deals with the sql string before commits it to underlying sql driver.
+func (d *Driver) DoFilter(
+	ctx context.Context, link database.Link, sql string, args []any,
+) (newSql string, newArgs []any, err error) {
+	// Special insert/ignore operation for sqlite.
+	switch {
+	case gstr.HasPrefix(sql, database.InsertOperationIgnore):
+		sql = "INSERT OR IGNORE" + sql[len(database.InsertOperationIgnore):]
+
+	case gstr.HasPrefix(sql, database.InsertOperationReplace):
+		sql = "INSERT OR REPLACE" + sql[len(database.InsertOperationReplace):]
+	}
+	return d.Core.DoFilter(ctx, link, sql, args)
+}
@@ -0,0 +1,90 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package sqlitecgo
+
+import (
+	"fmt"
+
+	"git.magicany.cc/black1552/gin-base/database"
+	"github.com/gogf/gf/v2/errors/gcode"
+	"github.com/gogf/gf/v2/errors/gerror"
+	"github.com/gogf/gf/v2/text/gstr"
+	"github.com/gogf/gf/v2/util/gconv"
+)
+
+// FormatUpsert returns SQL clause of type upsert for SQLite.
+// For example: ON CONFLICT (id) DO UPDATE SET ...
+func (d *Driver) FormatUpsert(columns []string, list database.List, option database.DoInsertOption) (string, error) {
+	if len(option.OnConflict) == 0 {
+		return "", gerror.NewCode(
+			gcode.CodeMissingParameter, `Please specify conflict columns`,
+		)
+	}
+
+	var onDuplicateStr string
+	if option.OnDuplicateStr != "" {
+		onDuplicateStr = option.OnDuplicateStr
+	} else if len(option.OnDuplicateMap) > 0 {
+		for k, v := range option.OnDuplicateMap {
+			if len(onDuplicateStr) > 0 {
+				onDuplicateStr += ","
+			}
+			switch v.(type) {
+			case database.Raw, *database.Raw:
+				onDuplicateStr += fmt.Sprintf(
+					"%s=%s",
+					d.Core.QuoteWord(k),
+					v,
+				)
+			case database.Counter, *database.Counter:
+				var counter database.Counter
+				switch value := v.(type) {
+				case database.Counter:
+					counter = value
+				case *database.Counter:
+					counter = *value
+				}
+				operator, columnVal := "+", counter.Value
+				if columnVal < 0 {
+					operator, columnVal = "-", -columnVal
+				}
+				onDuplicateStr += fmt.Sprintf(
+					"%s=EXCLUDED.%s%s%s",
+					d.QuoteWord(k),
+					d.QuoteWord(counter.Field),
+					operator,
+					gconv.String(columnVal),
+				)
+			default:
+				onDuplicateStr += fmt.Sprintf(
+					"%s=EXCLUDED.%s",
+					d.Core.QuoteWord(k),
+					d.Core.QuoteWord(gconv.String(v)),
+				)
+			}
+		}
+	} else {
+		for _, column := range columns {
+			// If it's SAVE operation, do not automatically update the creating time.
+			if d.Core.IsSoftCreatedFieldName(column) {
+				continue
+			}
+			if len(onDuplicateStr) > 0 {
+				onDuplicateStr += ","
+			}
+			onDuplicateStr += fmt.Sprintf(
+				"%s=EXCLUDED.%s",
+				d.Core.QuoteWord(column),
+				d.Core.QuoteWord(column),
+			)
+		}
+	}
+
+	conflictKeys := gstr.Join(option.OnConflict, ",")
+
+	return fmt.Sprintf("ON CONFLICT (%s) DO UPDATE SET ", conflictKeys) + onDuplicateStr, nil
+}
@@ -0,0 +1,72 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+// Package sqlitecgo implements database.Driver, which supports operations for database SQLite.
+//
+// Note:
+//  1. Using sqlitecgo is for building a 32-bit Windows operating system
+//  2. You need to set the environment variable CGO_ENABLED=1 and make sure that GCC is installed
+//     on your path. windows gcc: https://jmeubank.github.io/tdm-gcc/
+package sqlitecgo
+
+import (
+	"database/sql"
+	"fmt"
+
+	_ "github.com/mattn/go-sqlite3"
+
+	"git.magicany.cc/black1552/gin-base/database"
+	"github.com/gogf/gf/v2/encoding/gurl"
+	"github.com/gogf/gf/v2/errors/gcode"
+	"github.com/gogf/gf/v2/errors/gerror"
+	"github.com/gogf/gf/v2/os/gfile"
+	"github.com/gogf/gf/v2/text/gstr"
+	"github.com/gogf/gf/v2/util/gconv"
+)
+
+// Open creates and returns an underlying sql.DB object for sqlite.
+// https://github.com/mattn/go-sglite3
+func (d *Driver) Open(config *database.ConfigNode) (db *sql.DB, err error) {
+	var (
+		source               string
+		underlyingDriverName = "sqlite3"
+	)
+	source = config.Name
+	// It searches the source file to locate its absolute path..
+	if absolutePath, _ := gfile.Search(source); absolutePath != "" {
+		source = absolutePath
+	}
+
+	// Multiple PRAGMAs can be specified, e.g.:
+	// path/to/some.db?_pragma=busy_timeout(5000)&_pragma=journal_mode(WAL)
+	if config.Extra != "" {
+		var (
+			options  string
+			extraMap map[string]any
+		)
+		if extraMap, err = gstr.Parse(config.Extra); err != nil {
+			return nil, err
+		}
+		for k, v := range extraMap {
+			if options != "" {
+				options += "&"
+			}
+			options += fmt.Sprintf(`_pragma=%s(%s)`, k, gurl.Encode(gconv.String(v)))
+		}
+		if len(options) > 1 {
+			source += "?" + options
+		}
+	}
+
+	if db, err = sql.Open(underlyingDriverName, source); err != nil {
+		err = gerror.WrapCodef(
+			gcode.CodeDbOperationError, err,
+			`sql.Open failed for driver "%s" by source "%s"`, underlyingDriverName, source,
+		)
+		return nil, err
+	}
+	return
+}
@@ -0,0 +1,55 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+// Package sqlitecgo implements database.Driver, which supports operations for database SQLite.
+//
+// Note:
+//  1. Using sqlitecgo is for building a 32-bit Windows operating system
+//  2. You need to set the environment variable CGO_ENABLED=1 and make sure that GCC is installed
+//     on your path. windows gcc: https://jmeubank.github.io/tdm-gcc/
+package sqlitecgo
+
+import (
+	"context"
+	"fmt"
+
+	"git.magicany.cc/black1552/gin-base/database"
+	"github.com/gogf/gf/v2/util/gutil"
+)
+
+// TableFields retrieves and returns the fields' information of specified table of current schema.
+//
+// Also see DriverMysql.TableFields.
+func (d *Driver) TableFields(ctx context.Context, table string, schema ...string) (fields map[string]*database.TableField, err error) {
+	var (
+		result     database.Result
+		link       database.Link
+		usedSchema = gutil.GetOrDefaultStr(d.GetSchema(), schema...)
+	)
+	if link, err = d.SlaveLink(usedSchema); err != nil {
+		return nil, err
+	}
+	result, err = d.DoSelect(ctx, link, fmt.Sprintf(`PRAGMA TABLE_INFO(%s)`, d.QuoteWord(table)))
+	if err != nil {
+		return nil, err
+	}
+	fields = make(map[string]*database.TableField)
+	for i, m := range result {
+		mKey := ""
+		if m["pk"].Bool() {
+			mKey = "pri"
+		}
+		fields[m["name"].String()] = &database.TableField{
+			Index:   i,
+			Name:    m["name"].String(),
+			Type:    m["type"].String(),
+			Key:     mKey,
+			Default: m["dflt_value"].Val(),
+			Null:    !m["notnull"].Bool(),
+		}
+	}
+	return fields, nil
+}
@@ -0,0 +1,38 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package sqlitecgo
+
+import (
+	"context"
+
+	"git.magicany.cc/black1552/gin-base/database"
+)
+
+const (
+	tablesSqlTmp = `SELECT NAME FROM SQLITE_MASTER WHERE TYPE='table' ORDER BY NAME`
+)
+
+// Tables retrieves and returns the tables of current schema.
+// It's mainly used in cli tool chain for automatically generating the models.
+func (d *Driver) Tables(ctx context.Context, schema ...string) (tables []string, err error) {
+	var result database.Result
+	link, err := d.SlaveLink(schema...)
+	if err != nil {
+		return nil, err
+	}
+
+	result, err = d.DoSelect(ctx, link, tablesSqlTmp)
+	if err != nil {
+		return
+	}
+	for _, m := range result {
+		for _, v := range m {
+			tables = append(tables, v.String())
+		}
+	}
+	return
+}