diff --git a/README.md b/README.md index fd2ec66f..caddda68 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [中文](https://github.com/lunny/xorm/blob/master/README_CN.md) -xorm is a simple and powerful ORM for Go. It makes dabatabse operating simple. +Xorm is a simple and powerful ORM for Go. It makes dabatabse operating simple. [![Build Status](https://drone.io/github.com/lunny/xorm/status.png)](https://drone.io/github.com/lunny/xorm/latest) [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/lunny/xorm) [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/lunny/xorm/trend.png)](https://bitdeli.com/free "Bitdeli Badge") @@ -10,7 +10,6 @@ xorm is a simple and powerful ORM for Go. It makes dabatabse operating simple. Message me on [G+](https://plus.google.com/u/0/106406879480103142585) - ## Drivers Support Drivers for Go's sql package which currently support database/sql includes: @@ -25,7 +24,8 @@ Drivers for Go's sql package which currently support database/sql includes: ## Changelog - + +* **v0.2.1** : Added database reverse tool, now support generate go & c++ codes, see [Xorm Tool README](https://github.com/lunny/xorm/blob/master/xorm/README.md); some bug fixed. * **v0.2.0** : Added Cache supported, select is speeder up 3~5x; Added SameMapper for same name between struct and table; Added Sync method for auto added tables, columns, indexes; * **v0.1.9** : Added postgres and mymysql supported; Added ` and ? supported on Raw SQL even if postgres; Added Cols, StoreEngine, Charset function, Added many column data type supported, please see [Mapping Rules](#mapping). * **v0.1.8** : Added union index and union unique supported, please see [Mapping Rules](#mapping). @@ -50,355 +50,30 @@ Drivers for Go's sql package which currently support database/sql includes: * Support Id, In, Where, Limit, Join, Having, Sql functions and sturct as query conditions -* Support simple cascade load just like Hibernate for Java +* Support simple cascade load just like Hibernate for Java + +* Code generator support, See [Xorm Tool README](https://github.com/lunny/xorm/blob/master/xorm/README.md) ## Installing xorm go get github.com/lunny/xorm -## Quick Start - -1.Create a database engine just like sql.Open, commonly you just need create once. Please notice, Create function will be deprecated, use NewEngine instead. - -```Go -import ( - _ "github.com/Go-SQL-Driver/MySQL" - "github.com/lunny/xorm" -) -engine, err := xorm.NewEngine("mysql", "root:123@/test?charset=utf8") -defer engine.Close() -``` - -or - -```Go -import ( - _ "github.com/mattn/go-sqlite3" - "github.com/lunny/xorm" -) -engine, err = xorm.NewEngine("sqlite3", "./test.db") -defer engine.Close() -``` - -1.1.If you want to show all generated SQL - -```Go -engine.ShowSQL = true -``` -1.2 If you want to use your own connection pool -```Go -err = engine.SetPool(NewSimpleConnectPool()) -``` - -2.Define a struct - -```Go -type User struct { - Id int - Name string - Age int `xorm:"-"` -} -``` - -2.1.More mapping rules, please see [Mapping Rules](#mapping) - -3.When you set up your program, you can use CreateTables to create database tables. - -```Go -err := engine.CreateTables(&User{}) -// or err := engine.Map(&User{}, &Article{}) -// err = engine.CreateAll() -``` - -4.then, insert a struct to table, if success, User.Id will be set to id - -```Go -id, err := engine.Insert(&User{Name:"lunny"}) -``` - -or if you want to update records - -```Go -user := User{Name:"xlw"} -rows, err := engine.Update(&user, &User{Id:1}) -// or rows, err := engine.Where("id = ?", 1).Update(&user) -// or rows, err := engine.Id(1).Update(&user) -``` - -5.Fetch a single object by user - -```Go -var user = User{Id:27} -has, err := engine.Get(&user) -// or has, err := engine.Id(27).Get(&user) - -var user = User{Name:"xlw"} -has, err := engine.Get(&user) -``` - -6.Fetch multipe objects into a slice or a map, use Find: - -```Go -var everyone []Userinfo -err := engine.Find(&everyone) - -users := make(map[int64]Userinfo) -err := engine.Find(&users) -``` - -6.1 also you can use Where, Limit - -```Go -var allusers []Userinfo -err := engine.Where("id > ?", "3").Limit(10,20).Find(&allusers) //Get id>3 limit 10 offset 20 -``` - -6.2 or you can use a struct query - -```Go -var tenusers []Userinfo -err := engine.Limit(10).Find(&tenusers, &Userinfo{Name:"xlw"}) //Get All Name="xlw" limit 10 offset 0 -``` - -6.3 or In function - -```Go -var tenusers []Userinfo -err := engine.In("id", 1, 3, 5).Find(&tenusers) //Get All id in (1, 3, 5) -``` - -6.4 The default will query all columns of a table. Use Cols function if you want to select some columns - -```Go -var tenusers []Userinfo -err := engine.Cols("id", "name").Find(&tenusers) //Find only id and name -``` - -7.Delete - -```Go -err := engine.Delete(&User{Id:1}) -// or err := engine.Id(1).Delete(&User{}) -``` - -8.Count - -```Go -total, err := engine.Count(&User{Name:"xlw"}) -``` +## Documents -9.Cache -```Go -cacher := xorm.NewLRUCacher(xorm.NewMemoryStore(), 1000) -engine.SetDefaultCacher(cacher) -``` - -## Execute SQL - -Of course, SQL execution is also provided. - -1.if select then use Query - -```Go -sql := "select * from userinfo" -results, err := engine.Query(sql) -``` - -2.if insert, update or delete then use Exec - -```Go -sql = "update userinfo set username=? where id=?" -res, err := engine.Exec(sql, "xiaolun", 1) -``` - - -## Advanced Usage - -for deep usage, you should create a session, this func will create a database connection immediatelly.Please notice, MakeSession will be deprecated last, use NewSession instead - -```Go -session := engine.NewSession() -defer session.Close() - -``` - -1.Fetch a single object by where - -```Go -var user Userinfo -session.Where("id=?", 27).Get(&user) - -var userJohn Userinfo -session.Where("name = ?", "john").Get(&userJohn) // more complex query - -var userOldJohn Userinfo -session.Where("name = ? and age > ?", "john", 88).Get(&userOldJohn) // even more complex -``` - -2.Fetch multiple objects - -```Go -var allusers []Userinfo -err := session.Where("id > ?", "3").Limit(10,20).Find(&allusers) //Get id>3 limit 10 offset 20 - -var tenusers []Userinfo -err := session.Limit(10).Find(&tenusers, &Userinfo{Name:"xlw"}) //Get All Name="xlw" limit 10 if omit offset the default is 0 - -var everyone []Userinfo -err := session.Find(&everyone) -``` - -3.Transaction - -```Go -// add Begin() before any action -err := session.Begin() -user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} -_, err = session.Insert(&user1) -if err != nil { - session.Rollback() - return -} -user2 := Userinfo{Username: "yyy"} -_, err = session.Where("id = ?", 2).Update(&user2) -if err != nil { - session.Rollback() - return -} - -_, err = session.Delete(&user2) -if err != nil { - session.Rollback() - return -} - -// add Commit() after all actions -err = session.Commit() -if err != nil { - return -} -``` - -4.Mixed Transaction - -```Go -// add Begin() before any action -err := session.Begin() -user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} -_, err = session.Insert(&user1) -if err != nil { - session.Rollback() - return -} -user2 := Userinfo{Username: "yyy"} -_, err = session.Where("id = ?", 2).Update(&user2) -if err != nil { - session.Rollback() - return -} - -_, err = session.Exec("delete from userinfo where username = ?", user2.Username) -if err != nil { - session.Rollback() - return -} - -// add Commit() after all actions -err = session.Commit() -if err != nil { - return -} -``` -5.Derive mapping -Please see derive.go in examples folder. - -## Mapping Rules - - -1.Struct and struct's fields name should be Pascal style, and the table and column's name default is SQL style. - -For example: - -The struct's Name 'UserInfo' will turn into the table name 'user_info', the same as the keyname. If the keyname is 'UserName' will turn into the select colum 'user_name' - -2.If You want change the mapping rules, you have two methods. One is to implement your own Map struct interface according IMapper, you can find the interface in mapper.go and set it to engine.Mapper - -Another is use field tag, field tag support the below keywords which split with space: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
namecolumn name, if no this name, the name is auto generated according field name and mapper rule.
pkthe field is a primary key
more than 30 column type supported, please see [Column Type](https://github.com/lunny/xorm/blob/master/docs/COLUMNTYPE.md)column type
autoincrauto incrment
[not ]nullif column can be null value
unique or unique(uniquename)unique or union unique as uniquename
index or index(indexname)index or union index as indexname
extendsused in anonymous struct means mapping this struct's fields to table
-this field is not map as a table column
->this field only write to db and not read from db
<-this field only read from db and not write to db
createdthis field will auto fill current time when insert
updatedthis field will auto fill current time when update
default 0 or default 'abc'default value, use single quote for string
- -For Example - -```Go -type Userinfo struct { - Uid int `xorm:"id pk not null autoincr"` - Username string `xorm:"unique"` - Departname string - Alias string `xorm:"-"` - Created time.Time -} -``` -3.For customize table name, use Table() function, for example: - -```Go -// batch create tables -for i := 0; i < 10; i++ { - engine.Table(fmt.Sprintf("user_%v", i)).CreateTable(&Userinfo{}) -} - -// insert into table according id -user := Userinfo{Uid: 25, Username:"sslfs"} -engine.Table(fmt.Sprintf("user_%v", user.Uid % 10)).Insert(&user) -``` - -## Documents - -Please visit [GoWalker](http://gowalker.org/github.com/lunny/xorm) +[Quick Start](https://github.com/lunny/xorm/blob/master/docs/QuickStartEn.md) + +[GoDoc](http://godoc.org/github.com/lunny/xorm) +[GoWalker](http://gowalker.org/github.com/lunny/xorm) + +## Cases + +* [Sudo China](http://sudochina.com) - [github.com/insionng/toropress](http://github.com/insionng/toropress) + +* [Godaily](http://godaily.org) - [github.com/govc/godaily](http://github.com/govc/godaily) + +* [Very Hour](http://veryhour.com/) ## FAQ diff --git a/README_CN.md b/README_CN.md index 12869436..d1c18c19 100644 --- a/README_CN.md +++ b/README_CN.md @@ -24,6 +24,7 @@ xorm是一个简单而强大的Go语言ORM库. 通过它可以使数据库操作 ## 更新日志 +* **v0.2.1** : 新增数据库反转工具,当前支持go和c++代码的生成,详见 [Xorm Tool README](https://github.com/lunny/xorm/blob/master/xorm/README.md); 修复了一些bug. * **v0.2.0** : 新增 [缓存](https://github.com/lunny/xorm/blob/master/docs/QuickStart.md#120)支持,查询速度提升3-5倍; 新增数据库表和Struct同名的映射方式; 新增Sync同步表结构; * **v0.1.9** : 新增 postgres 和 mymysql 驱动支持; 在Postgres中支持原始SQL语句中使用 ` 和 ? 符号; 新增Cols, StoreEngine, Charset 函数;SQL语句打印支持io.Writer接口,默认打印到控制台;新增更多的字段类型支持,详见 [映射规则](https://github.com/lunny/xorm/blob/master/docs/QuickStart.md#21);删除废弃的MakeSession和Create函数。 * **v0.1.8** : 新增联合index,联合unique支持,请查看 [映射规则](https://github.com/lunny/xorm/blob/master/docs/QuickStart.md#21)。 @@ -48,12 +49,13 @@ xorm是一个简单而强大的Go语言ORM库. 通过它可以使数据库操作 * 支持使用Id, In, Where, Limit, Join, Having, Table, Sql, Cols等函数和结构体等方式作为条件 -* 支持数据库连接池 - * 支持级联加载Struct * 支持缓存 +* 支持根据数据库自动生成xorm的结构体 + + ## 安装 @@ -67,6 +69,8 @@ xorm是一个简单而强大的Go语言ORM库. 通过它可以使数据库操作 ## 案例 +* [Sudo China](http://sudochina.com) - [github.com/insionng/toropress](http://github.com/insionng/toropress) + * [Godaily](http://godaily.org) - [github.com/govc/godaily](http://github.com/govc/godaily) * [Very Hour](http://veryhour.com/) diff --git a/docs/QuickStartEn.md b/docs/QuickStartEn.md new file mode 100644 index 00000000..11e546dd --- /dev/null +++ b/docs/QuickStartEn.md @@ -0,0 +1,357 @@ +# Quick Start + +1.Create a database engine just like sql.Open, commonly you just need create once. Please notice, Create function will be deprecated, use NewEngine instead. + +```Go +import ( + _ "github.com/Go-SQL-Driver/MySQL" + "github.com/lunny/xorm" +) +engine, err := xorm.NewEngine("mysql", "root:123@/test?charset=utf8") +defer engine.Close() +``` + +or + +```Go +import ( + _ "github.com/mattn/go-sqlite3" + "github.com/lunny/xorm" +) +engine, err = xorm.NewEngine("sqlite3", "./test.db") +defer engine.Close() +``` + +1.1.If you want to show all generated SQL + +```Go +engine.ShowSQL = true +``` +1.2 If you want to use your own connection pool + +```Go +err = engine.SetPool(NewSimpleConnectPool()) +``` +1.3 If you want to auto sync database schema + +```Go +err = engine.Sync(new(User), new(Category)) +``` + +1.4 If you want to enable cache system + +```Go +cacher := xorm.NewLRUCacher(xorm.NewMemoryStore(), 1000) +Engine.SetDefaultCacher(cacher) +``` + +2.Define a struct + +```Go +type User struct { + Id int + Name string + Age int `xorm:"-"` +} +``` + +2.1.More mapping rules, please see [Mapping Rules](#mapping) + +3.When you set up your program, you can use CreateTables to create database tables. + +```Go +err := engine.CreateTables(&User{}) +// or err := engine.Map(&User{}, &Article{}) +// err = engine.CreateAll() +``` + +4.then, insert a struct to table, if success, User.Id will be set to id + +```Go +id, err := engine.Insert(&User{Name:"lunny"}) +``` + +or if you want to update records + +```Go +user := User{Name:"xlw"} +rows, err := engine.Update(&user, &User{Id:1}) +// or rows, err := engine.Where("id = ?", 1).Update(&user) +// or rows, err := engine.Id(1).Update(&user) +``` + +5.Fetch a single object by user + +```Go +var user = User{Id:27} +has, err := engine.Get(&user) +// or has, err := engine.Id(27).Get(&user) + +var user = User{Name:"xlw"} +has, err := engine.Get(&user) +``` + +6.Fetch multipe objects into a slice or a map, use Find: + +```Go +var everyone []Userinfo +err := engine.Find(&everyone) + +users := make(map[int64]Userinfo) +err := engine.Find(&users) +``` + +6.1 also you can use Where, Limit + +```Go +var allusers []Userinfo +err := engine.Where("id > ?", "3").Limit(10,20).Find(&allusers) //Get id>3 limit 10 offset 20 +``` + +6.2 or you can use a struct query + +```Go +var tenusers []Userinfo +err := engine.Limit(10).Find(&tenusers, &Userinfo{Name:"xlw"}) //Get All Name="xlw" limit 10 offset 0 +``` + +6.3 or In function + +```Go +var tenusers []Userinfo +err := engine.In("id", 1, 3, 5).Find(&tenusers) //Get All id in (1, 3, 5) +``` + +6.4 The default will query all columns of a table. Use Cols function if you want to select some columns + +```Go +var tenusers []Userinfo +err := engine.Cols("id", "name").Find(&tenusers) //Find only id and name +``` + +7.Delete + +7.1 deleted by id + +```Go +err := engine.Id(1).Delete(&User{}) +``` + +7.2 deleted by other conditions + +```Go +err := engine.Delete(&User{Name:"xlw"}) +``` + +8.Count + +```Go +total, err := engine.Where("id > ?", 5).Count(&User{Name:"xlw"}) +``` + +9.Cache +```Go +cacher := xorm.NewLRUCacher(xorm.NewMemoryStore(), 1000) +engine.SetDefaultCacher(cacher) +``` + +## Execute SQL + +Of course, SQL execution is also provided. + +1.if select then use Query + +```Go +sql := "select * from userinfo" +results, err := engine.Query(sql) +``` + +2.if insert, update or delete then use Exec + +```Go +sql = "update userinfo set username=? where id=?" +res, err := engine.Exec(sql, "xiaolun", 1) +``` + + +## Advanced Usage + +For deep usage, you should create a session. + +```Go +session := engine.NewSession() +defer session.Close() +``` + +1.Fetch a single object by where, these methods are same to engine. + +```Go +var user Userinfo +session.Where("id=?", 27).Get(&user) + +var userJohn Userinfo +session.Where("name = ?", "john").Get(&userJohn) // more complex query + +var userOldJohn Userinfo +session.Where("name = ? and age > ?", "john", 88).Get(&userOldJohn) // even more complex +``` + +2.Fetch multiple objects + +```Go +var allusers []Userinfo +err := session.Where("id > ?", "3").Limit(10,20).Find(&allusers) //Get id>3 limit 10 offset 20 + +var tenusers []Userinfo +err := session.Limit(10).Find(&tenusers, &Userinfo{Name:"xlw"}) //Get All Name="xlw" limit 10 if omit offset the default is 0 + +var everyone []Userinfo +err := session.Find(&everyone) +``` + +3.Transaction + +```Go +// add Begin() before any action +err := session.Begin() +user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} +_, err = session.Insert(&user1) +if err != nil { + session.Rollback() + return +} +user2 := Userinfo{Username: "yyy"} +_, err = session.Where("id = ?", 2).Update(&user2) +if err != nil { + session.Rollback() + return +} + +_, err = session.Delete(&user2) +if err != nil { + session.Rollback() + return +} + +// add Commit() after all actions +err = session.Commit() +if err != nil { + return +} +``` + +4.Mixed Transaction + +```Go +// add Begin() before any action +err := session.Begin() +user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} +_, err = session.Insert(&user1) +if err != nil { + session.Rollback() + return +} +user2 := Userinfo{Username: "yyy"} +_, err = session.Where("id = ?", 2).Update(&user2) +if err != nil { + session.Rollback() + return +} + +_, err = session.Exec("delete from userinfo where username = ?", user2.Username) +if err != nil { + session.Rollback() + return +} + +// add Commit() after all actions +err = session.Commit() +if err != nil { + return +} +``` +5.Derive mapping +Please see derive.go in examples folder. + +## Mapping Rules + + +1.Struct and struct's fields name should be Pascal style, and the table and column's name default is SQL style. + +For example: + +The struct's Name 'UserInfo' will turn into the table name 'user_info', the same as the keyname. If the keyname is 'UserName' will turn into the select colum 'user_name' + +2.If You want change the mapping rules, you have two methods. One is to implement your own Map struct interface according IMapper, you can find the interface in mapper.go and set it to engine.Mapper + +Another is use field tag, field tag support the below keywords which split with space: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
namecolumn name, if no this name, the name is auto generated according field name and mapper rule.
pkthe field is a primary key
more than 30 column type supported, please see [Column Type](https://github.com/lunny/xorm/blob/master/docs/COLUMNTYPE.md)column type
autoincrauto incrment
[not ]nullif column can be null value
unique or unique(uniquename)unique or union unique as uniquename
index or index(indexname)index or union index as indexname
extendsused in anonymous struct means mapping this struct's fields to table
-this field is not map as a table column
->this field only write to db and not read from db
<-this field only read from db and not write to db
createdthis field will auto fill current time when insert
updatedthis field will auto fill current time when update
default 0 or default 'abc'default value, use single quote for string
+ +For Example + +```Go +type Userinfo struct { + Uid int `xorm:"id pk not null autoincr"` + Username string `xorm:"unique"` + Departname string + Alias string `xorm:"-"` + Created time.Time +} +``` + +3.For customize table name, use Table() function, for example: + +```Go +// batch create tables +for i := 0; i < 10; i++ { + engine.Table(fmt.Sprintf("user_%v", i)).CreateTable(&Userinfo{}) +} + +// insert into table according id +user := Userinfo{Uid: 25, Username:"sslfs"} +engine.Table(fmt.Sprintf("user_%v", user.Uid % 10)).Insert(&user) +``` \ No newline at end of file diff --git a/session.go b/session.go index 7e2b8ab3..45ea082b 100644 --- a/session.go +++ b/session.go @@ -577,14 +577,12 @@ func (session *Session) cacheFind(t reflect.Type, sql string, rowsSlicePtr inter pkFieldName := session.Statement.RefTable.PKColumn().FieldName ididxes := make(map[int64]int) - var idxes []int = make([]int, 0) var ides []interface{} = make([]interface{}, 0) var temps []interface{} = make([]interface{}, len(ids)) tableName := session.Statement.TableName() for idx, id := range ids { bean := cacher.GetBean(tableName, id) if bean == nil { - idxes = append(idxes, idx) ides = append(ides, id) ididxes[id] = idx } else { @@ -606,8 +604,8 @@ func (session *Session) cacheFind(t reflect.Type, sql string, rowsSlicePtr inter slices := reflect.New(reflect.SliceOf(t)) beans := slices.Interface() //beans := reflect.New(sliceValue.Type()).Interface() - err = newSession.In("(id)", ides...).OrderBy(session.Statement.OrderStr).NoCache().Find(beans) - //err = newSession.In("(id)", ides...).NoCache().Find(beans) + //err = newSession.In("(id)", ides...).OrderBy(session.Statement.OrderStr).NoCache().Find(beans) + err = newSession.In("(id)", ides...).NoCache().Find(beans) if err != nil { return err } diff --git a/sqlite3.go b/sqlite3.go index ee2663ac..b088bfa7 100644 --- a/sqlite3.go +++ b/sqlite3.go @@ -2,7 +2,6 @@ package xorm import ( "database/sql" - "fmt" "strings" ) @@ -75,9 +74,7 @@ func (db *sqlite3) TableCheckSql(tableName string) (string, []interface{}) { func (db *sqlite3) ColumnCheckSql(tableName, colName string) (string, []interface{}) { args := []interface{}{tableName} - fmt.Println(tableName, colName) sql := "SELECT name FROM sqlite_master WHERE type='table' and name = ? and ((sql like '%`" + colName + "`%') or (sql like '%[" + colName + "]%'))" - fmt.Println(sql) return sql, args }