gitea/vendor/github.com/go-xorm/xorm
Lunny Xiao 284c0160c3 update xorm vendor and also fix #740 (#886) 2017-02-10 23:02:26 +08:00
..
CONTRIBUTING.md Added all required dependencies 2016-11-04 08:43:11 +01:00
LICENSE Added all required dependencies 2016-11-04 08:43:11 +01:00
README.md Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
README_CN.md Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
VERSION Added all required dependencies 2016-11-04 08:43:11 +01:00
circle.yml Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
doc.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
engine.go update xorm vendor and also fix #740 (#886) 2017-02-10 23:02:26 +08:00
error.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
gen_reserved.sh Added all required dependencies 2016-11-04 08:43:11 +01:00
goracle_driver.go Added all required dependencies 2016-11-04 08:43:11 +01:00
helpers.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
logger.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
lru_cacher.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
memory_store.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
mssql_dialect.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
mymysql_driver.go Added all required dependencies 2016-11-04 08:43:11 +01:00
mysql_dialect.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
mysql_driver.go Added all required dependencies 2016-11-04 08:43:11 +01:00
oci8_driver.go Added all required dependencies 2016-11-04 08:43:11 +01:00
odbc_driver.go Added all required dependencies 2016-11-04 08:43:11 +01:00
oracle_dialect.go Fix error 500 on organization dashboard page (#150) 2016-11-12 00:40:21 +08:00
pg_reserved.txt Added all required dependencies 2016-11-04 08:43:11 +01:00
postgres_dialect.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
pq_driver.go Added all required dependencies 2016-11-04 08:43:11 +01:00
processors.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
rows.go Added all required dependencies 2016-11-04 08:43:11 +01:00
session.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
session_delete.go fix: delete attachment after remove comment. 2017-01-25 16:40:43 +01:00
session_find.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
session_get.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
session_insert.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
session_iterate.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
session_raw.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
session_schema.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
session_sum.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
session_tx.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
session_update.go fix: delete attachment after remove comment. 2017-01-25 16:40:43 +01:00
sqlite3_dialect.go update xorm for bugs fix (#728) 2017-01-23 19:11:57 +08:00
sqlite3_driver.go Added all required dependencies 2016-11-04 08:43:11 +01:00
statement.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
syslogger.go Update xorm and dependencies vendor for feature to dump to other database (#565) 2017-01-03 16:20:28 +08:00
types.go Update xorm and fix dump command (#692) 2017-01-23 17:11:18 +08:00
xorm.go Added all required dependencies 2016-11-04 08:43:11 +01:00

README.md

中文

Xorm is a simple and powerful ORM for Go.

CircleCI Gitter

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

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

Drivers Support

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

Changelog

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

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

    • many bugs fixed
    • extends support unlimited deepth
    • 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
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 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 1
has, 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
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

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/