Skip to content

Latest commit

History

937 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

中文

Xorm is a simple and powerful ORM for Go.

Gitter

Build StatusGo WalkerBitdeli Badge

Notice

The last master version is not backwards compatible. You should use engine.ShowSQL() and engine.Logger().SetLevel() instead of engine.ShowSQL = , engine.ShowInfo = and so on.

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

Drivers Support

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

Changelog

  • v0.5.0

    • logging interface changed
    • some bugs fixed
  • v0.4.5

    • many bugs fixed
    • extends support unlimited deep
    • Delete Limit support
  • v0.4.4

    • ql database expriment support
    • tidb database expriment support
    • sql.NullString and etc. field support
    • select ForUpdate support
    • many bugs fixed

More changes ...

Installation

If you have gopm installed,

gopm get github.com/go-xorm/xorm

Or

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
typeUserstruct {
Idint64NamestringSaltstringAgeintPasswdstring`xorm:"varchar(200)"`Created time.Time`xorm:"created"`Updated time.Time`xorm:"updated"`
}
err:=engine.Sync2(new(User))
  • Query a SQL string, the returned results is []map[string][]byte
results, err:=engine.Query("select * from user")
  • Execute a SQL string, the returned results
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 (),(),()
  • Query one record from database
has, err:=engine.Get(&user)
// SELECT * FROM user LIMIT 1has, err:=engine.Where("name = ?", name).Desc("id").Get(&user)
// SELECT * FROM user WHERE name = ? ORDER BY id DESC LIMIT 1
  • Query multiple records from database, also you can use join and extends
varusers []Usererr:=engine.Where("name = ?", name).And("age > 10").Limit(10, 0).Find(&users)
// SELECT * FROM user WHERE name = ? AND age > 10 limit 0 offset 10typeDetailstruct {
Idint64UserIdint64`xorm:"index"`
}
typeUserDetailstruct {
User`xorm:"extends"`Detail`xorm:"extends"`
}
varusers []UserDetailerr:=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
  • Query multiple records and record by record handle, there are two methods Iterate and Rows
err:=engine.Iterate(&User{Name:name}, func(idxint, beaninterface{}) error {
user:=bean.(*User)
returnnil
})
// SELECT * FROM userrows, err:=engine.Rows(&User{Name:name})
// SELECT * FROM userdeferrows.Close()
bean:=new(Struct)
forrows.Next() {
err=rows.Scan(bean)
}
  • 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 = ?varids= []int64{1, 2, 3}
affected, err:=engine.In("id", ids).Update(&user)
// UPDATE user SET ... Where id IN (?, ?, ?)// force update indicated columns by Colsaffected, 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 Omitaffected, 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 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)
  • Count records
counts, err:=engine.Count(&user)
// SELECT count(*) AS total FROM user

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/

About

Simple and Powerful ORM for Go, support mysql,postgres,tidb,sqlite3,mssql,oracle

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages