Simple and Powerful ORM for Go, support mysql,postgres,tidb,sqlite3,mssql,oracle https://xorm.io
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.
Lunny Xiao c349d36e95 Fix update with Alias (#1455) преди 3 седмици
.circleci move depends package from github.com to customize domain (#1327) преди 5 месеца
docs/images remove docs submodule (#568) преди 2 години
examples Move github.com/go-xorm/xorm to xorm.io/xorm (#1459) преди 1 месец
migrate Move github.com/go-xorm/xorm to xorm.io/xorm (#1459) преди 1 месец
.drone.yml Improve ci tests (#1477) преди 3 седмици
.gitignore enhancement: auto-transaction (#1093) преди 1 година
CONTRIBUTING.md Move github.com/go-xorm/xorm to xorm.io/xorm (#1459) преди 1 месец
LICENSE copyright: added owner преди 4 години
README.md Fix go mod and update version (#1460) преди 1 месец
README_CN.md Fix go mod and update version (#1460) преди 1 месец
cache_lru.go move depends package from github.com to customize domain (#1327) преди 5 месеца
cache_lru_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
cache_memory_store.go move depends package from github.com to customize domain (#1327) преди 5 месеца
cache_memory_store_test.go fix bug on cache delete (#703) преди 2 години
cache_test.go Add support Engine Group (#748) преди 2 години
context_cache.go Get adds context cache feature (#1102) преди 1 година
convert.go remove some unnecessary debug log and some refactor (#791) преди 2 години
dialect_mssql.go Fix wrong dbmetas (#1442) преди 2 месеца
dialect_mssql_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
dialect_mysql.go Fix default value parse bugs (#1437) преди 2 месеца
dialect_oracle.go Remove quotestr totally (#1366) преди 4 месеца
dialect_postgres.go Fix default value parse bugs (#1437) преди 2 месеца
dialect_postgres_test.go fix tests (#1429) преди 2 месеца
dialect_sqlite3.go Fix wrong dbmetas (#1442) преди 2 месеца
dialect_sqlite3_test.go Fix default value parse bugs (#1437) преди 2 месеца
doc.go Move github.com/go-xorm/xorm to xorm.io/xorm (#1459) преди 1 месец
engine.go Rewrite Engine.QuoteTo() to accept multi-part identifiers (#1476) преди 4 седмици
engine_cond.go move depends package from github.com to customize domain (#1327) преди 5 месеца
engine_context.go Add context support (#1193) преди 10 месеца
engine_context_test.go make sure timeout in context timeout test (#1363) преди 4 месеца
engine_group.go move depends package from github.com to customize domain (#1327) преди 5 месеца
engine_group_policy.go Add support Engine Group (#748) преди 2 години
engine_table.go move depends package from github.com to customize domain (#1327) преди 5 месеца
engine_table_test.go add test for tablename (#885) преди 1 година
engine_test.go Rewrite Engine.QuoteTo() to accept multi-part identifiers (#1476) преди 4 седмици
error.go Add lasterror on statement to return errors when chain operations (#1151) преди 10 месеца
gen_reserved.sh add gen_reserved.sh преди 5 години
go.mod Fix go mod and update version (#1460) преди 1 месец
go.sum Fix go mod and update version (#1460) преди 1 месец
helpers.go remove QuoteStr() usage (#1360) преди 4 месеца
helpers_test.go Fix default value parse bugs (#1437) преди 2 месеца
helpler_time.go fix time issues and add some tests for time (#604) преди 2 години
interface.go Add support subquery on SetExpr (#1428) преди 2 месеца
json.go Let defaultJsonHandler be a json handler interface. (#1269) преди 8 месеца
logger.go move depends package from github.com to customize domain (#1327) преди 5 месеца
pg_reserved.txt add gen_reserved.sh преди 5 години
processors.go improve processors (#743) преди 2 години
processors_test.go Add mssql ci test (#1203) преди 10 месеца
rows.go fix no rows return error when close (#1334) преди 5 месеца
rows_test.go fix no rows return error when close (#1334) преди 5 месеца
session.go Support local sql log (#1338) преди 1 месец
session_cols.go Add support subquery on SetExpr (#1428) преди 2 месеца
session_cols_test.go fix setexpr missing big quotes (#1431) преди 2 месеца
session_cond.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_cond_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_context.go Add context support (#1193) преди 10 месеца
session_context_test.go make sure timeout in context timeout test (#1363) преди 4 месеца
session_convert.go add support custom type Nullfloat64 (#1450) преди 2 месеца
session_delete.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_delete_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_exist.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_exist_test.go Add SetSchema for engine (#876) преди 1 година
session_find.go Move github.com/go-xorm/xorm to xorm.io/xorm (#1459) преди 1 месец
session_find_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_get.go fix get customize type bug (#1382) преди 4 месеца
session_get_test.go fix bug when query map condtion with no quote (#1449) преди 2 месеца
session_insert.go fix bug when insert multiple slices with customize table name (#1433) преди 2 месеца
session_insert_test.go Improve ci tests (#1477) преди 3 седмици
session_iterate.go Add lasterror on statement to return errors when chain operations (#1151) преди 10 месеца
session_iterate_test.go add buffer Iterate support (#729) преди 2 години
session_pk_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_query.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_query_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_raw.go Support local sql log (#1338) преди 1 месец
session_raw_test.go Add SetSchema for engine (#876) преди 1 година
session_schema.go Don't warn when bool column default is 1 but not true (#1447) преди 2 месеца
session_schema_test.go Improve ci tests (#1477) преди 3 седмици
session_stats.go refactor query functions (#689) преди 2 години
session_stats_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_test.go add support custom type Nullfloat64 (#1450) преди 2 месеца
session_tx.go Add context support (#1193) преди 10 месеца
session_tx_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
session_update.go Fix update with Alias (#1455) преди 3 седмици
session_update_test.go Fix update with Alias (#1455) преди 3 седмици
statement.go fix bug when query map condtion with no quote (#1449) преди 2 месеца
statement_args.go fix arg conversion (#1441) преди 2 месеца
statement_columnmap.go Add support subquery on SetExpr (#1428) преди 2 месеца
statement_exprparam.go fix arg conversion (#1441) преди 2 месеца
statement_quote.go Add support subquery on SetExpr (#1428) преди 2 месеца
statement_test.go remove QuoteStr() usage (#1360) преди 4 месеца
syslogger.go move depends package from github.com to customize domain (#1327) преди 5 месеца
tag.go Fix default value parse bugs (#1437) преди 2 месеца
tag_cache_test.go fix update map with table name (#888) преди 1 година
tag_extends_test.go Allow adding prefix for fields with `extends` tag (#1284) преди 5 месеца
tag_id_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
tag_test.go Fix wrong dbmetas (#1442) преди 2 месеца
tag_version_test.go Add version uint type support (#1125) преди 1 година
test_mssql.sh Fix default value parse bugs (#1437) преди 2 месеца
test_mssql_cache.sh fix bug on cache delete (#703) преди 2 години
test_mymysql.sh add mymysql tests (#656) преди 2 години
test_mymysql_cache.sh fix bug on cache delete (#703) преди 2 години
test_mysql.sh add more tests (#595) преди 2 години
test_mysql_cache.sh fix bug on cache delete (#703) преди 2 години
test_postgres.sh add more tests (#595) преди 2 години
test_postgres_cache.sh fix bug on cache delete (#703) преди 2 години
test_sqlite.sh add more tests (#595) преди 2 години
test_sqlite_cache.sh fix bug on cache delete (#703) преди 2 години
test_tidb.sh Add tests for tidb (#1207) преди 10 месеца
time_test.go Add support Engine Group (#748) преди 2 години
transaction.go enhancement: auto-transaction (#1093) преди 1 година
transancation_test.go enhancement: auto-transaction (#1093) преди 1 година
types.go move depends package from github.com to customize domain (#1327) преди 5 месеца
types_null_test.go Improve ci tests (#1477) преди 3 седмици
types_test.go move depends package from github.com to customize domain (#1327) преди 5 месеца
xorm.go Fix go mod and update version (#1460) преди 1 месец
xorm_test.go Fix wrong dbmetas (#1442) преди 2 месеца

README.md

xorm

中文

Xorm is a simple and powerful ORM for Go.

Build Status

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, 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 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

  • v0.7.0

    • Some bugs fixed
  • v0.6.6

    • Some bugs fixed
  • v0.6.5

    • Postgres schema support
    • vgo support
    • Add FindAndCount
    • Database special params support via NewEngineWithParams
    • Some bugs fixed
  • v0.6.4

    • Automatical Read/Write seperatelly
    • Query/QueryString/QueryInterface and action with Where/And
    • Get support non-struct variables
    • BufferSize on Iterate
    • fix some other bugs.

More changes …

Cases

LICENSE

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