Simple and Powerful ORM for Go, support mysql,postgres,tidb,sqlite3,mssql,oracle
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
baijinping 8e2cf2e552
fix batch insert []interface{*struct, ...} be panic;add TestInsertMulti2Interface testcase
3 years ago
caches Improve tests (#1572) 3 years ago
contexts Move statement as a sub package (#1564) 3 years ago
convert Move tag parser related codes as a standalone sub package (#1547) 3 years ago
core Fix break session sql enable feature (#1566) 3 years ago
dialects Ignore schema when dbtype is not postgres (#1593) 3 years ago
internal Support count with cols (#1595) 3 years ago
log Fix break session sql enable feature (#1566) 3 years ago
migrate Merge core package back into the main repository and split into serval sub packages. (#1543) 3 years ago
names Fix table name (#1590) 3 years ago
schemas jerry:add postgre data_type array (#1589) 3 years ago
tags Use a new ContextLogger interface to implement logger (#1557) 3 years ago
.changelog.yml Add changelog file and tool configuration (#1546) 3 years ago
.drone.yml Improve quote policy (#1567) 3 years ago
.gitignore Merge core package back into the main repository and split into serval sub packages. (#1543) 3 years ago
.revive.toml Add makefile (#1531) 3 years ago
CHANGELOG.md Add changelog file and tool configuration (#1546) 3 years ago
CONTRIBUTING.md Add changelog file and tool configuration (#1546) 3 years ago
LICENSE copyright: added owner 7 years ago
Makefile Fix bug when dump (#1597) 3 years ago
README.md Update README (#1582) 3 years ago
README_CN.md Update README (#1582) 3 years ago
cache_test.go Merge core package back into the main repository and split into serval sub packages. (#1543) 3 years ago
convert.go Improve tests (#1572) 3 years ago
doc.go Merge core package back into the main repository and split into serval sub packages. (#1543) 3 years ago
engine.go Fix bug when dump (#1597) 3 years ago
engine_group.go Improve quote policy (#1567) 3 years ago
engine_group_policy.go Add support Engine Group (#748) 5 years ago
engine_test.go Improve tests (#1572) 3 years ago
error.go Improve insert (#1583) 3 years ago
go.mod Add leveldb cache store (#1545) 3 years ago
go.sum Add leveldb cache store (#1545) 3 years ago
interface.go Support count with cols (#1595) 3 years ago
processors.go improve processors (#743) 5 years ago
processors_test.go Improve tests (#1572) 3 years ago
rows.go Only replace quotes when necessary (#1584) 3 years ago
rows_test.go Fix rows bug (#1576) 3 years ago
session.go Improve insert (#1583) 3 years ago
session_cols.go Move statement as a sub package (#1564) 3 years ago
session_cols_test.go Improve dialect interface (#1578) 3 years ago
session_cond.go Move statement as a sub package (#1564) 3 years ago
session_cond_test.go Improve tests (#1572) 3 years ago
session_convert.go Move value2interface from session to statement package (#1587) 3 years ago
session_delete.go Improve dialect interface (#1578) 3 years ago
session_delete_test.go Improve dialect interface (#1578) 3 years ago
session_exist.go Move statement as a sub package (#1564) 3 years ago
session_exist_test.go Improve tests (#1572) 3 years ago
session_find.go Fix find alias bug (#1581) 3 years ago
session_find_test.go Fix find alias bug (#1581) 3 years ago
session_get.go Only replace quotes when necessary (#1584) 3 years ago
session_get_test.go Improve dialect interface (#1578) 3 years ago
session_insert.go fix batch insert []interface{*struct, ...} be panic;add TestInsertMulti2Interface testcase 3 years ago
session_insert_test.go fix batch insert []interface{*struct, ...} be panic;add TestInsertMulti2Interface testcase 3 years ago
session_iterate.go Move statement as a sub package (#1564) 3 years ago
session_iterate_test.go fix bug when buffersize with iterate (#941) 3 years ago
session_pk_test.go Improve tests (#1572) 3 years ago
session_query.go Move statement as a sub package (#1564) 3 years ago
session_query_test.go Improve dialect interface (#1578) 3 years ago
session_raw.go Only replace quotes when necessary (#1584) 3 years ago
session_raw_test.go Add SetSchema for engine (#876) 5 years ago
session_schema.go return sqls for create table (#1580) 3 years ago
session_schema_test.go Improve tests (#1572) 3 years ago
session_stats.go Move statement as a sub package (#1564) 3 years ago
session_stats_test.go Support count with cols (#1595) 3 years ago
session_test.go Fix break session sql enable feature (#1566) 3 years ago
session_tx.go Move some codes to statement sub package (#1574) 3 years ago
session_tx_test.go Improve tests (#1572) 3 years ago
session_update.go Move value2interface from session to statement package (#1587) 3 years ago
session_update_test.go Improve tests (#1572) 3 years ago
tags_test.go Fix mssql issue with duplicate columns. (#1225) 3 years ago
time_test.go Improve tests (#1572) 3 years ago
types_null_test.go check driver.Valuer response, and skip the column if nil (#1167) 3 years ago
types_test.go 解决Conversion接口ToDB() ([]byte, error)方法返回*Type值为nil时,数据类型为[]byte(nil)的… (#1296) 3 years ago
xorm.go Update README (#1582) 3 years ago
xorm_test.go Improve quote policy (#1567) 3 years ago

README.md

xorm

中文

Xorm is a simple and powerful ORM for Go.

Build Status Join the chat at https://img.shields.io/discord/323460943201959939.svg

Features

  • 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 via xorm.io/reverse

  • 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 Support

Drivers for Go's sql package which currently support database/sql includes:

Installation

go get xorm.io/xorm

Documents

Quick Start

  • Create Engine
engine, err := xorm.NewEngine(driverName, dataSourceName)
  • Define a struct and Sync2 table struct to database
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))
  • Create Engine Group
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 error
affected, err := engine.Exec("update user set age = ? where name = ?", age, name)
  • Insert one or multiple records to database
affected, 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 database
has, 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 table
has, 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 extends
var 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 Rows
err := 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 condition
affected, err := engine.Where(...).Delete(&user)
// DELETE FROM user Where ...

affected, err := engine.ID(2).Delete(&user)
// DELETE FROM user Where id = ?
  • Count count records
counts, err := engine.Count(&user)
// SELECT count(*) AS total FROM user
  • FindAndCount combines function Find with Count which is usually used in query by page
var users []User
counts, err := engine.FindAndCount(&users)
  • Sum sum functions
agesFloat64, 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
  • Query conditions builder
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 (?, ?, ?)
  • Multiple operations in one go routine, no transation here but resue session memory
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
  • Transation should be on one go routine. There is transaction and resue session memory
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()
  • Or you can use 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
})
  • Context Cache, if enabled, current query result will be cached on session and be used by next same statement on the same session.
	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)

Contributing

If you want to pull request, please see CONTRIBUTING. And we also provide Xorm on Google Groups to discuss.

Credits

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Changelog

You can find all the changelog here

Cases

LICENSE

BSD License http://creativecommons.org/licenses/BSD/