Documentation
¶
Index ¶
- Variables
- func EscapeLikeValue(value string) string
- func Exist(tx *gorm.DB, query any, args ...any) (exist bool, err error)
- func SaveOrCreate[T Modeler](tx *gorm.DB, create, save T, query any, args ...any) (T, error)
- func ToModel[model Modeler](db *gorm.DB, attrs ...ModelAttr) *gorm.DB
- func ToModelG[T Modeler](db *gorm.DB, attrs ...GenericAttr[T]) gorm.ChainInterface[T]
- func UpdateColumnsOrCreate[T Modeler](tx *gorm.DB, create T, update, query any, args ...any) (T, error)
- func UpdatesOrCreate[T Modeler](tx *gorm.DB, create T, update, query any, args ...any) (T, error)
- type ArSQLEndpoint
- type ArSQLSetting
- type AttrDistinct
- type AttrJoins
- type AttrPreload
- type AttrPreloadMap
- type AttrScopes
- type AttrSelect
- type AttrTable
- type Common
- type Condition
- type DBSetting
- type DSN
- type Finder
- type FinderCondition
- type FinderG
- func (my *FinderG[T]) Count(ctx context.Context) (int64, error)
- func (my *FinderG[T]) Error() error
- func (my *FinderG[T]) Ex(functions ...func(db *gorm.Statement)) *FinderG[T]
- func (my *FinderG[T]) Find(ctx context.Context) ([]T, error)
- func (my *FinderG[T]) FindOnlyCondition(ctx context.Context, finderCondition *FinderCondition) ([]T, *FinderG[T], error)
- func (my *FinderG[T]) FindUseCondition(ctx context.Context, finderCondition *FinderCondition, page, size int) ([]T, *FinderG[T], error)
- func (my *FinderG[T]) First(ctx context.Context) (T, error)
- func (my *FinderG[T]) GetChain() gorm.ChainInterface[T]
- func (my *FinderG[T]) GetTotal() int64
- func (my *FinderG[T]) Not(query any, args ...any) *FinderG[T]
- func (my *FinderG[T]) Or(query any, args ...any) *FinderG[T]
- func (my *FinderG[T]) QueryUseCondition(finderCondition *FinderCondition) *FinderG[T]
- func (my *FinderG[T]) SetTotal(total int64) *FinderG[T]
- func (my *FinderG[T]) StatisticOnlyCondition(ctx context.Context, finderCondition *FinderCondition, ret any) error
- func (my *FinderG[T]) Transaction(functions ...func(db *gorm.DB)) error
- func (my *FinderG[T]) TryOrder(orders ...string) *FinderG[T]
- func (my *FinderG[T]) TryPagination(page, size int) *FinderG[T]
- func (my *FinderG[T]) TryPreload(preloads ...string) *FinderG[T]
- func (my *FinderG[T]) TryQuery(mode string, fieldName string, values ...any) *FinderG[T]
- func (my *FinderG[T]) When(condition bool, query any, args ...any) *FinderG[T]
- func (my *FinderG[T]) WhenBetween(condition bool, query any, args ...any) *FinderG[T]
- func (my *FinderG[T]) WhenFunc(condition bool, fn func(db *gorm.Statement)) *FinderG[T]
- func (my *FinderG[T]) WhenIn(condition bool, query any, args any) *FinderG[T]
- func (my *FinderG[T]) WhenLike(condition bool, query, arg any) *FinderG[T]
- func (my *FinderG[T]) WhenLikeLeft(condition bool, query, arg any) *FinderG[T]
- func (my *FinderG[T]) WhenLikeRight(condition bool, query, arg any) *FinderG[T]
- func (my *FinderG[T]) WhenNotBetween(condition bool, query any, args ...any) *FinderG[T]
- func (my *FinderG[T]) WhenNotIn(condition bool, query any, args any) *FinderG[T]
- func (my *FinderG[T]) Where(query any, args ...any) *FinderG[T]
- type FinderImpl
- func (my *FinderImpl) Error() error
- func (my *FinderImpl) Ex(functions ...func(db *gorm.DB)) Finder
- func (my *FinderImpl) Find(ret any, preloads ...string) Finder
- func (my *FinderImpl) FindOnlyCondition(finderCondition *FinderCondition, ret any) Finder
- func (my *FinderImpl) FindUseCondition(finderCondition *FinderCondition, page, size int, ret any) Finder
- func (my *FinderImpl) FindUseMap(queries map[string][]any, preloads []string, orders []string, page, size int, ...) Finder
- func (my *FinderImpl) GetDB() *gorm.DB
- func (my *FinderImpl) GetTotal() int64
- func (my *FinderImpl) QueryUseCondition(finderCondition *FinderCondition) Finder
- func (my *FinderImpl) QueryUseMap(queries map[string][]any) Finder
- func (my *FinderImpl) SetTotal(total int64) Finder
- func (my *FinderImpl) StatisticOnlyCondition(finderCondition *FinderCondition, ret any) Finder
- func (my *FinderImpl) Transaction(functions ...func(db *gorm.DB)) error
- func (my *FinderImpl) TryOrder(orders ...string) Finder
- func (my *FinderImpl) TryPagination(page, size int) Finder
- func (my *FinderImpl) TryPreload(preloads ...string) Finder
- func (my *FinderImpl) TryQuery(mode string, fieldName string, values ...any)
- func (my *FinderImpl) When(condition bool, query any, args ...any) Finder
- func (my *FinderImpl) WhenBetween(condition bool, query any, args ...any) Finder
- func (my *FinderImpl) WhenFunc(condition bool, fn func(db *gorm.DB)) Finder
- func (my *FinderImpl) WhenIn(condition bool, query any, args any) Finder
- func (my *FinderImpl) WhenInPtr(condition bool, query any, args any) Finder
- func (my *FinderImpl) WhenLike(condition bool, query, arg any) Finder
- func (my *FinderImpl) WhenLikeLeft(condition bool, query, arg any) Finder
- func (my *FinderImpl) WhenLikeRight(condition bool, query, arg any) Finder
- func (my *FinderImpl) WhenNotBetween(condition bool, query any, args ...any) Finder
- func (my *FinderImpl) WhenNotIn(condition bool, query any, args any) Finder
- func (my *FinderImpl) WhenNotInPtr(condition bool, query any, args any) Finder
- type GORMPool
- type GenericAttr
- func GDistinct[T any](args ...any) GenericAttr[T]
- func GJoins[T any](join string, args ...any) GenericAttr[T]
- func GPreload[T any](association string, query func(db gorm.PreloadBuilder) error) GenericAttr[T]
- func GPreloadMap[T any](preloadMap map[string]func(db gorm.PreloadBuilder) error) GenericAttr[T]
- func GScopes[T any](scopes ...func(db *gorm.Statement)) GenericAttr[T]
- func GSelect[T any](query string, args ...any) GenericAttr[T]
- func GTable[T Modeler](alias string) GenericAttr[T]
- type MSSQLEndpoint
- type MSSQLSetting
- type ModelAttr
- type Modeler
- type MySQLBasic
- type MySQLEndpoint
- type MySQLSetting
- type PGEndpoint
- type PGSetting
- type Query
Constants ¶
This section is empty.
Variables ¶
var APP struct { DBSetting DBSetting }
Functions ¶
func EscapeLikeValue ¶ added in v2.16.12
EscapeLikeValue 转义 like 值中的通配符 %、_ 与转义符 \ 前端传入的模糊查询值必须先转义,否则用户可自行控制通配符: 1. 传入 % 会使右模糊(like%)退化为全列匹配,索引失效引发全表扫描 2. 传入 \ 会吃掉拼接的 %,篡改匹配语义(MySQL/PG 中 \ 为默认转义符) 配套 SQL 必须声明 escape '\'(MySQL/PG 与默认一致,SQL Server 无默认转义符必须显式声明)
func SaveOrCreate ¶
func ToModelG ¶ added in v2.16.15
func ToModelG[T Modeler](db *gorm.DB, attrs ...GenericAttr[T]) gorm.ChainInterface[T]
ToModelG 绑定泛型模型并应用属性,返回 gorm.ChainInterface[T]
返回 ChainInterface[T]:覆盖 Where/Order/Limit/Find/First/Count 等查询能力。 如需 Create,请直接使用 gorm.G[T](db).Create(ctx, &obj)。
示例:
chain := ToModelG[TestTable1](db, GTable[TestTable1]("t"), GSelect[TestTable1]("id,name"))
list, err := chain.Where("id = ?", 1).Find(ctx) // list 类型为 []TestTable1
func UpdateColumnsOrCreate ¶
Types ¶
type ArSQLEndpoint ¶
type ArSQLSetting ¶
type ArSQLSetting struct {
Database string `json:"database" yaml:"database"`
Rws bool `json:"rws" yaml:"rws"`
Main *MySQLEndpoint `json:"main" yaml:"main"`
Sources map[string]*ArSQLEndpoint `json:"sources" yaml:"sources"`
Replicas map[string]*ArSQLEndpoint `json:"replicas" yaml:"replicas"`
}
type AttrDistinct ¶
type AttrDistinct struct {
// contains filtered or unexported fields
}
func Distinct ¶
func Distinct(args ...any) AttrDistinct
type AttrPreload ¶
type AttrPreload struct {
// contains filtered or unexported fields
}
func Preload ¶
func Preload(preload string, args ...any) AttrPreload
type AttrPreloadMap ¶
type AttrPreloadMap struct {
// contains filtered or unexported fields
}
func PreloadMap ¶
func PreloadMap(preloadMap map[string][]any) AttrPreloadMap
type AttrScopes ¶ added in v2.9.9
type AttrScopes struct {
// contains filtered or unexported fields
}
type AttrSelect ¶
type AttrSelect struct {
// contains filtered or unexported fields
}
func Select ¶
func Select(query any, args ...any) AttrSelect
type Common ¶
type Common struct {
Driver string `json:"driver" yaml:"driver"`
MaxOpenConnections int `json:"max-open-connections" yaml:"max-open-connections"`
MaxIdleConnections int `json:"max-idle-connections" yaml:"max-idle-connections"`
MaxLifetime int `json:"max-lifetime" yaml:"max-lifetime"`
MaxIdleTime int `json:"max-idle-timers" yaml:"max-idle-timers"`
}
type Condition ¶
type Condition struct {
Key string `json:"key"` // SQL字段名称,如果有别名则需要带有别名
Operator string `json:"operator"` // 操作符:=、>、<、!=、<=、>=、<>、in、not in、between、not between、like、like%、%like、raw、join
Values []any `json:"values"` // 查询条件值
}
Condition 查询
type DBSetting ¶
type DBSetting struct {
Common *Common `json:"common,omitempty" yaml:"common,omitempty"`
MySQL *MySQLSetting `json:"mysql" yaml:"mysql,omitempty"`
Postgres *PGSetting `json:"postgres" yaml:"postgres,omitempty"`
SQLServer *MSSQLSetting `json:"sql-server" yaml:"sql-server,omitempty"`
ArSQL *ArSQLSetting `json:"ar-sql" yaml:"ar-sql,omitempty"`
}
func (*DBSetting) ExampleYaml ¶
type Finder ¶
type Finder interface {
GetDB() *gorm.DB
Find(ret any, preloads ...string) Finder
Ex(functions ...func(db *gorm.DB)) Finder
TryPagination(page, size int) Finder
TryOrder(orders ...string) Finder
TryPreload(preloads ...string) Finder
TryQuery(mode string, fieldName string, values ...any)
SetTotal(total int64) Finder
GetTotal() int64
When(condition bool, query any, args ...any) Finder
WhenIn(condition bool, query any, args any) Finder
WhenInPtr(condition bool, query any, args any) Finder
WhenNotIn(condition bool, query any, args any) Finder
WhenNotInPtr(condition bool, query any, args any) Finder
WhenBetween(condition bool, query any, args ...any) Finder
WhenNotBetween(condition bool, query any, args ...any) Finder
WhenLike(condition bool, query, arg any) Finder
WhenLikeLeft(condition bool, query, arg any) Finder
WhenLikeRight(condition bool, query, arg any) Finder
WhenFunc(condition bool, fn func(db *gorm.DB)) Finder
Transaction(functions ...func(db *gorm.DB)) error
QueryUseMap(queries map[string][]any) Finder
QueryUseCondition(finderCondition *FinderCondition) Finder
FindUseMap(queries map[string][]any, preloads []string, orders []string, page, size int, ret any) Finder
FindUseCondition(finderCondition *FinderCondition, page, size int, ret any) Finder
FindOnlyCondition(finderCondition *FinderCondition, ret any) Finder
StatisticOnlyCondition(finderCondition *FinderCondition, ret any) Finder
Error() error
}
type FinderCondition ¶
type FinderCondition struct {
Table *string `json:"table,omitempty"` // 已忽略:表名由服务端模型决定,不再参与SQL拼接
Queries []Query `json:"queries,omitempty"` // 查询条件
Orders []string `json:"orders,omitempty"` // 排序
Preloads []string `json:"preloads,omitempty"` // 预加载
Page int `json:"page,omitempty"` // 页码
PageSize int `json:"page_size,omitempty"` // 页容量
AllowFields []string `json:"-"` // 字段白名单:由服务端在调用前填充,客户端不可注入;为空时仅做标识符格式校验
}
FinderCondition 查询条件
func WithAllowFields ¶ added in v2.16.14
func WithAllowFields(condition *FinderCondition, model any, exFields ...string) *FinderCondition
WithAllowFields 依据模型列名填充 FinderCondition.AllowFields 白名单 condition 为 nil 时返回 nil;同时放行 "<表名>.<列名>" 形式以兼容带别名的查询条件
func WithAllowFieldsAlias ¶ added in v2.16.14
func WithAllowFieldsAlias(condition *FinderCondition, model any, alias string, exFields ...string) *FinderCondition
WithAllowFieldsAlias 同 WithAllowFields,额外按指定别名放行 "<别名>.<列名>" 形式, 用于查询使用 Table("table as alias") 的场景
type FinderG ¶ added in v2.16.15
type FinderG[T any] struct { // contains filtered or unexported fields }
FinderG 泛型查询帮助器,包装 gorm.ChainInterface[T]
与传统 Finder 的差异:
- finisher 方法(Find/First/Count)直接返回 (结果, error),而非通过 Error() 获取
- WhenFunc / Ex 回调参数为 *gorm.Statement(泛型 Scopes 签名,Statement 嵌入 *DB,可直接调用 DB 方法)
- 校验类错误(如 TryOrder)通过底层 *gorm.DB.AddError 传递,finisher 自动返回
func ToFinderG ¶ added in v2.16.15
func ToFinderG[T Modeler](db *gorm.DB, attrs ...GenericAttr[T]) *FinderG[T]
ToFinderG 绑定泛型模型并应用属性,返回 *FinderG[T]
func (*FinderG[T]) Error ¶ added in v2.16.17
Error 返回客户端校验类错误(如 TryOrder 校验失败)
注意:SQL 执行类错误由 Find/First/Count 等 finisher 方法直接返回。
func (*FinderG[T]) Ex ¶ added in v2.16.17
Ex 额外操作,回调参数为 *gorm.Statement(嵌入 *gorm.DB,可直接调用 DB 方法)
与传统 Finder.Ex(func(db *gorm.DB)) 对应;泛型 API 中通过 Scopes 注入, 回调内可用 stmt.DB 访问底层 *gorm.DB,或直接使用 stmt 的 Statement 级方法。
func (*FinderG[T]) FindOnlyCondition ¶ added in v2.16.18
func (my *FinderG[T]) FindOnlyCondition(ctx context.Context, finderCondition *FinderCondition) ([]T, *FinderG[T], error)
FindOnlyCondition 自动填充查询条件并查询(使用 FinderCondition),分页取自 FinderCondition
与传统 Finder.FindOnlyCondition 对应:返回 ([]T, *FinderG[T], error)。 第二个返回值为 finder 本身,便于链式获取 total(GetTotal)、错误(Error)等状态。 非分页时 total 自动设为结果条数。
func (*FinderG[T]) FindUseCondition ¶ added in v2.16.18
func (my *FinderG[T]) FindUseCondition(ctx context.Context, finderCondition *FinderCondition, page, size int) ([]T, *FinderG[T], error)
FindUseCondition 自动填充查询条件并查询(使用 FinderCondition),支持外部传入分页参数
与传统 Finder.FindUseCondition 对应:返回 ([]T, *FinderG[T], error)。 第二个返回值为 finder 本身,便于链式获取 total(GetTotal)、错误(Error)等状态。 若 finderCondition.Page / finderCondition.PageSize 有效,则覆盖外部 page/size。 非分页时 total 自动设为结果条数。
func (*FinderG[T]) GetChain ¶ added in v2.16.15
func (my *FinderG[T]) GetChain() gorm.ChainInterface[T]
GetChain 获取底层 gorm.ChainInterface[T],用于需要直接操作链式 API 的场景
func (*FinderG[T]) QueryUseCondition ¶ added in v2.16.18
func (my *FinderG[T]) QueryUseCondition(finderCondition *FinderCondition) *FinderG[T]
QueryUseCondition 从 FinderCondition 解析查询条件(与传统版逻辑一致)
Table 字段被忽略:表名由服务端模型决定。 启用 AllowFields 白名单时,字段名/排序字段必须在白名单内;raw、join 操作符一律拒绝。
func (*FinderG[T]) StatisticOnlyCondition ¶ added in v2.16.18
func (my *FinderG[T]) StatisticOnlyCondition(ctx context.Context, finderCondition *FinderCondition, ret any) error
StatisticOnlyCondition 自动填充查询条件并统计(使用 FinderCondition),结果扫描到 ret
与传统 Finder.StatisticOnlyCondition 对应:统计结果通常非 T 类型,故仍接收 ret any。
func (*FinderG[T]) Transaction ¶ added in v2.16.17
Transaction 执行一组数据库事务操作
与传统 Finder.Transaction 对应,使用 gorm.DB.Transaction 自动管理 begin/commit/rollback; 任一函数执行出错则回滚并返回错误。注意:回调内须使用传入的 tx 执行操作方可纳入事务。
func (*FinderG[T]) TryOrder ¶ added in v2.16.15
TryOrder 尝试排序
校验排序格式(复用 validateOrder),非法时通过 Statement.AddError 注入错误, 后续 finisher 方法会返回该错误。
func (*FinderG[T]) TryPagination ¶ added in v2.16.15
TryPagination 尝试分页
当 page > 0 且 size > 0 时生效;若此前已设置 needPagination,会先执行 Count 获取总数。
func (*FinderG[T]) TryPreload ¶ added in v2.16.15
TryPreload 尝试预加载(无额外条件)
func (*FinderG[T]) WhenBetween ¶ added in v2.16.15
WhenBetween 当条件满足时执行 where between
func (*FinderG[T]) WhenFunc ¶ added in v2.16.15
WhenFunc 当条件满足时通过 Scopes 执行回调
回调参数为 *gorm.Statement(泛型 Scopes 签名),与传统 Finder.WhenFunc 的 *gorm.DB 不同。
func (*FinderG[T]) WhenIn ¶ added in v2.16.15
WhenIn 当条件满足时执行 where in
args 支持切片或指向切片的指针(与传统 Finder.WhenIn 行为一致)
func (*FinderG[T]) WhenLikeLeft ¶ added in v2.16.15
WhenLikeLeft 当条件满足时执行 like %?
func (*FinderG[T]) WhenLikeRight ¶ added in v2.16.15
WhenLikeRight 当条件满足时执行 like ?%
func (*FinderG[T]) WhenNotBetween ¶ added in v2.16.15
WhenNotBetween 当条件满足时执行 where not between
type FinderImpl ¶
type FinderImpl struct {
// contains filtered or unexported fields
}
FinderImpl 查询帮助器
func (*FinderImpl) Error ¶ added in v2.11.3
func (my *FinderImpl) Error() error
func (*FinderImpl) FindOnlyCondition ¶
func (my *FinderImpl) FindOnlyCondition(finderCondition *FinderCondition, ret any) Finder
FindOnlyCondition 自动填充查询条件并查询:使用FinderCondition
func (*FinderImpl) FindUseCondition ¶
func (my *FinderImpl) FindUseCondition(finderCondition *FinderCondition, page, size int, ret any) Finder
FindUseCondition 自动填充查询条件并查询:使用FinderCondition
func (*FinderImpl) FindUseMap ¶
func (my *FinderImpl) FindUseMap(queries map[string][]any, preloads []string, orders []string, page, size int, ret any) Finder
FindUseMap 自动填充查询条件并查询:使用map[string][]any
func (*FinderImpl) QueryUseCondition ¶
func (my *FinderImpl) QueryUseCondition(finderCondition *FinderCondition) Finder
QueryUseCondition 从请求体中获取查询条件 Table 字段被忽略:表名由服务端模型决定 启用 AllowFields 白名单时,字段名/排序字段必须在白名单内;raw、join 操作符一律拒绝
func (*FinderImpl) QueryUseMap ¶
func (my *FinderImpl) QueryUseMap(queries map[string][]any) Finder
QueryUseMap 从map中解析参数并查询
func (*FinderImpl) StatisticOnlyCondition ¶ added in v2.13.13
func (my *FinderImpl) StatisticOnlyCondition(finderCondition *FinderCondition, ret any) Finder
StatisticOnlyCondition 自动填充查询条件并统计
func (*FinderImpl) Transaction ¶
func (my *FinderImpl) Transaction(functions ...func(db *gorm.DB)) error
Transaction 执行一组数据库事务操作 参数 funcs 为需要在事务中执行的函数切片,每个函数接收一个 *gorm.DB 参数 如果任一函数执行出错,将回滚整个事务并返回错误 所有函数执行成功后提交事务 返回 error,nil 表示事务执行成功,非 nil 表示事务执行失败
func (*FinderImpl) TryPagination ¶
func (my *FinderImpl) TryPagination(page, size int) Finder
TryPagination 尝试分页
func (*FinderImpl) TryPreload ¶
func (my *FinderImpl) TryPreload(preloads ...string) Finder
TryPreload 尝试深度查询
func (*FinderImpl) TryQuery ¶
func (my *FinderImpl) TryQuery(mode string, fieldName string, values ...any)
TryQuery 尝试查询
func (*FinderImpl) When ¶
func (my *FinderImpl) When(condition bool, query any, args ...any) Finder
When 当条件满足时执行:where
func (*FinderImpl) WhenBetween ¶
func (my *FinderImpl) WhenBetween(condition bool, query any, args ...any) Finder
WhenBetween 当条件满足时执行:where between
func (*FinderImpl) WhenFunc ¶
func (my *FinderImpl) WhenFunc(condition bool, fn func(db *gorm.DB)) Finder
WhenFunc 当条件满足时执行:通过回调执行
func (*FinderImpl) WhenIn ¶
func (my *FinderImpl) WhenIn(condition bool, query any, args any) Finder
WhenIn 当条件满足时执行:where in
func (*FinderImpl) WhenInPtr ¶
func (my *FinderImpl) WhenInPtr(condition bool, query any, args any) Finder
WhenInPtr 当条件满足时执行:where in args 为指针类型
func (*FinderImpl) WhenLike ¶
func (my *FinderImpl) WhenLike(condition bool, query, arg any) Finder
WhenLike 当条件满足时执行:like %?%
func (*FinderImpl) WhenLikeLeft ¶
func (my *FinderImpl) WhenLikeLeft(condition bool, query, arg any) Finder
WhenLikeLeft 当条件满足时执行:like %?
func (*FinderImpl) WhenLikeRight ¶
func (my *FinderImpl) WhenLikeRight(condition bool, query, arg any) Finder
WhenLikeRight 当条件满足时执行:like ?%
func (*FinderImpl) WhenNotBetween ¶
func (my *FinderImpl) WhenNotBetween(condition bool, query any, args ...any) Finder
WhenNotBetween 当条件满足时执行:where not between
func (*FinderImpl) WhenNotIn ¶
func (my *FinderImpl) WhenNotIn(condition bool, query any, args any) Finder
WhenNotIn 当条件满足时执行:where not in
func (*FinderImpl) WhenNotInPtr ¶
func (my *FinderImpl) WhenNotInPtr(condition bool, query any, args any) Finder
WhenNotInPtr 当条件满足时执行:where in args 为指针类型
type GenericAttr ¶ added in v2.16.15
type GenericAttr[T any] func(db gorm.ChainInterface[T]) gorm.ChainInterface[T]
GenericAttr 泛型模型属性:作用于 gorm.ChainInterface[T]
与传统 ModelAttr 的差异:
- Joins/Preload/Scopes 因 gorm 泛型 API 签名变化,参数类型与传统版不同
- Table 通过 ChainInterface.Table 直接设置(v1.31.0+ ChainInterface 已包含 Table)
func GDistinct ¶ added in v2.16.15
func GDistinct[T any](args ...any) GenericAttr[T]
GDistinct 去重,等价于传统 Distinct 属性
func GJoins ¶ added in v2.16.15
func GJoins[T any](join string, args ...any) GenericAttr[T]
GJoins 连接查询,与传统 Joins(join string, args ...any) 用法统一
示例:
GJoins[TestTable1]("left join users on users.id = posts.user_id")
GJoins[TestTable1]("articles", "articles.author_id = users.id")
gorm 泛型 ChainInterface.Joins 仅支持结构化 JoinTarget(不接受裸 SQL 字符串), 这里通过 Scopes 复用传统 *gorm.DB.Joins,保持与传统版一致的签名; 由于 stmt.Joins(...) 会返回新 *DB,需将新增的 join 元素回写到原 Statement.Joins, 以保证与已有 join 累积。
func GPreload ¶ added in v2.16.15
func GPreload[T any](association string, query func(db gorm.PreloadBuilder) error) GenericAttr[T]
GPreload 预加载
query 为 nil 时表示无额外条件。
func GPreloadMap ¶ added in v2.16.15
func GPreloadMap[T any](preloadMap map[string]func(db gorm.PreloadBuilder) error) GenericAttr[T]
GPreloadMap 批量预加载,等价于传统 PreloadMap 属性
func GScopes ¶ added in v2.16.15
func GScopes[T any](scopes ...func(db *gorm.Statement)) GenericAttr[T]
GScopes 作用域,等价于传统 Scopes 属性
回调参数为 *gorm.Statement(泛型 API 中 Scopes 签名与传统不同)。
func GSelect ¶ added in v2.16.15
func GSelect[T any](query string, args ...any) GenericAttr[T]
GSelect 查询字段,等价于传统 Select 属性
func GTable ¶ added in v2.16.15
func GTable[T Modeler](alias string) GenericAttr[T]
GTable 设置表别名,等价于传统 Table 属性
type MSSQLEndpoint ¶
type MSSQLSetting ¶
type MSSQLSetting struct {
Main *PGEndpoint `json:"main" yaml:"main"`
}
type MySQLBasic ¶
type MySQLBasic struct {
ID int64 `gorm:"column:id;type:bigint unsigned;primaryKey" json:"id"`
CreatedAt time.Time `gorm:"column:created_at;type:datetime;not null;default:current_timestamp" json:"created_at"`
UpdatedAt time.Time `gorm:"column:updated_at;type:datetime;not null;default:current_timestamp;autoUpdateTime:true" json:"updated_at"`
DeletedAt gorm.DeletedAt `gorm:"column:deleted_at;type:datetime;not null" json:"deleted_at"`
UUID string `gorm:"column:uuid;type:char(36);not null;unique" json:"uuid"`
}
type MySQLEndpoint ¶
type MySQLSetting ¶
type MySQLSetting struct {
Database string `json:"database" yaml:"database"`
Charset string `json:"charset" yaml:"charset"`
Collation string `json:"collation" yaml:"collation"`
Rws bool `json:"rws" yaml:"rws"`
Main *MySQLEndpoint `json:"main" yaml:"main"`
Loc string `json:"loc" yaml:"loc"`
Sources map[string]MySQLEndpoint `json:"sources" yaml:"sources"`
Replicas map[string]MySQLEndpoint `json:"replicas" yaml:"replicas"`
}
type PGEndpoint ¶
type PGEndpoint struct {
Username string `json:"username" yaml:"username"`
Password string `json:"password" yaml:"password"`
Host string `json:"host" yaml:"host"`
Port uint16 `json:"port" yaml:"port"`
Database string `json:"database" yaml:"database"`
TimeZone string `json:"timezone" yaml:"timezone"`
SSLMode string `json:"ssl-mode" yaml:"ssl-mode"`
}
type PGSetting ¶
type PGSetting struct {
Main *PGEndpoint `json:"main" yaml:"main"`
}