add documents' link for readme

This commit is contained in:
Lunny Xiao 2013-05-11 15:45:24 +08:00
parent 431ac7b5d2
commit eaa2bcaa57
2 changed files with 27 additions and 11 deletions

View File

@ -30,12 +30,16 @@ SQLite: [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
## Quick Start ## Quick Start
1.Create a database engine just like sql.Open (for example: mysql) 1.Create a database engine just like sql.Open (for example: mysql)
import (_ "github.com/Go-SQL-Driver/MySQL"
"github.com/lunny/xorm")
engine := xorm.Create("mysql", "root:123@/test?charset=utf8") engine := xorm.Create("mysql", "root:123@/test?charset=utf8")
or or
import (_ "github.com/mattn/go-sqlite3"
"github.com/lunny/xorm")
engine = xorm.Create("sqlite3", "./test.db") engine = xorm.Create("sqlite3", "./test.db")
@ -68,14 +72,16 @@ or you want to update this struct
user := User{Name:"xlw"} user := User{Name:"xlw"}
rows, err := engine.Update(&user, &User{Id:1}) rows, err := engine.Update(&user, &User{Id:1})
// rows, err := engine.Where("id = ?", 1).Update(&user) // or rows, err := engine.Where("id = ?", 1).Update(&user)
// or rows, err := engine.Id(1).Update(&user)
3.Fetch a single object by user 3.Fetch a single object by user
var user = User{Id:27} var user = User{Id:27}
err := engine.Get(&user) err := engine.Get(&user)
// or err := engine.Id(27).Get(&user)
var user = User{Name:"xlw"} var user = User{Name:"xlw"}
err := engine.Get(&user) err := engine.Get(&user)
@ -94,6 +100,7 @@ or you want to update this struct
5.Delete and Count 5.Delete and Count
err := engine.Delete(&User{Id:1}) err := engine.Delete(&User{Id:1})
// or err := engine.Id(1).Delete(&User{})
total, err := engine.Count(&User{Name:"xlw"}) total, err := engine.Count(&User{Name:"xlw"})
@ -233,14 +240,15 @@ another is use field tag, field tag support the below keywords:
</tr> </tr>
</table> </table>
##Documents
Please visit [GoWalker](http://gowalker.org/github.com/lunny/xorm)
##FAQ ##FAQ
1.How the xorm tag use both with json? 1.How the xorm tag use both with json?
use space use space
type User struct { type User struct {
User string `json:"user" orm:"user_id"` Name string `json:"name" xorm:"name"`
} }
## LICENSE ## LICENSE

View File

@ -31,11 +31,15 @@ SQLite: [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
## 快速开始 ## 快速开始
1.创建数据库引擎这个函数的参数和sql.Open相同但不会立即创建连接 (例如: mysql) 1.创建数据库引擎这个函数的参数和sql.Open相同但不会立即创建连接 (例如: mysql)
import (_ "github.com/Go-SQL-Driver/MySQL"
"github.com/lunny/xorm")
engine := xorm.Create("mysql", "root:123@/test?charset=utf8") engine := xorm.Create("mysql", "root:123@/test?charset=utf8")
or or
import (_ "github.com/mattn/go-sqlite3"
"github.com/lunny/xorm")
engine = xorm.Create("sqlite3", "./test.db") engine = xorm.Create("sqlite3", "./test.db")
@ -67,14 +71,16 @@ or
user := User{Name:"xlw"} user := User{Name:"xlw"}
rows, err := engine.Update(&user, &User{Id:1}) rows, err := engine.Update(&user, &User{Id:1})
// rows, err := engine.Where("id = ?", 1).Update(&user) // rows, err := engine.Where("id = ?", 1).Update(&user)
// or rows, err := engine.Id(1).Update(&user)
3.获取单个对象可以用Get方法 3.获取单个对象可以用Get方法
var user = User{Id:27} var user = User{Id:27}
err := engine.Get(&user) err := engine.Get(&user)
// or err := engine.Id(27).Get(&user)
var user = User{Name:"xlw"} var user = User{Name:"xlw"}
err := engine.Get(&user) err := engine.Get(&user)
@ -93,6 +99,7 @@ or
5.另外还有Delete和Count方法 5.另外还有Delete和Count方法
err := engine.Delete(&User{Id:1}) err := engine.Delete(&User{Id:1})
// or err := engine.Id(1).Delete(&User{})
total, err := engine.Count(&User{Name:"xlw"}) total, err := engine.Count(&User{Name:"xlw"})
@ -232,7 +239,8 @@ UserInfo中的成员UserName将会自动对应名为user_name的字段。
<td>-</td><td>这个Field将不进行字段映射</td> <td>-</td><td>这个Field将不进行字段映射</td>
</tr> </tr>
</table> </table>
##文档
请访问 [GoWalker](http://gowalker.org/github.com/lunny/xorm) 查看详细文档
##FAQ ##FAQ
1.xorm的tag和json的tag如何同时起作用 1.xorm的tag和json的tag如何同时起作用
@ -240,7 +248,7 @@ UserInfo中的成员UserName将会自动对应名为user_name的字段。
使用空格分开 使用空格分开
type User struct { type User struct {
User string `json:"user" orm:"user_id"` Name string `json:"name" xorm:"name"`
} }
## LICENSE ## LICENSE