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 bd20c37bfb
Add SetSchema for engine (#876)
2 years ago
docs/images remove docs submodule (#568) 3 years ago
examples refactor query functions (#689) 2 years ago
migrate fix: gofmt error. (#873) 2 years ago
vendor remove core and builder from vendor since it will break go get 3 years ago
.gitignore docs(README): fix limit sql (#830) 2 years ago
CONTRIBUTING.md update contributing (#780) 2 years ago
LICENSE copyright: added owner 4 years ago
README.md update README 2 years ago
README_CN.md update README 2 years ago
cache_lru.go fix bug on cache delete (#703) 2 years ago
cache_lru_test.go fix bug on cache delete (#703) 2 years ago
cache_memory_store.go add some tests for tag and cache related with #330 3 years ago
cache_memory_store_test.go fix bug on cache delete (#703) 2 years ago
cache_test.go Add support Engine Group (#748) 2 years ago
circle.yml Add SetSchema for engine (#876) 2 years ago
context.go add PingContext support for go1.8+ (#766) 2 years ago
context_test.go add PingContext support for go1.8+ (#766) 2 years ago
convert.go remove some unnecessary debug log and some refactor (#791) 2 years ago
dialect_mssql.go fix time issues and add some tests for time (#604) 3 years ago
dialect_mysql.go Add NewEngineWithParams method can call SetParams for dialect. The dialect_… (#798) 2 years ago
dialect_oracle.go bug fixed for mssql dialect 3 years ago
dialect_postgres.go Add SetSchema for engine (#876) 2 years ago
dialect_postgres_test.go Improve schema support on postgres dialect (#845) 2 years ago
dialect_sqlite3.go fix bug and add set conn max lifetime (#606) 3 years ago
doc.go refactor query functions (#689) 2 years ago
engine.go Add SetSchema for engine (#876) 2 years ago
engine_cond.go add CondDeleted method (#620) 3 years ago
engine_group.go Add support Engine Group (#748) 2 years ago
engine_group_policy.go Add support Engine Group (#748) 2 years ago
engine_maxlife.go Add support Engine Group (#748) 2 years ago
engine_table.go Add SetSchema for engine (#876) 2 years ago
error.go add support for map[string]interface{} as condition on Update and Where (#764) 2 years ago
gen_reserved.sh add gen_reserved.sh 5 years ago
go.mod add vgo support 2 years ago
helpers.go fix time tag utc (#742) 2 years ago
helpers_test.go move lifetime to a split file so that go1.1 is also work with this feature (#612) 3 years ago
helpler_time.go fix time issues and add some tests for time (#604) 3 years ago
interface.go Add SetSchema for engine (#876) 2 years ago
logger.go golint fix 3 years ago
pg_reserved.txt add gen_reserved.sh 5 years ago
processors.go improve processors (#743) 2 years ago
processors_test.go Add tests for afterinsert (#755) 2 years ago
rows.go Add SetSchema for engine (#876) 2 years ago
rows_test.go Add SetSchema for engine (#876) 2 years ago
session.go Add SetSchema for engine (#876) 2 years ago
session_cols.go hide all undocument variables on session (#660) 2 years ago
session_cols_test.go Add support Engine Group (#748) 2 years ago
session_cond.go hide all undocument variables on session (#660) 2 years ago
session_cond_test.go Add SetSchema for engine (#876) 2 years ago
session_convert.go remove some unnecessary debug log and some refactor (#791) 2 years ago
session_delete.go Add SetSchema for engine (#876) 2 years ago
session_delete_test.go Add support Engine Group (#748) 2 years ago
session_exist.go Add SetSchema for engine (#876) 2 years ago
session_exist_test.go Add SetSchema for engine (#876) 2 years ago
session_find.go fix findandcount bug with order (#869) 2 years ago
session_find_test.go Add SetSchema for engine (#876) 2 years ago
session_get.go Add SetSchema for engine (#876) 2 years ago
session_get_test.go Add SetSchema for engine (#876) 2 years ago
session_insert.go Add SetSchema for engine (#876) 2 years ago
session_insert_test.go Add SetSchema for engine (#876) 2 years ago
session_iterate.go add buffer Iterate support (#729) 2 years ago
session_iterate_test.go add buffer Iterate support (#729) 2 years ago
session_pk_test.go Add SetSchema for engine (#876) 2 years ago
session_query.go fix FindAndCount bug with Limit (#851) 2 years ago
session_query_test.go Add SetSchema for engine (#876) 2 years ago
session_raw.go Add support Engine Group (#748) 2 years ago
session_raw_test.go Add SetSchema for engine (#876) 2 years ago
session_schema.go Add SetSchema for engine (#876) 2 years ago
session_schema_test.go fix sync bug (#857) 2 years ago
session_stats.go refactor query functions (#689) 2 years ago
session_stats_test.go Add SetSchema for engine (#876) 2 years ago
session_test.go tests for close and add IsClosed() method (#659) 2 years ago
session_tx.go hide all undocument variables on session (#660) 2 years ago
session_tx_test.go Add SetSchema for engine (#876) 2 years ago
session_update.go Add SetSchema for engine (#876) 2 years ago
session_update_test.go Add SetSchema for engine (#876) 2 years ago
statement.go Add SetSchema for engine (#876) 2 years ago
statement_test.go Add support Engine Group (#748) 2 years ago
syslogger.go some golints fixed 3 years ago
tag.go Add comment support on create table [mysql only currently] (#616) 3 years ago
tag_cache_test.go add more tests (#595) 3 years ago
tag_extends_test.go Add SetSchema for engine (#876) 2 years ago
tag_id_test.go Add support Engine Group (#748) 2 years ago
tag_test.go Add support Engine Group (#748) 2 years ago
tag_version_test.go refactor query functions (#689) 2 years ago
test_mssql.sh fix time issues and add some tests for time (#604) 3 years ago
test_mssql_cache.sh fix bug on cache delete (#703) 2 years ago
test_mymysql.sh add mymysql tests (#656) 2 years ago
test_mymysql_cache.sh fix bug on cache delete (#703) 2 years ago
test_mysql.sh add more tests (#595) 3 years ago
test_mysql_cache.sh fix bug on cache delete (#703) 2 years ago
test_postgres.sh add more tests (#595) 3 years ago
test_postgres_cache.sh fix bug on cache delete (#703) 2 years ago
test_sqlite.sh add more tests (#595) 3 years ago
test_sqlite_cache.sh fix bug on cache delete (#703) 2 years ago
time_test.go Add support Engine Group (#748) 2 years ago
types.go some gofmt & golint fixed 3 years ago
types_null_test.go refactor query functions (#689) 2 years ago
types_test.go Add SetSchema for engine (#876) 2 years ago
xorm.go Add NewEngineWithParams method can call SetParams for dialect. The dialect_… (#798) 2 years ago
xorm_test.go Add SetSchema for engine (#876) 2 years ago

README.md

中文

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