Simple and Powerful ORM for Go, support mysql,postgres,tidb,sqlite3,sqlite,mssql,oracle,cockroach https://xorm.io
Go to file
Lunny Xiao 1933dd69e2
update READMEs
2017-12-04 22:05:36 +08:00
docs/images remove docs submodule (#568) 2017-04-12 22:37:57 +08:00
examples refactor query functions (#689) 2017-08-27 15:50:43 +08:00
migrate Add migrate package for schema versioned migrations (#549) 2017-03-25 22:10:23 +08:00
vendor remove core and builder from vendor since it will break go get 2017-03-28 08:59:37 +08:00
.gitignore don't ignore vendor folder 2017-03-26 20:31:47 +08:00
cache_lru_test.go fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
cache_lru.go fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
cache_memory_store_test.go fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
cache_memory_store.go add some tests for tag and cache related with #330 2017-05-27 13:50:57 +08:00
cache_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
circle.yml fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
context_test.go add PingContext support for go1.8+ (#766) 2017-10-31 17:30:01 +08:00
context.go add PingContext support for go1.8+ (#766) 2017-10-31 17:30:01 +08:00
CONTRIBUTING.md update contributing (#780) 2017-11-17 21:17:20 +08:00
convert.go remove some unnecessary debug log and some refactor (#791) 2017-12-04 11:00:39 +08:00
dialect_mssql.go fix time issues and add some tests for time (#604) 2017-06-02 16:12:50 +08:00
dialect_mysql.go add comment for mysql dialect (#579) 2017-05-04 21:12:02 +08:00
dialect_oracle.go bug fixed for mssql dialect 2017-04-05 18:17:41 +08:00
dialect_postgres_test.go Postgres dialect parse password with spaces (#775) (#779) 2017-11-17 23:41:52 +08:00
dialect_postgres.go Postgres dialect parse password with spaces (#775) (#779) 2017-11-17 23:41:52 +08:00
dialect_sqlite3.go fix bug and add set conn max lifetime (#606) 2017-06-05 15:08:30 +08:00
doc.go refactor query functions (#689) 2017-08-27 15:50:43 +08:00
engine_cond.go add CondDeleted method (#620) 2017-06-15 20:09:46 +08:00
engine_group_policy.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
engine_group.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
engine_maxlife.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
engine.go improve error string & fix #789 (#790) 2017-12-02 14:39:56 +08:00
error.go add support for map[string]interface{} as condition on Update and Where (#764) 2017-10-30 11:07:56 +08:00
gen_reserved.sh add gen_reserved.sh 2014-09-22 09:48:17 +08:00
helpers_test.go move lifetime to a split file so that go1.1 is also work with this feature (#612) 2017-06-08 10:21:01 +08:00
helpers.go fix time tag utc (#742) 2017-09-30 08:59:13 +08:00
helpler_time.go fix time issues and add some tests for time (#604) 2017-06-02 16:12:50 +08:00
interface.go QueryString and QueryInterface supports composite conditions (#784) 2017-11-20 16:14:27 +08:00
LICENSE copyright: added owner 2015-09-06 23:43:06 -04:00
logger.go golint fix 2017-01-09 09:56:02 +08:00
pg_reserved.txt add gen_reserved.sh 2014-09-22 09:48:17 +08:00
processors_test.go Add tests for afterinsert (#755) 2017-10-24 16:44:00 +08:00
processors.go improve processors (#743) 2017-09-30 09:26:13 +08:00
README_CN.md update READMEs 2017-12-04 22:05:36 +08:00
README.md update READMEs 2017-12-04 22:05:36 +08:00
rows_test.go add more tests for rows (#664) 2017-07-27 14:38:39 +08:00
rows.go improve processors (#743) 2017-09-30 09:26:13 +08:00
session_cols_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
session_cols.go hide all undocument variables on session (#660) 2017-07-27 13:32:35 +08:00
session_cond_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
session_cond.go hide all undocument variables on session (#660) 2017-07-27 13:32:35 +08:00
session_convert.go remove some unnecessary debug log and some refactor (#791) 2017-12-04 11:00:39 +08:00
session_delete_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
session_delete.go fix time tag utc (#742) 2017-09-30 08:59:13 +08:00
session_exist_test.go add Exist functions (#640) 2017-07-14 09:20:13 +08:00
session_exist.go refactor query functions (#689) 2017-08-27 15:50:43 +08:00
session_find_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
session_find.go improve processors (#743) 2017-09-30 09:26:13 +08:00
session_get_test.go add tests for json field string (#756) 2017-10-24 19:29:08 +08:00
session_get.go improve processors (#743) 2017-09-30 09:26:13 +08:00
session_insert_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
session_insert.go after call AfterInsert (#750) 2017-10-24 16:05:46 +08:00
session_iterate_test.go add buffer Iterate support (#729) 2017-09-19 20:59:41 +08:00
session_iterate.go add buffer Iterate support (#729) 2017-09-19 20:59:41 +08:00
session_pk_test.go fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
session_query_test.go Query now could work with Where, In, SQL and other condition methods (#776) 2017-11-15 11:34:59 +08:00
session_query.go QueryString and QueryInterface supports composite conditions (#784) 2017-11-20 16:14:27 +08:00
session_raw_test.go Query now could work with Where, In, SQL and other condition methods (#776) 2017-11-15 11:34:59 +08:00
session_raw.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
session_schema_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
session_schema.go refactor query functions (#689) 2017-08-27 15:50:43 +08:00
session_stats_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
session_stats.go refactor query functions (#689) 2017-08-27 15:50:43 +08:00
session_test.go tests for close and add IsClosed() method (#659) 2017-07-26 22:25:23 +08:00
session_tx_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
session_tx.go hide all undocument variables on session (#660) 2017-07-27 13:32:35 +08:00
session_update_test.go add support for map[string]interface{} as condition on Update and Where (#764) 2017-10-30 11:07:56 +08:00
session_update.go add support for map[string]interface{} as condition on Update and Where (#764) 2017-10-30 11:07:56 +08:00
session.go add string support (#730) 2017-10-24 17:51:27 +08:00
statement_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
statement.go mysql add column comment (#783) 2017-11-20 15:20:28 +08:00
syslogger.go some golints fixed 2016-12-11 12:45:37 +08:00
tag_cache_test.go add more tests (#595) 2017-05-30 20:33:30 +08:00
tag_extends_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
tag_id_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
tag_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
tag_version_test.go refactor query functions (#689) 2017-08-27 15:50:43 +08:00
tag.go Add comment support on create table [mysql only currently] (#616) 2017-06-14 14:16:40 +08:00
test_mssql_cache.sh fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
test_mssql.sh fix time issues and add some tests for time (#604) 2017-06-02 16:12:50 +08:00
test_mymysql_cache.sh fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
test_mymysql.sh add mymysql tests (#656) 2017-07-25 17:51:20 +08:00
test_mysql_cache.sh fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
test_mysql.sh add more tests (#595) 2017-05-30 20:33:30 +08:00
test_postgres_cache.sh fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
test_postgres.sh add more tests (#595) 2017-05-30 20:33:30 +08:00
test_sqlite_cache.sh fix bug on cache delete (#703) 2017-09-09 11:03:34 +08:00
test_sqlite.sh add more tests (#595) 2017-05-30 20:33:30 +08:00
time_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
types_null_test.go refactor query functions (#689) 2017-08-27 15:50:43 +08:00
types_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
types.go some gofmt & golint fixed 2017-01-09 09:52:23 +08:00
xorm_test.go Add support Engine Group (#748) 2017-10-16 15:28:13 +08:00
xorm.go fix bugs on Get (#718) 2017-09-10 20:58:18 +08:00

中文

Xorm is a simple and powerful ORM for Go.

CircleCI codecov 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, See Xorm Tool README

  • Simple cascade loading support

  • Optimistic Locking support

  • SQL Builder support via github.com/go-xorm/builder

  • Automatical Read/Write seperatelly

Drivers Support

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

Changelog

  • 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.
  • v0.6.3

    • merge tests to main project
    • add Exist function
    • add SumInt function
    • Mysql now support read and create column comment.
    • fix time related bugs.
    • fix some other bugs.
  • v0.6.2

    • refactor tag parse methods
    • add Scan features to Get
    • add QueryString method

More changes ...

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.Where("id = ?", id).Cols("name").Get(&name)
// SELECT name FROM user WHERE id = ?

var id int64
has, err := engine.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.Where("id = ?", id).Get(&valuesMap)
// SELECT * FROM user WHERE id = ?

var valuesSlice = make([]interface{}, len(cols))
has, err := engine.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 0 offset 10

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 0 offset 10
  • 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
  • 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()

Cases

Discuss

Please visit Xorm on Google Groups

Contributing

If you want to pull request, please see CONTRIBUTING

LICENSE

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