Lunny Xiao ba71ae6665
remove unused comments
9 months ago
docs/images remove docs submodule (#568) 9 months ago
examples golint fix 1 year ago
migrate Add migrate package for schema versioned migrations (#549) 10 months ago
vendor remove core and builder from vendor since it will break go get 9 months ago
.gitignore don't ignore vendor folder 10 months ago
CONTRIBUTING.md resolved #380 1 year ago
LICENSE copyright: added owner 2 years ago
README.md add QueryString support 9 months ago
README_CN.md add QueryString support 9 months ago
circle.yml fixed user 1 year ago
convert.go bug fixed #565 9 months ago
dialect_mssql.go bug fixed for mssql dialect 9 months ago
dialect_mysql.go Rename the dialect file name (#557) 9 months ago
dialect_oracle.go bug fixed for mssql dialect 9 months ago
dialect_postgres.go bug fixed for mssql dialect 9 months ago
dialect_sqlite3.go bug fixed for mssql dialect 9 months ago
doc.go fix docs error 10 months ago
engine.go remove trace code 9 months ago
error.go some golints fixed 1 year ago
gen_reserved.sh add gen_reserved.sh 3 years ago
helpers.go refactors 9 months ago
helpers_test.go resolved #67 2 years ago
logger.go golint fix 1 year ago
lru_cacher.go some golints fixed 1 year ago
memory_store.go some golints fixed 1 year ago
pg_reserved.txt add gen_reserved.sh 3 years ago
processors.go some golints fixed 1 year ago
processors_test.go bug fixed and add processors tests 9 months ago
rows.go fix #563 9 months ago
session.go remove unused comments 9 months ago
session_cols.go move some functions from session.go to session_cols.go and session_convert.go 10 months ago
session_cols_test.go add test framework 10 months ago
session_cond.go fix #516, #536 11 months ago
session_cond_test.go add cond test and fix missing quote on sum 10 months ago
session_convert.go refactor automaptype 9 months ago
session_delete.go fix #563 9 months ago
session_find.go fix #563 9 months ago
session_find_test.go remove core and builder from vendor since it will break go get 9 months ago
session_get.go fix #563 9 months ago
session_get_test.go bug fixed #565 9 months ago
session_insert.go fix #563 9 months ago
session_insert_test.go add test for InsertOne to confirm #545 10 months ago
session_iterate.go add Find ints support & split session into multiple files 1 year ago
session_pk_test.go move pk tests from tests repo 10 months ago
session_raw.go refactors 9 months ago
session_raw_test.go add QueryString support 9 months ago
session_schema.go fix #563 9 months ago
session_sum.go bug fix for SumsInt return empty slice (#542) 10 months ago
session_sum_test.go fix #570 9 months ago
session_tx.go add Find ints support & split session into multiple files 1 year ago
session_update.go fix #563 9 months ago
session_update_test.go fix #544 9 months ago
statement.go fix bug on sum 9 months ago
statement_test.go go test add mysql and postgres drivers 9 months ago
syslogger.go some golints fixed 1 year ago
tag.go Handle xorm tags via tagHandler prepared for customerize tag support (#551) 9 months ago
types.go some gofmt & golint fixed 1 year ago
types_test.go fix #559 9 months ago
xorm.go change the version 9 months ago
xorm_test.go go test add mysql and postgres drivers 9 months ago

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

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