A easy ORM for golang
gosql 是一个用golang实现的数据库操作类库
- Golang-style SQL builder go语言风格sql生成
- Unlimited nesting query 查询条件无限嵌套
- Reading and Writing Separation 读写分离
- Delay connection creation 延迟创建连接
- ORM maping to sturct ORM映射结构体
- Transactions 事务支持
- Versatile 功能多样的
- Clean Code 简洁的代码
- Bulk Insert 支持批量插入
- db.go: defined base struct define 基本结构定义
- pool.go: db manager 管理db
- session.go: session and maping to model 会话和模型
- builder.go: for building SQL 构建sql
- scanner/*: mapping struct and scan 映射模型
几乎是翻遍github上所有开源的使用golang实现的操作数据库类)使用起来总有不顺手的地方,例如:
gorm不支持读写分离,关联表使用频率少
gendry 是didi开源的一款,比较简洁但部分语法怪异 如group by 和 limit 依赖字段的约定
sqlx 相比起来不错,但语法不够简洁,不支持读写分离,
gosql 目前仅支持mysql (关键是`符号的处理,以及一些特殊语法,后期可能会考虑兼容pgsql等
本数据库参阅了大量现有数据库架构,参阅各种文献,自定义语法习惯,从零实现
其中灵感来自:分模块的灵感来自gendry,标签读取部分参考gorm,拼装sql的语法来自于我之前写的php的操作db库
为了展示gosql的能力,先展示个例子: Let's look a demo:
SELECT DISTINCT * FROM `tbl1`.`t1` JOIN `tbl3` ON `a` = `b`
WHERE (`t1`.`status` = ?
AND `type` = ?
AND `sts` IN (?, ?, ?, ?)
AND `sts2` IN (?)
AND (`a` = ? AND `b` = ?)
AND aaa = 999
AND ccc = ?
AND `a` LIKE ? AND EXISTS (SELECT 1)
AND EXISTS (SELECT * FROM `tbl2`.`t2` WHERE `xx` = ?)
) GROUP BY `id` HAVING `ss` = ? ORDER BY `id desc`, `id asc` LIMIT 10, 30
FOR UPDATE
s := gosql.NewSQLSegment()
s.Flag("DISTINCT")
s.Field("*")
s.Table("tbl1.t1")
s.Where("t1.status", "0")
s.Where("type", "A")
s.Where("[in]sts", []string{"1", "2", "3", "4"})
s.Where("[in]sts2", 1)
s.Where(func(s *gosql.Clause) {
s.Where("a", "200")
s.Where("b", "100")
})
s.Where("aaa = 999")
s.Where("[#]ccc = ?", 888)
s.Join("tbl3", "a", "=", "b")
s.Having("ss", "1")
s.Where("[~]a", "AA")
s.Where("[exists]", "select 1")
s.Where("[exists]", func(s *gosql.SQLSegments) {
s.Table("tbl2.t2")
s.Where("xx", 10000)
})
s.GroupBy("id")
s.OrderBy("id desc", "id asc")
s.Limit(30)
s.Offset(10)
s.ForUpdate()
fmt.Println(s.BuildSelect())
package main
import (
"fmt"
_ "github.com/go-sql-driver/mysql"
"github.com/rushteam/gosql"
)
type UserModel struct {
ID int `db:"id"`
Name string `db:"name"`
}
func (u *UserModel) TableName() string {
return "my_user"
}
func main() {
db := gosql.NewCluster(
gosql.AddDb("mysql", "user:password@tcp(127.0.0.1:3306)/test?parseTime=true&readTimeout=3s&writeTimeout=3s&timeout=3s"),
)
user := &UserModel{}
err := db.Fetch(user, gosql.Where("id", 1), gosql.Where("[like]name", "j%"))
if err != nil {
fmt.Println(err)
}
fmt.Println(user)
}
db.Insert(dst interface{}, opts ...Option) (Result, error)
user := &UserModel{}
user.Name = "jack"
ret,err := db.Insert(&user)
batch insert:
users := []UserModel{}
u1 := UserModel{Name:"jack"}
u2 := UserModel{Name:"Tom"}
users = append(users,u1)
users = append(users,u2)
ret,err := db.Insert(users)
db.Replace(dst interface{}, opts ...Option) (Result, error)
user := &UserModel{}
user.Name = "jack"
ret,err := db.Replace(&user,gosql.Where("id",1))
Update(dst interface{}, opts ...Option) (Result, error)
user := &UserModel{}
user.Name = "jack Ma"
ret,err := db.Update(&user,gosql.Where("id",1))
db.Delete(dst interface{}, opts ...Option) (Result, error)
user := &UserModel{}
ret,err := db.Delete(&user,gosql.Where("id",1))
//sql: delete from my_user where id = 1
user := &UserModel{}
err := db.Fetch(user,
gosql.Columns("id","name"),
gosql.Where("id", 1),
gosql.Where("[like]name", "j%")
gosql.OrWhere(func(s *Clause) {
s.Where("[>=]score", "90")
s.Where("[<=]age", "100")
}),
GroupBy("type"),
OrderBy("score DESC"),
)
var userList []UserModel
err := db.FetchAll(&userList,
gosql.Columns("id","name"),
gosql.Where("id", 1),
gosql.Where("[like]name", "j%")
gosql.OrWhere(func(s *Clause) {
s.Where("[>]score", "90")
s.Where("[<]score", "100")
}),
GroupBy("type"),
OrderBy("score DESC"),
Offset(0),
Limit(10),
)
gosql.Where("id",1)
//sql: id = 1
gosql.Where("[>]age",18)
//sql: age > 18
gosql.Where("[in]id",[]int{1,2})
//sql: id in (1,2)
gosql.Where("[!in]id",[]int{1,2})
//sql: id not in (1,2)
gosql.Where("[~]name","ja%")
//sql: name like 'ja%'
gosql.Where("[!~]name","ja%")
//sql: name not like 'ja%'
gosql.Where("[=]id",1)
//sql: id = 1
gosql.Where("[!=]id",1)
//sql: id != 1
gosql.Where("[>]id",1)
//sql: id > 1
gosql.Where("[>=]id",1)
//sql: id >= 1
gosql.Where("[<]id",1)
//sql: id < 1
gosql.Where("[<=]id",1)
//sql: id <= 1
gosql.Where("[in]id",[]int{1,2})
//sql: id in (1,2)
gosql.Where("[!in]id",[]int{1,2})
//sql: id not in (1,2)
gosql.Where("[is]name",nil)
//sql: name is null
gosql.Where("[!is]name","")
//sql: id is not ""
gosql.Where("[exists]name","select 1")
//sql: name exists(select 1)
gosql.Where("[!exists]name","select 1")
//sql: name not exists(select 1)
gosql.Where("[#]age=age-1")
//sql: age = age-1
rows,err := db.Query("select * from my_user where id = ?",1)
//sql: select * from my_user where id = 1
db := db.Master()
db.Fetch(...)
db := db.Slave()
db.Fetch(...)
用法 builder.New()
例子 s := builder.New()
设置一个falg,非必须
用法 s.Flag(string)
例子 s := builder.New().Flag("")
指定查询字段 不指定 默认为 *
用法 s.Field("*")
用法 s.Table("tbl1.t1")
-
普通查询 s.Where(key string, val inferface{})
-
等于查询
用法 s.Where("t1.status", "0")
等效SQL t1.status = 0
- 不等于查询
用法 s.Where("[!=]t1.status", "0")
等效SQL t1.status != 0
- IN查询
用法 s.Where("[in]sts", []string{"a", "b", "c"})
等效SQL t1.type in (a,b,c)
- NOT IN查询
用法 s.Where("[!in]sts", []string{"a", "b", "c"})
等效SQL t1.type not in (a,b,c)
- 复杂条件查询
用法 .Where(func(s *builder.Clause){}
s.Where("[!]t1.a",1).Where(func(s *builder.Clause){
s.Where("t1.b",1)
s.OrWhere("t1.c",1)
})
等效SQL t1.a != 1 and (t1.b = 1 or t1.c = 1)
- GROUP BY 分类
用法 s.GroupBy("id")
等效SQL group by id
- ORDER BY 排序
用法 s.OrderBy("id desc", "age asc")
等效SQL order by id
desc
- 限制条数
用法 s.Limit(30)
等效SQL limit 30
- 偏移条数
用法 s.Offset(10)
等效SQL offset 30