mirror of
https://gitee.com/dromara/mayfly-go
synced 2025-11-03 16:00:25 +08:00
224 lines
7.3 KiB
Go
224 lines
7.3 KiB
Go
package dbi
|
||
|
||
import (
|
||
"embed"
|
||
"fmt"
|
||
"mayfly-go/pkg/biz"
|
||
"mayfly-go/pkg/utils/collx"
|
||
"mayfly-go/pkg/utils/stringx"
|
||
"strings"
|
||
)
|
||
|
||
// Metadata 元数据接口（表、列、等元信息）
|
||
type Metadata interface {
|
||
|
||
// GetDbServer 获取数据库服务实例信息
|
||
GetDbServer() (*DbServer, error)
|
||
|
||
// GetCompatibleDbVersion 获取兼容版本信息，如果有兼容版本，则需要实现对应版本的特殊方言处理器，以及前端的方言兼容版本
|
||
GetCompatibleDbVersion() DbVersion
|
||
|
||
// GetDefaultDb 获取默认库
|
||
GetDefaultDb() string
|
||
|
||
// GetSchemas
|
||
GetSchemas() ([]string, error)
|
||
|
||
// GetDbNames 获取数据库名称列表
|
||
GetDbNames() ([]string, error)
|
||
|
||
// GetTables 获取表信息
|
||
GetTables(tableNames ...string) ([]Table, error)
|
||
|
||
// GetColumns 获取指定表名的所有列元信息
|
||
GetColumns(tableNames ...string) ([]Column, error)
|
||
|
||
// GetPrimaryKey 获取表主键字段名，没有主键标识则默认第一个字段
|
||
GetPrimaryKey(tableName string) (string, error)
|
||
|
||
// GetTableIndex 获取表索引信息
|
||
GetTableIndex(tableName string) ([]Index, error)
|
||
|
||
// GetTableDDL 获取建表ddl
|
||
GetTableDDL(tableName string, dropBeforeCreate bool) (string, error)
|
||
}
|
||
|
||
// 默认实现，若需要覆盖，则由各个数据库MetaData实现去覆盖重写
|
||
type DefaultMetadata struct {
|
||
}
|
||
|
||
func (dd *DefaultMetadata) GetCompatibleDbVersion() DbVersion {
|
||
return ""
|
||
}
|
||
|
||
func (dd *DefaultMetadata) GetDefaultDb() string {
|
||
return ""
|
||
}
|
||
|
||
// GenerateSQLStepFunc 生成insert sql的step函数，用于生成insert sql时，每生成100条sql时调用
|
||
type GenerateSQLStepFunc func(sqlArr []string)
|
||
|
||
// 数据库服务实例信息
|
||
type DbServer struct {
|
||
Version string `json:"version"` // 版本信息
|
||
Extra collx.M `json:"extra"` // 其他额外信息
|
||
}
|
||
|
||
// 表信息
|
||
type Table struct {
|
||
TableName string `json:"tableName"` // 表名
|
||
TableComment string `json:"tableComment"` // 表备注
|
||
CreateTime string `json:"createTime"` // 创建时间
|
||
TableRows int `json:"tableRows"`
|
||
DataLength int64 `json:"dataLength"`
|
||
IndexLength int64 `json:"indexLength"`
|
||
}
|
||
|
||
// 表的列信息
|
||
type Column struct {
|
||
TableName string `json:"tableName"` // 表名
|
||
ColumnName string `json:"columnName"` // 列名
|
||
DataType ColumnDataType `json:"dataType"` // 数据类型
|
||
ColumnComment string `json:"columnComment"` // 列备注
|
||
IsPrimaryKey bool `json:"isPrimaryKey"` // 是否为主键
|
||
IsIdentity bool `json:"isIdentity"` // 是否自增
|
||
ColumnDefault string `json:"columnDefault"` // 默认值
|
||
Nullable bool `json:"nullable"` // 是否可为null
|
||
CharMaxLength int `json:"charMaxLength"` // 字符最大长度
|
||
NumPrecision int `json:"numPrecision"` // 精度(总数字位数)
|
||
NumScale int `json:"numScale"` // 小数点位数
|
||
Extra collx.M `json:"extra"` // 其他额外信息
|
||
}
|
||
|
||
// 拼接数据类型与长度等。如varchar(2000)，decimal(20,2)
|
||
func (c *Column) GetColumnType() string {
|
||
// 哪些mysql数据类型不需要添加字段长度
|
||
if collx.ArrayAnyMatches([]string{"int", "blob", "float", "double", "date", "year", "json"}, string(c.DataType)) {
|
||
return string(c.DataType)
|
||
}
|
||
if c.DataType == "timestamp" {
|
||
return "timestamp(6)"
|
||
}
|
||
if c.CharMaxLength > 0 {
|
||
return fmt.Sprintf("%s(%d)", c.DataType, c.CharMaxLength)
|
||
}
|
||
if c.NumPrecision > 0 {
|
||
if c.NumScale > 0 {
|
||
return fmt.Sprintf("%s(%d,%d)", c.DataType, c.NumPrecision, c.NumScale)
|
||
} else {
|
||
return fmt.Sprintf("%s(%d)", c.DataType, c.NumPrecision)
|
||
}
|
||
}
|
||
|
||
return string(c.DataType)
|
||
}
|
||
|
||
// 表索引信息
|
||
type Index struct {
|
||
IndexName string `json:"indexName"` // 索引名
|
||
ColumnName string `json:"columnName"` // 列名
|
||
IndexType string `json:"indexType"` // 索引类型
|
||
IndexComment string `json:"indexComment"` // 备注
|
||
SeqInIndex int `json:"seqInIndex"`
|
||
IsUnique bool `json:"isUnique"`
|
||
IsPrimaryKey bool `json:"isPrimaryKey"` // 是否是主键索引，某些情况需要判断并过滤掉主键索引
|
||
}
|
||
|
||
type ColumnDataType string
|
||
|
||
const (
|
||
CommonTypeVarchar ColumnDataType = "varchar"
|
||
CommonTypeChar ColumnDataType = "char"
|
||
CommonTypeText ColumnDataType = "text"
|
||
CommonTypeBlob ColumnDataType = "blob"
|
||
CommonTypeLongblob ColumnDataType = "longblob"
|
||
CommonTypeLongtext ColumnDataType = "longtext"
|
||
CommonTypeBinary ColumnDataType = "binary"
|
||
CommonTypeMediumblob ColumnDataType = "mediumblob"
|
||
CommonTypeMediumtext ColumnDataType = "mediumtext"
|
||
CommonTypeVarbinary ColumnDataType = "varbinary"
|
||
|
||
CommonTypeInt ColumnDataType = "int"
|
||
CommonTypeBit ColumnDataType = "bit"
|
||
CommonTypeSmallint ColumnDataType = "smallint"
|
||
CommonTypeTinyint ColumnDataType = "tinyint"
|
||
CommonTypeNumber ColumnDataType = "number"
|
||
CommonTypeBigint ColumnDataType = "bigint"
|
||
|
||
CommonTypeDatetime ColumnDataType = "datetime"
|
||
CommonTypeDate ColumnDataType = "date"
|
||
CommonTypeTime ColumnDataType = "time"
|
||
CommonTypeTimestamp ColumnDataType = "timestamp"
|
||
|
||
CommonTypeEnum ColumnDataType = "enum"
|
||
CommonTypeJSON ColumnDataType = "json"
|
||
)
|
||
|
||
type DataType string
|
||
|
||
const (
|
||
DataTypeString DataType = "string"
|
||
DataTypeNumber DataType = "number"
|
||
DataTypeDate DataType = "date"
|
||
DataTypeTime DataType = "time"
|
||
DataTypeDateTime DataType = "datetime"
|
||
DataTypeBlob DataType = "blob"
|
||
)
|
||
|
||
// 列数据处理帮助方法
|
||
type DataHelper interface {
|
||
// 获取数据对应的类型
|
||
// @param dbColumnType 数据库原始列类型，如varchar等
|
||
GetDataType(dbColumnType string) DataType
|
||
|
||
// 根据数据类型格式化指定数据
|
||
FormatData(dbColumnValue any, dataType DataType) string
|
||
|
||
// 根据数据类型解析数据为符合要求的指定类型等
|
||
ParseData(dbColumnValue any, dataType DataType) any
|
||
|
||
// WrapValue 根据数据类型包装value，如：
|
||
// 1.数字型：不需要引号，
|
||
// 2.文本型：需要用引号包裹，单引号需要转义，换行符转义,
|
||
// 3.date型：需要格式化成对应的字符串，如：time：hh:mm:ss.SSS date: yyyy-mm-dd datetime:
|
||
// 4.特殊：oracle date型需要用函数包裹：to_timestamp('%s', 'yyyy-mm-dd hh24:mi:ss')
|
||
WrapValue(dbColumnValue any, dataType DataType) string
|
||
}
|
||
|
||
// ------------------------- 元数据sql操作 -------------------------
|
||
//
|
||
//go:embed metasql/*
|
||
var metasql embed.FS
|
||
|
||
// sql缓存 key: sql备注的key 如：MYSQL_TABLE_MA value: sql内容
|
||
var sqlCache = make(map[string]string, 20)
|
||
|
||
// 获取本地文件的sql内容，并进行解析，获取对应key的sql内容
|
||
func GetLocalSql(file, key string) string {
|
||
sql := sqlCache[key]
|
||
if sql != "" {
|
||
return sql
|
||
}
|
||
|
||
bytes, err := metasql.ReadFile(file)
|
||
biz.ErrIsNilAppendErr(err, "failed to get the contents of the sql meta file: %s")
|
||
allSql := string(bytes)
|
||
|
||
sqls := strings.Split(allSql, "---------------------------------------")
|
||
var resSql string
|
||
for _, sql := range sqls {
|
||
sql = stringx.TrimSpaceAndBr(sql)
|
||
// 获取sql第一行的sql备注信息如：--MYSQL_TABLE_MA 表信息元数据
|
||
info := strings.SplitN(sql, "\n", 2)
|
||
// 原始sql，即去除第一行的key与备注信息
|
||
rowSql := info[1]
|
||
// 获取sql key；如：MYSQL_TABLE_MA
|
||
sqlKey := strings.Split(strings.Split(info[0], " ")[0], "--")[1]
|
||
if key == sqlKey {
|
||
resSql = rowSql
|
||
}
|
||
sqlCache[sqlKey] = rowSql
|
||
}
|
||
return resSql
|
||
}
|