[TOC]
# 模型(Models)- beego ORM
[![Build Status](https://drone.io/github.com/astaxie/beego/status.png)](https://drone.io/github.com/astaxie/beego/latest) [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/astaxie/beego/orm)
beego ORM 是一个强大的 Go 语言 ORM 框架。她的灵感主要来自 Django ORM 和 SQLAlchemy。
目前该框架仍处于开发阶段,可能发生任何导致不兼容的改动。
**已支持数据库:**
* MySQL:[github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
* PostgreSQL:[github.com/lib/pq](https://github.com/lib/pq)
* Sqlite3:[github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
以上数据库驱动均通过基本测试,但我们仍需要您的反馈。
**ORM 特性:**
* 支持 Go 的所有类型存储
* 轻松上手,采用简单的 CRUD 风格
* 自动 Join 关联表
* 跨数据库兼容查询
* 允许直接使用 SQL 查询/映射
* 严格完整的测试保证 ORM 的稳定与健壮
更多特性请在文档中自行品读。
**安装 ORM:**
go get github.com/astaxie/beego/orm
## 修改日志
* 2016-01-18: [规范了数据库驱动的命名](orm.md#registerdriver)
* 2014-03-10: [GetDB](orm.md#getdb) 从注册的数据库中返回 *sql.DB. [ResetModelCache](orm.md#resetmodelcache) 重置已注册的模型struct
* 2014-02-10: 随着beego1.1.0的发布提交的改进
- 关于 [时区设置](orm.md#时区设置)
- 新增的 api:
Ormer.[InsertMulti](object.md#insertmulti)
Ormer.[ReadOrCreate](object.md#readorcreate)
RawSeter.[RowsToMap](rawsql.md#rowstomap)
RawSeter.[RowsToStruct](rawsql.md#rowstostruct)
orm.[NewOrmWithDB](orm.md#newormwithdb)
- 改进的 api:
RawSeter.[Values](rawsql.md#values) 支持设置 columns
RawSeter.[ValuesList](rawsql.md#valueslist) 支持设置 columns
RawSeter.[ValuesFlat](rawsql.md#valuesflat) 支持设置 column
RawSeter.[QueryRow/QueryRows](rawsql.md#queryrow) 从对应每个strcut field位置的赋值,改为对应名称取值(不需要对应好字段数量与位置)
* 2013-10-14: [自动载入关系字段](query.md#载入关系字段),[多对多关系操作](query.md#多对多关系操作),完善[关系查询](query.md#关系查询)
* 2013-10-09: [原子操作更新值](query.md#update)
* 2013-09-22: [RegisterDataBase](orm.md#registerdatabase) maxIdle / maxConn 设置为可选参数, MySQL [自定义引擎](models.md#自定义引擎)
* 2013-09-16: 支持设置 空闲链接数 和 最大链接数 [SetMaxIdleConns](orm.md#setmaxidleconns) / [SetMaxOpenConns](orm.md#SetMaxOpenConns)
* 2013-09-12: [Read](object.md#read) 支持设定条件字段 [Update](object.md#update) / [All](query.md#all) / [One](query.md#one) 支持设定返回字段
* 2013-09-09: Raw SQL [QueryRow/QueryRows](rawsql.md#queryrow) 功能完成
* 2013-08-27: [自动建表](cmd.md#自动建表)继续改进
* 2013-08-19: [自动建表](cmd.md#自动建表)功能完成
* 2013-08-13: 更新数据库类型测试
* 2013-08-13: 增加 Go 类型支持,包括 int8、uint8、byte、rune 等
* 2013-08-13: 增强 date/datetime 的时区支持
## 快速入门
### 简单示例
```go
package main
import (
"fmt"
"github.com/astaxie/beego/orm"
_ "github.com/go-sql-driver/mysql" // import your used driver
)
// Model Struct
type User struct {
Id int
Name string `orm:"size(100)"`
}
func init() {
// set default database
orm.RegisterDataBase("default", "mysql", "root:root@/my_db?charset=utf8", 30)
// register model
orm.RegisterModel(new(User))
// create table
orm.RunSyncdb("default", false, true)
}
func main() {
o := orm.NewOrm()
user := User{Name: "slene"}
// insert
id, err := o.Insert(&user)
fmt.Printf("ID: %d, ERR: %v\n", id, err)
// update
user.Name = "astaxie"
num, err := o.Update(&user)
fmt.Printf("NUM: %d, ERR: %v\n", num, err)
// read one
u := User{Id: user.Id}
err = o.Read(&u)
fmt.Printf("ERR: %v\n", err)
// delete
num, err = o.Delete(&u)
fmt.Printf("NUM: %d, ERR: %v\n", num, err)
}
```
### 关联查询
```go
type Post struct {
Id int `orm:"auto"`
Title string `orm:"size(100)"`
User *User `orm:"rel(fk)"`
}
var posts []*Post
qs := o.QueryTable("post")
num, err := qs.Filter("User__Name", "slene").All(&posts)
```
### SQL 查询
当您无法使用 ORM 来达到您的需求时,也可以直接使用 SQL 来完成查询/映射操作。
```go
var maps []orm.Params
num, err := o.Raw("SELECT id FROM user WHERE name = ?", "slene").Values(&maps)
if num > 0 {
fmt.Println(maps[0]["id"])
}
```
### 事务处理
```go
o.Begin()
...
user := User{Name: "slene"}
id, err := o.Insert(&user)
if err == nil {
o.Commit()
} else {
o.Rollback()
}
```
### 调试查询日志
在开发环境下,您可以使用以下指令来开启查询调试模式:
```go
func main() {
orm.Debug = true
...
```
开启后将会输出所有查询语句,包括执行、准备、事务等。
例如:
```go
[ORM] - 2013-08-09 13:18:16 - [Queries/default] - [ db.Exec / 0.4ms] - [INSERT INTO `user` (`name`) VALUES (?)] - `slene`
...
```
注意:我们不建议您在部署产品后这样做。
- 写在前面的话
- 第0章 beego 简介
- 0.1 为beego贡献
- 0.2 发布版本
- 0.3 升级指南
- 第1章 安装升级
- 1.1 bee工具的使用
- 第2章 快速入门
- 2.1 新建项目
- 2.2 路由设置
- 2.3 Controller运行机制
- 2.4 Model逻辑
- 2.5 View编写
- 2.6 静态文件处理
- 第3章 beego的MVC架构
- 3.1 Model设计
- 3.1.1 概述
- 3.1.2 ORM使用
- 3.1.3 CRUD操作
- 3.1.4 高级查询
- 3.1.5 原生SQL查询
- 3.1.6 构造查询
- 3.1.7 事物处理
- 3.1.8 模型定义
- 3.1.9 命令模式
- 3.1.10 测试用例
- 3.1.11 自定义字段
- 3.1.12 FAQ
- 3.2 View设计
- 3.2.1 模板语法指南
- 3.2.2 模板处理
- 3.2.3 模板函数
- 3.2.4 静态文件处理
- 3.2.5 模板分页处理
- 3.3 Controller设计
- 3.3.1 参数配置
- 3.3.2 路由设置
- 3.3.3 控制器函数
- 3.3.4 XSRF过滤
- 3.3.5 请求数据处理
- 3.3.6 session 控制
- 3.3.7 过滤器
- 3.3.8 flash 数据
- 3.3.9 URL构建
- 3.3.10 多种格式数据输出
- 3.3.11 表单数据验证
- 3.3.12 错误处理
- 3.3.13 日志处理
- 第4章 beego的模块设计
- 4.1 session 模块
- 4.2 grace 模块
- 4.3 cache 模块
- 4.4 logs 模块
- 4.5 httplib 模块
- 4.6 context 模块
- 4.7 toolbox 模块
- 4.8 config 模块
- 4.9 i18n 模块
- 第5章 beego高级编程
- 5.1 进程内监控
- 5.2 API自动化文档
- 第6章 应用部署
- 6.1 独立部署
- 6.2 Supervisor部署
- 6.3 Nginx 部署
- 6.4 Apache 部署
- 第7章 第三方库
- 第8章 应用例子
- 8.1 在线聊天室
- 8.2 短域名服务
- 8.3 Todo列表
- 第9章 FAQ