xsql

Documentation

Overview

SQL语句获取、SQL语句执行的方法

Index

• func Name(name string) (string, error)
• func Regedit(c *Config)
• func Replace(name, search, replace string) (string, error)
• func ReplaceAll(name string, search, replace []string) (string, error)
• func RunExec(sql string, arg ...any) error
• func RunNameExec(name string, arg ...any) error
• func RunNameReplaceExec(name, search, replace string, arg ...any) error
• func RunNameReplaceScan(name string, search, replace []string, objs any, arg ...any) error
• func RunNameScan(name string, objs any, arg ...any) error
• func RunScan(sql string, objs any, arg ...any) error
• func SetDB(db *gorm.DB)
• type Config
  • func (c *Config) Name(name string) (string, error)
  • func (c *Config) Replace(name, search, replace string) (string, error)
  • func (c *Config) ReplaceAll(name string, search, replace []string) (string, error)
  • func (c *Config) RunExec(sql string, arg ...any) error
  • func (c *Config) RunNameExec(name string, arg ...any) error
  • func (c *Config) RunNameReplaceExec(name, search, replace string, arg ...any) error
  • func (c *Config) RunNameReplaceScan(name string, search, replace []string, objs any, arg ...any) error
  • func (c *Config) RunNameScan(name string, objs any, arg ...any) error
  • func (c *Config) RunScan(sql string, objs any, arg ...any) error

Functions

func Name

func Name(name string) (string, error)

根据文件名获取SQL内容

name	SQL文件名，基于打包变量所在位置的相对路径，忽略.sql后缀

func Regedit

func Regedit(c *Config)

注入配置项

func Replace

func Replace(name, search, replace string) (string, error)

读取SQL并进行替换操作

name	文件名
search	搜索内容
replace	替换内容

func ReplaceAll

func ReplaceAll(name string, search, replace []string) (string, error)

读取SQL并进行替换操作

name	文件名
search	搜索内容
replace	替换内容

func RunExec

func RunExec(sql string, arg ...any) error

根据SQL语句进行运行【可使用?进行参数绑定和传入】

sql		要运行的SQL语句
arg		参数列表

func RunNameExec

func RunNameExec(name string, arg ...any) error

根据SQL文件名进行运行【可使用?进行参数绑定和传入】

name	文件名
arg		参数列表

func RunNameReplaceExec

func RunNameReplaceExec(name, search, replace string, arg ...any) error

根据SQL文件名进行运行【可使用?进行参数绑定和传入】

name	文件名
search	搜索内容
replace	替换内容
arg		参数列表

func RunNameReplaceScan

func RunNameReplaceScan(name string, search, replace []string, objs any, arg ...any) error

根据SQL文件名进行查询操作【可使用?进行参数绑定和传入】

name	文件名
search	搜索内容
replace	替换内容
objs	查询结果回写到变量【指针】
arg		参数列表

func RunNameScan

func RunNameScan(name string, objs any, arg ...any) error

根据SQL文件名进行查询操作【可使用?进行参数绑定和传入】

name	文件名
objs	查询结果回写到变量【指针】
arg		参数列表

func RunScan

func RunScan(sql string, objs any, arg ...any) error

根据SQL语句进行查询操作【可使用?进行参数绑定和传入】

sql		要查询的SQL语句
objs	查询结果回写到变量【指针】
arg		参数列表

func SetDB

func SetDB(db *gorm.DB)

设置数据库连接

db	数据库连接

Types

type Config

type Config struct {
	DB      *gorm.DB  // 数据库连接
	SqlFile *embed.FS // SQL文件的原生打包变量，需要使用//go:embed *.sql形式来存储文件
}

Sql查询模块

func (*Config) Name

func (c *Config) Name(name string) (string, error)

根据文件名获取SQL内容

name	SQL文件名，基于打包变量所在位置的相对路径，忽略.sql后缀

func (*Config) Replace

func (c *Config) Replace(name, search, replace string) (string, error)

读取SQL并进行替换操作

name	文件名
search	搜索内容
replace	替换内容

func (*Config) ReplaceAll

func (c *Config) ReplaceAll(name string, search, replace []string) (string, error)

读取SQL并进行替换操作

name	文件名
search	搜索内容
replace	替换内容

func (*Config) RunExec

func (c *Config) RunExec(sql string, arg ...any) error

根据SQL语句进行运行【可使用?进行参数绑定和传入】

sql		要运行的SQL语句
arg		参数列表

func (*Config) RunNameExec

func (c *Config) RunNameExec(name string, arg ...any) error

根据SQL文件名进行运行【可使用?进行参数绑定和传入】

name	文件名
arg		参数列表

func (*Config) RunNameReplaceExec

func (c *Config) RunNameReplaceExec(name, search, replace string, arg ...any) error

根据SQL文件名进行运行【可使用?进行参数绑定和传入】

name	文件名
search	搜索内容
replace	替换内容
arg		参数列表

func (*Config) RunNameReplaceScan

func (c *Config) RunNameReplaceScan(name string, search, replace []string, objs any, arg ...any) error

根据SQL文件名进行查询操作【可使用?进行参数绑定和传入】

name	文件名
search	搜索内容
replace	替换内容
objs	查询结果回写到变量【指针】
arg		参数列表

func (*Config) RunNameScan

func (c *Config) RunNameScan(name string, objs any, arg ...any) error

根据SQL文件名进行查询操作【可使用?进行参数绑定和传入】

name	文件名
objs	查询结果回写到变量【指针】
arg		参数列表

func (*Config) RunScan

func (c *Config) RunScan(sql string, objs any, arg ...any) error

根据SQL语句进行查询操作【可使用?进行参数绑定和传入】

sql		要查询的SQL语句
objs	查询结果回写到变量【指针】
arg		参数列表