介绍
worm是一款不便易用的Go语言ORM库,worm具备应用简略,运行性能高,功能强大的特点。具体特色如下:
- 通过Struct的Tag与数据库字段进行映射,让您免于常常拼写SQL的麻烦。
- 反对Struct映射、原生SQL以及SQL builder三种模式来操作数据库,并且Struct映射、原生SQL以及SQL builder可混合应用。
- Struct映射、SQL builder反对链式API,可应用Where, And, Or, ID, In, Limit, GroupBy, OrderBy, Having等函数结构查问条件。
- 可通过Join、LeftJoin、RightJoin来进行数据库表之间的关联查问。
- 反对事务反对,可在会话中开启事务,在事务中能够混用Struct映射、原生SQL以及SQL builder来操作数据库。
- 反对预编译模式拜访数据库,会话开启预编译模式后,任何SQL都会应用缓存的Statement,能够晋升数据库拜访效率。
- 反对应用数据库的读写拆散模式来拜访一组数据库。
- 反对在Insert,Update,Delete,Get, Find操作中应用钩子办法。
- 反对SQL日志的输入,并且可通过日志钩子自定义SQL日志的输入,日志钩子反对Context。
- 可依据数据库主动生成库表对应的Model构造体。
目前worm反对的数据库有:mysql、postgres、sqlite、sqlserver。
装置
go get github.com/haming123/wego/worm
应用文档
请点击:具体文档
疾速开始
创立实体类
//建表语句CREATE TABLE `user` ( `id` bigint(20) NOT NULL AUTO_INCREMENT, `name` varchar(30) DEFAULT NULL, `age` int(11) DEFAULT NULL, `passwd` varchar(32) DEFAULT NULL, `created` datetime DEFAULT NULL, `updated` datetime DEFAULT NULL, PRIMARY KEY (`id`));
数据库表user对应的实体类的定义如下:
type User struct { Id int64 `db:"id;autoincr"` Name string `db:"name"` Age int64 `db:"age"` Passwd string `db:"passwd"` Created time.Time `db:"created;n_update"`}func (ent *User) TableName() string { return "user"}
worm应用名称为"db"的Tag映射数据库字段,"db"前面是字段的名称,autoincr用于阐明该字段是自增ID,n_update用于阐明该字段不可用于update语句中。
创立DbEngine
本文中的例子应用的都是mysql数据库。若要创立一个mysql数据库的DbEngine,您可调用worm.NewMysql()函数或者调用worm.InitMysql()函数。
package mainimport ( "database/sql" "log" _ "github.com/go-sql-driver/mysql" "github.com/haming123/wego/worm")func main() { var err error cnnstr := "user:pwd@tcp(127.0.0.1:3306)/db?charset=utf8&parseTime=True" dbcnn, err := sql.Open("mysql", cnnstr) if err != nil { log.Println(err) return } err = dbcnn.Ping() if err != nil { log.Println(err) return } err = worm.InitMysql(dbcnn) if err != nil { log.Println(err) return }}
插入记录
user := User{Name:"name1", Age: 21, Created: time.Now()}id, err := worm.Model(&user).Insert()//insert into user set name=?,age=?,passwd=?,created=?
更新数据
//通过ID更新数据user := User{Name:"name2", Age: 22}affected, err := worm.Model(&user).ID(1).Update()//update user set name=?,age=?,passwd=? where id=?
为了避免误操作,更新数据时必须指定查问条件,若没有指定查问条件worm不会执行该操作。
删除数据
//通过ID删除数据affected, err := worm.Model(&User{}).ID(1).Delete()//delete from user where id=?
为了避免误操作,删除数据时必须指定查问条件,若没有指定查问条件worm不会执行该操作。
查问单条记录
//通过ID查问数据user := User{}_, err := worm.Model(&user).ID(1).Get()//select id,name,age,passwd,created from user where id=? limit 1
查问多条记录
//查问全副数据users := []User{}err := worm.Model(&User{}).Find(&users)//select id,name,age,passwd,created from user//应用limit查问数据users = []User{}err := worm.Model(&User{}).Limit(5).Offset(2).Find(&users)//select id,name,age,passwd,created from user limit 2, 5//应用order查问数据users = []User{}err = worm.Model(&User{}).OrderBy("name asc").Find(&users)//select id,name,age,passwd,created from users order by name asc
查问指定的字段
worm容许通过Select办法抉择特定的字段, 或者应用Omit办法排除特定字段
//查问指定的字段user := User{}_, err := worm.Model(&user).Select("id", "name", "age").ID(1).Get()// select id,name,age from users where id=1 limit 1user = User{}_, err = worm.Model(&user).Omit("passwd").ID(1).Get()//select id,name,age,created from users where id=1 limit 1
条件查问
worm反对链式API,可应用Where, And, Or, ID, In等函数结构查问条件。
users := []User{}err := worm.Model(&User{}).Where("age>?", 0).Find(&users)//select id,name,age,passwd,created from user where age>?//andusers = []User{}err := worm.Model(&User{}).Where("age>?", 0).And("id<?", 10).Find(&users)//select id,name,age,passwd,created from user where age>? and id<?//likeusers = []User{}err := worm.Model(&User{}).Where("name like ?", "%name%").Find(&users)//select id,name,age,passwd,created from user where name like ?//inusers = []User{}err := worm.Model(&User{}).Where("age>?", 0).AndIn("id", 5,6).Find(&users)//select id,name,age,passwd,created from user where age>? and id in (?,?)
worm占位符对立应用?,worm会依据数据库类型,主动替换占位符,例如postgresql数据库把?替换成$1,$2...
获取记录条数
num, err := Model(&User{}).Where("id>?", 0).Count()//select count(1) from user where id>?num, err := Model(&User{}).Where("id>?", 0).Count("name")//select count(name) from user where id>?
检测记录是否存在
has, err := worm.Model(&User{}).Where("id=?", 1).Exist()//select id,name,age,passwd,created from user where id=? limit 1
Update或Insert数据
var user = User{Name:"name2", Age: 22}affected,insertId,err := worm.Model(&user).UpdateOrInsert(1)//依据id判断是Update还是Insert, 若id>0,则调用Update,否则调用Insert//insert into user set name=?,age=?,passwd=?,created=?//update user set name=?,age=?,passwd=? where id=?
批量新增
users := []User{User{DB_name:"batch1", Age: 33}, User{DB_name:"batch2", Age: 33} }res, err := Model(&User{}).BatchInsert(&users)//insert into user set name=?,age=?,created=?//TX: time=141.074ms affected=2; prepare
应用原生SQL
//插入记录res, err := worm.SQL("insert into user set name=?, age=?", "name1", 1).Exec()//更新记录res, err = worm.SQL("update user set name=? where id=?", "name2", id).Exec()//删除记录res, err = worm.SQL("delete from user where id=?", id).Exec()//查问单条记录var name string; var age int64has, err = worm.SQL("select name,age from user where id=?", 6).Get(&name, &age)//查问单条记录到model对象var ent Userhas, err := worm.SQL("select * from user where id=?", 6).GetModel(&ent)//一些单条记录的单个字段的查问函数:strval, err := worm.SQL("select name from user where id=?", 6).GetString()intval, err := worm.SQL("select age from user where id=?", 6).GetInt()fltval, err := worm.SQL("select high from user where id=?", 1).GetFloat()//查问多条记录rows, err := worm.SQL("select * from user where id>?", 0).Rows()//查问多条记录到model数组var users []Usererr := worm.SQL( "select * from user where id>?", 5).FindModel(&users)//一些多条记录的单个字段的查问函数:arrstr, err := worm.SQL( "select name from user where id>?", 5).FindString()arrint, err := worm.SQL( "select age from user where id>?", 5).FindInt()arrflt, err := worm.SQL( "select high from user where id>?", 5).FindFloat()
应用Sql Builder
//插入记录id, err := worm.Table("user").Value("name", "name1").Value("age", 21).Insert()//更新记录affected, err := worm.Table("user").Value("name", "name2").Where("id=?", id).Update()//删除记录affected, err = worm.Table("user").Where("id=?", id).Delete()//查问单条记录var name string; var age int64has, err = worm.Table("user").Select("name", "age").Where("id=?", 6).Get(&name, &age)//查问单条记录到model对象var ent Userhas, err := worm.Table("user").Select("*").Where("id=?", 6).GetModel(&ent)//一些单条记录的单个字段的查问函数:strval, err := worm.Table("user").Select("name").Where("id=?", 6).GetString()intval, err := worm.Table("user").Select("age" ).Where("id=?", 6).GetInt()fltval, err := worm.Table("user").Select("high").Where("id=?", 6).GetFloat()//查问多条记录var users []Usererr := worm.Table("user").Select("*").Where("id>?", 0).FindModel(&users)//一些多条记录的单个字段的查问函数:arrstr, err := worm.Table("user").Select("name").Where("id>?", 0).FindString()arrint, err := worm.Table("user").Select("age" ).Where("id>?", 0).FindInt()arrflt, err := worm.Table("user").Select("high").Where("id>?", 0).FindFloat()
关联查问
定义一个book表以及相应的实体类:
/*CREATE TABLE `book` ( `id` int(11) NOT NULL AUTO_INCREMENT COMMENT 'id', `author` bigint(20) NOT NULL DEFAULT '0' COMMENT '作者', `name` varchar(16) NOT NULL DEFAULT '' COMMENT '名称', `price` decimal(11,2) DEFAULT 0.0 NULL COMMENT '价格', PRIMARY KEY (`id`)) ENGINE=InnoDB */type Book struct { DB_id int64 DB_name string DB_author int64 DB_price float32}func (ent *Book) TableName() string { return "book"}
在worm中不必Tag标签也能够简略的进行与数据库表的映射, 所有的字段若以"DB_"结尾,则认为是一个数据库字段,字段的名称为"DB_"前面的局部, 例如DB_name对应name字段。
在book表中,通过author字段与user表的id字段相关联。若要查问一个用户购买的书,在worm中能够通过Join来查问:
type UserBook struct { User User Book Book}var datas []UserBookmd := worm.Model(&User{}).Select("id","name","age").TableAlias("u")md.Join(&Book{}, "b", "b.author=u.id", "name")err := md.Where("u.id>?", 0).Find(&datas)//select u.id as u_id,u.name as u_name,u.age as u_age,b.name as b_name from user u join book b on b.author=u.id where u.id>0
除了Join,您还能够应用LeftJoin以及RightJoin进行左连贯、右连贯查问。
事务处理
当应用事务处理时,须要创立 Session对象,并开启数据库事务。在进行事务处理时,在事务中能够混用Model模式、原生SQL模式以及SQL builder模式来操作数据库:
tx := worm.NewSession()tx.TxBegin()user := User{Name:"name1", Age: 21, Created: time.Now()}id, err := tx.Model(&user).Insert()if err != nil{ tx.TxRollback() return}_, err = tx.Table("user").Value("age", 20).Value("name", "zhangsan").Where("id=?", id).Update()if err != nil{ tx.TxRollback() return}_, err = tx.SQL("delete from user where id=?", id).Exec()if err != nil{ tx.TxRollback() return}tx.TxCommit()
应用SQL语句预编译
worm反对SQL语句的预编译,应用SQL语句预编译能够晋升数据库拜访的效率。在worm中能够通过三种形式开启SQL语句预编译:全局开启、会话中开启、语句中开启。
//全局开启,所有操作都会创立并缓存预编译worm.UsePrepare(true)//会话中开启, 会话中的sql语句会创立并缓存预编译dbs := worm.NewSession()dbs.UsePrepare(true)//语句中应用UsePrepareuser := User{}_, err := Model(&user).UsePrepare(true).Where("id=?", 1).Get()