HiPoweredDev
/
xorm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

imporved readme

This commit is contained in:
Lunny Xiao 2013-05-12 13:43:09 +08:00
parent 08f3a5f69b
commit 3d65e0edb7
2 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -1,6 +1,6 @@
# xorm # xorm
[中文](./README_CN.md) [中文](https://github.com/lunny/xorm/blob/master/README_CN.md)
xorm is an ORM for Go. It makes dabatabse operating simple. xorm is an ORM for Go. It makes dabatabse operating simple.
@ -38,6 +38,7 @@ Drivers for Go's sql package which currently support database/sql includes:
## Quick Start ## Quick Start
1.Create a database engine just like sql.Open, commonly you just need create once. 1.Create a database engine just like sql.Open, commonly you just need create once.
```Go ```Go
import ( import (
_ "github.com/Go-SQL-Driver/MySQL" _ "github.com/Go-SQL-Driver/MySQL"

14
README_CN.md
View File

@ -1,6 +1,6 @@
# xorm # xorm
---------- ----------
[English](README.md) [English](https://github.com/lunny/xorm/blob/master/README.md)
xorm是一个Go语言的ORM库. 通过它可以使数据库操作非常简便。 xorm是一个Go语言的ORM库. 通过它可以使数据库操作非常简便。
@ -55,7 +55,13 @@ import (
engine = xorm.Create("sqlite3", "./test.db") engine = xorm.Create("sqlite3", "./test.db")
``` ```
2.定义一个结构体 1.1.默认将不会显示自动生成的SQL语句，如果要显示，则需要设置
```Go
engine.ShowSQL = true
```
2.所有的ORM操作都针对一个或多个结构体，一个结构体对应一张表，定义一个结构体如下：
```Go ```Go
type User struct { type User struct {
@ -65,6 +71,8 @@ type User struct {
} }
``` ```
2.1 详细映射规则，请查看[mapping][mapping]
3.在程序初始化时，可能会需要创建表 3.在程序初始化时，可能会需要创建表
```Go ```Go
@ -254,7 +262,7 @@ if err != nil {
} }
``` ```
##映射规则 ##[mapping]映射规则
1.Struct 和 Struct 的field名字应该为Pascal式命名，默认的映射规则将转换成用下划线连接的命名规则，这个映射是自动进行的，当然，你可以通过修改Engine的成员Mapper来改变它。 1.Struct 和 Struct 的field名字应该为Pascal式命名，默认的映射规则将转换成用下划线连接的命名规则，这个映射是自动进行的，当然，你可以通过修改Engine的成员Mapper来改变它。
例如： 例如：