zh docs update

orm/docs/zh/Orm.md

@@ -1,6 +1,6 @@
 ## Orm
 
-beego/orm 的使用方法
+beego/orm 的使用例子
 ```go
 package main
 
@@ -11,21 +11,12 @@ import (
 )
 
 func init() {
-	// 这个用来设置 driverName 对应的数据库类型
-	// mysql / sqlite3 / postgres 这三种是默认已经注册过的，所以可以无需设置
 	orm.RegisterDriver("mysql", orm.DR_MySQL)
 
-	// 参数1   自定义的数据库名称，用来在orm中切换数据库使用
-	// 参数2   driverName
-	// 参数3   对应的链接字符串
-	// 参数4   设置最大的空闲连接数，使用 golang 自己的连接池
 	orm.RegisterDataBase("default", "mysql", "root:root@/orm_test?charset=utf8", 30)
 }
 
 func main() {
-	// 请确保在所有 RegisterModel 之前执行
-	orm.BootStrap() // 强制在 main 函数里调用，检查 Model 关系，检测数据库参数，调用 orm 提供的 Command
-
 	o := orm.NewOrm()
 	o.Using("default") // 默认使用 default，你可以指定为其他数据库
 
@@ -42,25 +33,134 @@ func main() {
 
 	fmt.Println(o.Insert(profile))
 	fmt.Println(o.Insert(user))
-
-	var params []orm.Params
-	if cnt, err := o.QueryTable("user").RelatedSel().Limit(3).OrderBy("-id").Values(&params); err != nil {
-		fmt.Println(err)
-	} else {
-		fmt.Println(cnt)
-		for _, p := range params {
-			fmt.Println(p)
-		}
-	}
-
-	var users []*User
-	if cnt, err := o.QueryTable("user").RelatedSel().Limit(3).OrderBy("-id").All(&users); err != nil {
-		fmt.Println(err)
-	} else {
-		fmt.Println(cnt)
-		for _, u := range users {
-			fmt.Println(u.Id, u.Profile)
-		}
-	}
 }
-```
+```
+
+#### RegisterDriver
+
+三种数据库类型
+
+```go
+orm.DR_MySQL
+orm.DR_Sqlite
+orm.DR_Postgres
+```
+
+```go
+// 参数1   driverName
+// 参数2   数据库类型
+// 这个用来设置 driverName 对应的数据库类型
+// mysql / sqlite3 / postgres 这三种是默认已经注册过的，所以可以无需设置
+orm.RegisterDriver("mysql", orm.DR_MySQL)
+```
+
+#### RegisterDataBase
+
+orm 必须注册一个名称为 `default` 的数据库，用以作为默认使用。
+
+```go
+// 参数1   自定义数据库名称，用来在orm中切换数据库使用
+// 参数2   driverName
+// 参数3   对应的链接字符串
+// 参数4   设置最大的空闲连接数，使用 golang 自己的连接池
+orm.RegisterDataBase("default", "mysql", "root:root@/orm_test?charset=utf8", 30)
+```
+
+## Ormer
+
+```go
+var o Ormer
+o = orm.NewOrm() // 创建一个 Ormer
+// NewOrm 的同时会执行一次 orm.BootStrap，用以验证模型之间的定义并缓存。
+```
+
+* type Ormer interface {
+	* [Read(Modeler) error](Object.md#Read)
+	* [Insert(Modeler) (int64, error)](Object.md#Insert)
+	* [Update(Modeler) (int64, error)](Object.md#Update)
+	* [Delete(Modeler) (int64, error)](Object.md#Delete)
+	* [M2mAdd(Modeler, string, ...interface{}) (int64, error)](Object.md#M2mAdd)
+	* [M2mDel(Modeler, string, ...interface{}) (int64, error)](Object.md#M2mDel)
+	* [LoadRel(Modeler, string) (int64, error)](Object.md#LoadRel)
+	* [QueryTable(interface{}) QuerySeter](#QueryTable)
+	* [Using(string) error](#Using)
+	* [Begin() error](Transaction.md#Begin)
+	* [Commit() error](Transaction.md#Commit)
+	* [Rollback() error](Transaction.md#Rollback)
+	* [Raw(string, ...interface{}) RawSeter](#Raw)
+	* [Driver() Driver](#Driver)
+* }
+
+
+#### QueryTable
+
+传入表名，或者 Modeler 对象，返回一个 [QuerySeter](Query.md#QuerySeter)
+
+```go
+o := orm.NewOrm()
+var qs QuerySeter
+qs = o.QueryTable("user")
+// 如果表没有定义过，会立刻 panic
+```
+
+#### Using
+
+切换为其他数据库
+
+```go
+orm.RegisterDataBase("db1", "mysql", "root:root@/orm_db2?charset=utf8", 30)
+orm.RegisterDataBase("db2", "sqlite3", "data.db", 30)
+
+o1 := orm.NewOrm()
+o1.Using("db1")
+
+o2 := orm.NewOrm()
+o2.Using("db2")
+
+// 切换为其他数据库以后
+// 这个 Ormer 对象的其下的 api 调用都将使用这个数据库
+
+```
+
+默认使用 `default` 数据库，无需调用 Using
+
+#### Raw
+
+使用 sql 语句直接进行操作
+
+Raw 函数，返回一个 [RawSeter](Raw.md) 用以对设置的 sql 语句和参数进行操作
+
+```go
+o := NewOrm()
+var r RawSeter
+r = o.Raw("UPDATE user SET user_name = ? WHERE user_name = ?", "testing", "slene")
+```
+
+#### Driver
+
+返回当前 orm 使用的 db 信息
+
+```go
+type Driver interface {
+	Name() string
+	Type() DriverType
+}
+```
+
+```go
+orm.RegisterDataBase("db1", "mysql", "root:root@/orm_db2?charset=utf8", 30)
+orm.RegisterDataBase("db2", "sqlite3", "data.db", 30)
+
+o1 := orm.NewOrm()
+o1.Using("db1")
+dr := o1.Driver()
+fmt.Println(dr.Name() == "db1") // true
+fmt.Println(dr.Type() == orm.DR_MySQL) // true
+
+o2 := orm.NewOrm()
+o2.Using("db2")
+dr = o2.Driver()
+fmt.Println(dr.Name() == "db2") // true
+fmt.Println(dr.Type() == orm.DR_Sqlite) // true
+
+```