gitea/vendor/github.com/go-xorm/xorm/README.md

中文

Xorm is a simple and powerful ORM for Go.

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

Drivers Support

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

• Mysql: github.com/go-sql-driver/mysql

• MyMysql: github.com/ziutek/mymysql/godrv

• Postgres: github.com/lib/pq

• Tidb: github.com/pingcap/tidb

• SQLite: github.com/mattn/go-sqlite3

• MsSql: github.com/denisenkom/go-mssqldb

• Oracle: github.com/mattn/go-oci8 (experiment)

Changelog

• 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

• v0.6.0

  • remove support for ql
  • add query condition builder support via github.com/go-xorm/builder, so Where, And, Or methods can use builder.Cond as parameter
  • add Sum, SumInt, SumInt64 and NotIn methods
  • some bugs fixed

More changes ...

Installation

go get github.com/go-xorm/xorm

Documents

• Manual

• GoDoc

• GoWalker

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

• Query runs a SQL string, the returned results is []map[string][]byte, QueryString returns []map[string]string.

results, err := engine.Query("select * from user")

results, err := engine.QueryString("select * from user")

• Execute 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 (),(),()

• 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)
// 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 = ?

• 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

• 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

• 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

rows, err := engine.Rows(&User{Name:name})
// SELECT * FROM user
defer rows.Close()
bean := new(Struct)
for rows.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 = ?

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

• 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 (?, ?, ?)

Cases

• studygolang - github.com/studygolang/studygolang

• Gitea - github.com/go-gitea/gitea

• Gogs - github.com/gogits/gogs

• grafana - github.com/grafana/grafana

• github.com/m3ng9i/qreader

• Wego

• Docker.cn

• Xorm Adapter for Casbin - github.com/casbin/xorm-adapter

• Gorevel - github.com/goofcc/gorevel

• Gowalker - github.com/Unknwon/gowalker

• Gobuild.io - github.com/shxsun/gobuild

• Sudo China - github.com/insionng/toropress

• Godaily - github.com/govc/godaily

• YouGam

• GoCMS - github.com/zzboy/GoCMS

• GoBBS - gobbs.domolo.com

• go-blog - github.com/easykoo/go-blog

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/