gem-hunter
Language: Go
Simple and Powerful ORM for Go, support mysql,postgres,tidb,sqlite3,mssql,oracle, Moved to https://gitea.com/xorm/xorm
Xorm is a simple and powerful ORM for Go.
Struct <-> Table Mapping Support
Chainable APIs
Transaction Support
Both ORM and raw SQL operation Support
Sync database schema Support
Query Cache speed up
Database Reverse support, See Xorm Tool README
Simple cascade loading support
Optimistic Locking support
SQL Builder support via xorm.io/builder
Automatical Read/Write seperatelly
Postgres schema support
Context Cache support
Drivers for Go's sql package which currently support database/sql includes:
MyMysql: github.com/ziutek/mymysql/godrv
Postgres: github.com/lib/pq
Tidb: github.com/pingcap/tidb
SQLite: github.com/mattn/go-sqlite3
Oracle: github.com/mattn/go-oci8 (experiment)
go get github.com/go-xorm/xorm
engine, err := xorm.NewEngine(driverName, dataSourceName)
type User struct { Id int64 Name string Salt string Age int Passwd string `xorm:"varchar(200)"` Created time.Time `xorm:"created"` Updated time.Time `xorm:"updated"` } err := engine.Sync2(new(User))
dataSourceNameSlice := []string{masterDataSourceName, slave1DataSourceName, slave2DataSourceName} engineGroup, err := xorm.NewEngineGroup(driverName, dataSourceNameSlice)
masterEngine, err := xorm.NewEngine(driverName, masterDataSourceName) slave1Engine, err := xorm.NewEngine(driverName, slave1DataSourceName) slave2Engine, err := xorm.NewEngine(driverName, slave2DataSourceName) engineGroup, err := xorm.NewEngineGroup(masterEngine, []*Engine{slave1Engine, slave2Engine})
Then all place where engine you can just use engineGroup.
Query runs a SQL string, the returned results is []map[string][]byte, QueryString returns []map[string]string, QueryInterface returns []map[string]interface{}.results, err := engine.Query("select * from user") results, err := engine.Where("a = 1").Query() results, err := engine.QueryString("select * from user") results, err := engine.Where("a = 1").QueryString() results, err := engine.QueryInterface("select * from user") results, err := engine.Where("a = 1").QueryInterface()
Exec runs a SQL string, it returns affected and erroraffected, err := engine.Exec("update user set age = ? where name = ?", age, name)
Insert one or multiple records to databaseaffected, err := engine.Insert(&user) // INSERT INTO struct () values () affected, err := engine.Insert(&user1, &user2) // INSERT INTO struct1 () values () // INSERT INTO struct2 () values () affected, err := engine.Insert(&users) // INSERT INTO struct () values (),(),() affected, err := engine.Insert(&user1, &users) // INSERT INTO struct1 () values () // INSERT INTO struct2 () values (),(),()
Get query one record from databasehas, err := engine.Get(&user) // SELECT * FROM user LIMIT 1 has, err := engine.Where("name = ?", name).Desc("id").Get(&user) // SELECT * FROM user WHERE name = ? ORDER BY id DESC LIMIT 1 var name string has, err := engine.Table(&user).Where("id = ?", id).Cols("name").Get(&name) // SELECT name FROM user WHERE id = ? var id int64 has, err := engine.Table(&user).Where("name = ?", name).Cols("id").Get(&id) has, err := engine.SQL("select id from user").Get(&id) // SELECT id FROM user WHERE name = ? var valuesMap = make(map[string]string) has, err := engine.Table(&user).Where("id = ?", id).Get(&valuesMap) // SELECT * FROM user WHERE id = ? var valuesSlice = make([]interface{}, len(cols)) has, err := engine.Table(&user).Where("id = ?", id).Cols(cols...).Get(&valuesSlice) // SELECT col1, col2, col3 FROM user WHERE id = ?
Exist check if one record exist on tablehas, err := testEngine.Exist(new(RecordExist)) // SELECT * FROM record_exist LIMIT 1 has, err = testEngine.Exist(&RecordExist{ Name: "test1", }) // SELECT * FROM record_exist WHERE name = ? LIMIT 1 has, err = testEngine.Where("name = ?", "test1").Exist(&RecordExist{}) // SELECT * FROM record_exist WHERE name = ? LIMIT 1 has, err = testEngine.SQL("select * from record_exist where name = ?", "test1").Exist() // select * from record_exist where name = ? has, err = testEngine.Table("record_exist").Exist() // SELECT * FROM record_exist LIMIT 1 has, err = testEngine.Table("record_exist").Where("name = ?", "test1").Exist() // SELECT * FROM record_exist WHERE name = ? LIMIT 1
Find query multiple records from database, also you can use join and extendsvar users []User err := engine.Where("name = ?", name).And("age > 10").Limit(10, 0).Find(&users) // SELECT * FROM user WHERE name = ? AND age > 10 limit 10 offset 0 type Detail struct { Id int64 UserId int64 `xorm:"index"` } type UserDetail struct { User `xorm:"extends"` Detail `xorm:"extends"` } var users []UserDetail err := engine.Table("user").Select("user.*, detail.*"). Join("INNER", "detail", "detail.user_id = user.id"). Where("user.name = ?", name).Limit(10, 0). Find(&users) // SELECT user.*, detail.* FROM user INNER JOIN detail WHERE user.name = ? limit 10 offset 0
Iterate and Rows query multiple records and record by record handle, there are two methods Iterate and Rowserr := engine.Iterate(&User{Name:name}, func(idx int, bean interface{}) error { user := bean.(*User) return nil }) // SELECT * FROM user err := engine.BufferSize(100).Iterate(&User{Name:name}, func(idx int, bean interface{}) error { user := bean.(*User) return nil }) // SELECT * FROM user Limit 0, 100 // SELECT * FROM user Limit 101, 100 rows, err := engine.Rows(&User{Name:name}) // SELECT * FROM user defer rows.Close() bean := new(Struct) for rows.Next() { err = rows.Scan(bean) }
Update update one or more records, default will update non-empty and non-zero fields except when you use Cols, AllCols and so on.affected, err := engine.ID(1).Update(&user) // UPDATE user SET ... Where id = ? affected, err := engine.Update(&user, &User{Name:name}) // UPDATE user SET ... Where name = ? var ids = []int64{1, 2, 3} affected, err := engine.In("id", ids).Update(&user) // UPDATE user SET ... Where id IN (?, ?, ?) // force update indicated columns by Cols affected, err := engine.ID(1).Cols("age").Update(&User{Name:name, Age: 12}) // UPDATE user SET age = ?, updated=? Where id = ? // force NOT update indicated columns by Omit affected, err := engine.ID(1).Omit("name").Update(&User{Name:name, Age: 12}) // UPDATE user SET age = ?, updated=? Where id = ? affected, err := engine.ID(1).AllCols().Update(&user) // UPDATE user SET name=?,age=?,salt=?,passwd=?,updated=? Where id = ?
Delete delete one or more records, Delete MUST have conditionaffected, err := engine.Where(...).Delete(&user) // DELETE FROM user Where ... affected, err := engine.ID(2).Delete(&user) // DELETE FROM user Where id = ?
Count count recordscounts, err := engine.Count(&user) // SELECT count(*) AS total FROM user
FindAndCount combines function Find with Count which is usually used in query by pagevar users []User counts, err := engine.FindAndCount(&users)
Sum sum functionsagesFloat64, err := engine.Sum(&user, "age") // SELECT sum(age) AS total FROM user agesInt64, err := engine.SumInt(&user, "age") // SELECT sum(age) AS total FROM user sumFloat64Slice, err := engine.Sums(&user, "age", "score") // SELECT sum(age), sum(score) FROM user sumInt64Slice, err := engine.SumsInt(&user, "age", "score") // SELECT sum(age), sum(score) FROM user
err := engine.Where(builder.NotIn("a", 1, 2).And(builder.In("b", "c", "d", "e"))).Find(&users) // SELECT id, name ... FROM user WHERE a NOT IN (?, ?) AND b IN (?, ?, ?)
session := engine.NewSession() defer session.Close() user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} if _, err := session.Insert(&user1); err != nil { return err } user2 := Userinfo{Username: "yyy"} if _, err := session.Where("id = ?", 2).Update(&user2); err != nil { return err } if _, err := session.Exec("delete from userinfo where username = ?", user2.Username); err != nil { return err } return nil
session := engine.NewSession() defer session.Close() // add Begin() before any action if err := session.Begin(); err != nil { // if returned then will rollback automatically return err } user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} if _, err := session.Insert(&user1); err != nil { return err } user2 := Userinfo{Username: "yyy"} if _, err := session.Where("id = ?", 2).Update(&user2); err != nil { return err } if _, err := session.Exec("delete from userinfo where username = ?", user2.Username); err != nil { return err } // add Commit() after all actions return session.Commit()
Transaction to replace above codes.res, err := engine.Transaction(func(session *xorm.Session) (interface{}, error) { user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} if _, err := session.Insert(&user1); err != nil { return nil, err } user2 := Userinfo{Username: "yyy"} if _, err := session.Where("id = ?", 2).Update(&user2); err != nil { return nil, err } if _, err := session.Exec("delete from userinfo where username = ?", user2.Username); err != nil { return nil, err } return nil, nil })
sess := engine.NewSession() defer sess.Close() var context = xorm.NewMemoryContextCache() var c2 ContextGetStruct has, err := sess.ID(1).ContextCache(context).Get(&c2) assert.NoError(t, err) assert.True(t, has) assert.EqualValues(t, 1, c2.Id) assert.EqualValues(t, "1", c2.Name) sql, args := sess.LastSQL() assert.True(t, len(sql) > 0) assert.True(t, len(args) > 0) var c3 ContextGetStruct has, err = sess.ID(1).ContextCache(context).Get(&c3) assert.NoError(t, err) assert.True(t, has) assert.EqualValues(t, 1, c3.Id) assert.EqualValues(t, "1", c3.Name) sql, args = sess.LastSQL() assert.True(t, len(sql) == 0) assert.True(t, len(args) == 0)
If you want to pull request, please see CONTRIBUTING. And we also provide Xorm on Google Groups to discuss.
This project exists thanks to all the people who contribute. [Contribute].
Thank you to all our backers! 🙏 [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
v0.7.0
v0.6.6
v0.6.5
v0.6.4
BSD License http://creativecommons.org/licenses/BSD/