THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

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 f39e5d9bfd
Update README.md
1 주 전
.circleci move depends package from github.com to customize domain (#1327) 4 달 전
docs/images remove docs submodule (#568) 2 년 전
examples 缺少sqlite库 (#1083) 1 년 전
migrate clean up go modules (#1260) 6 달 전
.drone.yml add tidb tests on drone ci (#1444) 3 주 전
.gitignore enhancement: auto-transaction (#1093) 1 년 전
CONTRIBUTING.md update contributing (#780) 1 년 전
LICENSE copyright: added owner 4 년 전
README.md Update README.md 1 주 전
README_CN.md Update README_CN.md (#1331) 4 달 전
cache_lru.go move depends package from github.com to customize domain (#1327) 4 달 전
cache_lru_test.go move depends package from github.com to customize domain (#1327) 4 달 전
cache_memory_store.go move depends package from github.com to customize domain (#1327) 4 달 전
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) 1 년 전
dialect_mssql.go Fix wrong dbmetas (#1442) 3 주 전
dialect_mssql_test.go move depends package from github.com to customize domain (#1327) 4 달 전
dialect_mysql.go Fix default value parse bugs (#1437) 3 주 전
dialect_oracle.go Remove quotestr totally (#1366) 3 달 전
dialect_postgres.go Fix default value parse bugs (#1437) 3 주 전
dialect_postgres_test.go fix tests (#1429) 1 개월 전
dialect_sqlite3.go Fix wrong dbmetas (#1442) 3 주 전
dialect_sqlite3_test.go Fix default value parse bugs (#1437) 3 주 전
doc.go refactor query functions (#689) 2 년 전
engine.go improve sync2 (#1443) 3 주 전
engine_cond.go move depends package from github.com to customize domain (#1327) 4 달 전
engine_context.go Add context support (#1193) 9 달 전
engine_context_test.go make sure timeout in context timeout test (#1363) 3 달 전
engine_group.go move depends package from github.com to customize domain (#1327) 4 달 전
engine_group_policy.go Add support Engine Group (#748) 2 년 전
engine_table.go move depends package from github.com to customize domain (#1327) 4 달 전
engine_table_test.go add test for tablename (#885) 1 년 전
error.go Add lasterror on statement to return errors when chain operations (#1151) 9 달 전
gen_reserved.sh add gen_reserved.sh 5 년 전
go.mod fix arg conversion (#1441) 3 주 전
go.sum fix arg conversion (#1441) 3 주 전
helpers.go remove QuoteStr() usage (#1360) 3 달 전
helpers_test.go Fix default value parse bugs (#1437) 3 주 전
helpler_time.go fix time issues and add some tests for time (#604) 2 년 전
interface.go Add support subquery on SetExpr (#1428) 4 주 전
json.go Let defaultJsonHandler be a json handler interface. (#1269) 6 달 전
logger.go move depends package from github.com to customize domain (#1327) 4 달 전
pg_reserved.txt add gen_reserved.sh 5 년 전
processors.go improve processors (#743) 2 년 전
processors_test.go Add mssql ci test (#1203) 9 달 전
rows.go fix no rows return error when close (#1334) 4 달 전
rows_test.go fix no rows return error when close (#1334) 4 달 전
session.go move depends package from github.com to customize domain (#1327) 4 달 전
session_cols.go Add support subquery on SetExpr (#1428) 4 주 전
session_cols_test.go fix setexpr missing big quotes (#1431) 4 주 전
session_cond.go move depends package from github.com to customize domain (#1327) 4 달 전
session_cond_test.go move depends package from github.com to customize domain (#1327) 4 달 전
session_context.go Add context support (#1193) 9 달 전
session_context_test.go make sure timeout in context timeout test (#1363) 3 달 전
session_convert.go add support custom type Nullfloat64 (#1450) 2 주 전
session_delete.go move depends package from github.com to customize domain (#1327) 4 달 전
session_delete_test.go move depends package from github.com to customize domain (#1327) 4 달 전
session_exist.go move depends package from github.com to customize domain (#1327) 4 달 전
session_exist_test.go Add SetSchema for engine (#876) 1 년 전
session_find.go fix bugs (#1375) 2 달 전
session_find_test.go move depends package from github.com to customize domain (#1327) 4 달 전
session_get.go fix get customize type bug (#1382) 2 달 전
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) 3 주 전
session_insert_test.go fix arg conversion (#1441) 3 주 전
session_iterate.go Add lasterror on statement to return errors when chain operations (#1151) 9 달 전
session_iterate_test.go add buffer Iterate support (#729) 2 년 전
session_pk_test.go move depends package from github.com to customize domain (#1327) 4 달 전
session_query.go move depends package from github.com to customize domain (#1327) 4 달 전
session_query_test.go move depends package from github.com to customize domain (#1327) 4 달 전
session_raw.go move depends package from github.com to customize domain (#1327) 4 달 전
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 Don't warn when bool column default is 1 but not true (#1447) 2 주 전
session_stats.go refactor query functions (#689) 2 년 전
session_stats_test.go move depends package from github.com to customize domain (#1327) 4 달 전
session_test.go add support custom type Nullfloat64 (#1450) 2 주 전
session_tx.go Add context support (#1193) 9 달 전
session_tx_test.go move depends package from github.com to customize domain (#1327) 4 달 전
session_update.go fix setexpr missing big quotes (#1431) 4 주 전
session_update_test.go fix bug when update with setexpr (#1446) 2 주 전
statement.go fix bug when query map condtion with no quote (#1449) 2 주 전
statement_args.go fix arg conversion (#1441) 3 주 전
statement_columnmap.go Add support subquery on SetExpr (#1428) 4 주 전
statement_exprparam.go fix arg conversion (#1441) 3 주 전
statement_quote.go Add support subquery on SetExpr (#1428) 4 주 전
statement_test.go remove QuoteStr() usage (#1360) 3 달 전
syslogger.go move depends package from github.com to customize domain (#1327) 4 달 전
tag.go Fix default value parse bugs (#1437) 3 주 전
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) 4 달 전
tag_id_test.go move depends package from github.com to customize domain (#1327) 4 달 전
tag_test.go Fix wrong dbmetas (#1442) 3 주 전
tag_version_test.go Add version uint type support (#1125) 1 년 전
test_mssql.sh Fix default value parse bugs (#1437) 3 주 전
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) 8 달 전
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) 4 달 전
types_null_test.go refactor query functions (#689) 2 년 전
types_test.go move depends package from github.com to customize domain (#1327) 4 달 전
xorm.go move depends package from github.com to customize domain (#1327) 4 달 전
xorm_test.go Fix wrong dbmetas (#1442) 3 주 전

README.md

xorm HAS BEEN MOVED TO https://gitea.com/xorm/xorm . THIS REPOSITORY WILL NOT BE UPDATED ANY MORE.

中文

Xorm is a simple and powerful ORM for Go.

CircleCI codecov

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 github.com/go-xorm/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 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/