From 3d65e0edb7b9f2e4f0b2fe70af6d0ef2c1a31b13 Mon Sep 17 00:00:00 2001 From: Lunny Xiao Date: Sun, 12 May 2013 13:43:09 +0800 Subject: [PATCH] imporved readme --- README.md | 3 ++- README_CN.md | 14 +++++++++++--- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fb88eb75..2499ddc0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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. @@ -38,6 +38,7 @@ Drivers for Go's sql package which currently support database/sql includes: ## Quick Start 1.Create a database engine just like sql.Open, commonly you just need create once. + ```Go import ( _ "github.com/Go-SQL-Driver/MySQL" diff --git a/README_CN.md b/README_CN.md index a0b8ea00..f98d63e1 100644 --- a/README_CN.md +++ b/README_CN.md @@ -1,6 +1,6 @@ # xorm ---------- -[English](README.md) +[English](https://github.com/lunny/xorm/blob/master/README.md) xorm是一个Go语言的ORM库. 通过它可以使数据库操作非常简便。 @@ -54,8 +54,14 @@ import ( ) engine = xorm.Create("sqlite3", "./test.db") ``` + +1.1.默认将不会显示自动生成的SQL语句,如果要显示,则需要设置 + +```Go +engine.ShowSQL = true +``` -2.定义一个结构体 +2.所有的ORM操作都针对一个或多个结构体,一个结构体对应一张表,定义一个结构体如下: ```Go type User struct { @@ -64,6 +70,8 @@ type User struct { Age int `xorm:"-"` } ``` + +2.1 详细映射规则,请查看[mapping][mapping] 3.在程序初始化时,可能会需要创建表 @@ -254,7 +262,7 @@ if err != nil { } ``` -##映射规则 +##[mapping]映射规则 1.Struct 和 Struct 的field名字应该为Pascal式命名,默认的映射规则将转换成用下划线连接的命名规则,这个映射是自动进行的,当然,你可以通过修改Engine的成员Mapper来改变它。 例如: