1# xorm 2 3[English](https://gitea.com/xorm/xorm/src/branch/master/README.md) 4 5xorm 是一个简单而强大的Go语言ORM库. 通过它可以使数据库操作非常简便。 6 7[](https://drone.gitea.com/xorm/xorm) [](https://gocover.io/xorm.io/xorm) [](https://goreportcard.com/report/xorm.io/xorm) [](https://discord.gg/HuR2CF3) 8 9## Notice 10 11v1.0.0 相对于 v0.8.2 有以下不兼容的变更： 12 13- 移除了部分不符合Go语言命名的函数，如 `Id`, `Sql`，请使用 `ID`, `SQL` 替代。 14- 删除了对 `xorm.io/core` 的依赖。大部分代码迁移到了 `xorm.io/xorm/core`, `xorm.io/xorm/names`, `xorm.io/xorm/schemas` 等等几个包中. 15- 重命名了几个结构体，如： `core.IMapper` -> `names.Mapper`, `core.ILogger` -> `log.Logger`. 16 17## 特性 18 19* 支持 Struct 和数据库表之间的灵活映射，并支持自动同步 20* 事务支持 21* 同时支持原始SQL语句和ORM操作的混合执行 22* 使用连写来简化调用 23* 支持使用ID, In, Where, Limit, Join, Having, Table, SQL, Cols等函数和结构体等方式作为条件 24* 支持级联加载Struct 25* Schema支持（仅Postgres） 26* 支持缓存 27* 通过 [xorm.io/reverse](https://xorm.io/reverse) 支持根据数据库自动生成 xorm 结构体 28* 支持记录版本（即乐观锁） 29* 通过 [xorm.io/builder](https://xorm.io/builder) 内置 SQL Builder 支持 30* 上下文缓存支持 31* 支持日志上下文 32 33## 驱动支持 34 35目前支持的Go数据库驱动和对应的数据库如下： 36 37* [Mysql5.*](https://github.com/mysql/mysql-server/tree/5.7) / [Mysql8.*](https://github.com/mysql/mysql-server) / [Mariadb](https://github.com/MariaDB/server) / [Tidb](https://github.com/pingcap/tidb) 38 - [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) 39 - [github.com/ziutek/mymysql/godrv](https://github.com/ziutek/mymysql/godrv) 40 41* [Postgres](https://github.com/postgres/postgres) / [Cockroach](https://github.com/cockroachdb/cockroach) 42 - [github.com/lib/pq](https://github.com/lib/pq) 43 - [github.com/jackc/pgx](https://github.com/jackc/pgx) 44 45* [SQLite](https://sqlite.org) 46 - [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) 47 - [modernc.org/sqlite](https://gitlab.com/cznic/sqlite) (Windows试验性支持) 48 49* MsSql 50 - [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb) 51 52* Oracle 53 - [github.com/godror/godror](https://github.com/godror/godror) (试验性支持) 54 - [github.com/mattn/go-oci8](https://github.com/mattn/go-oci8) (试验性支持) 55 56## 安装 57 58 go get xorm.io/xorm 59 60## 文档 61 62* [操作指南](http://xorm.io/docs) 63 64* [Godoc代码文档](http://pkg.go.dev/xorm.io/xorm) 65 66# 快速开始 67 68* 第一步创建引擎，`driverName`, `dataSourceName` 和 `database/sql` 接口相同 69 70```Go 71engine, err := xorm.NewEngine(driverName, dataSourceName) 72``` 73 74* 定义一个和表同步的结构体，并且自动同步结构体到数据库 75 76```Go 77type User struct { 78 Id int64 79 Name string 80 Salt string 81 Age int 82 Passwd string `xorm:"varchar(200)"` 83 Created time.Time `xorm:"created"` 84 Updated time.Time `xorm:"updated"` 85} 86 87err := engine.Sync2(new(User)) 88``` 89 90* 创建Engine组 91 92```Go 93dataSourceNameSlice := []string{masterDataSourceName, slave1DataSourceName, slave2DataSourceName} 94engineGroup, err := xorm.NewEngineGroup(driverName, dataSourceNameSlice) 95``` 96 97```Go 98masterEngine, err := xorm.NewEngine(driverName, masterDataSourceName) 99slave1Engine, err := xorm.NewEngine(driverName, slave1DataSourceName) 100slave2Engine, err := xorm.NewEngine(driverName, slave2DataSourceName) 101engineGroup, err := xorm.NewEngineGroup(masterEngine, []*Engine{slave1Engine, slave2Engine}) 102``` 103 104所有使用 `engine` 都可以简单的用 `engineGroup` 来替换。 105 106* `Query` 最原始的也支持SQL语句查询，返回的结果类型为 `[]map[string][]byte`。`QueryString` 返回 `[]map[string]string`, `QueryInterface` 返回 `[]map[string]interface{}`. 107 108```Go 109results, err := engine.Query("select * from user") 110results, err := engine.Where("a = 1").Query() 111 112results, err := engine.QueryString("select * from user") 113results, err := engine.Where("a = 1").QueryString() 114 115results, err := engine.QueryInterface("select * from user") 116results, err := engine.Where("a = 1").QueryInterface() 117``` 118 119* `Exec` 执行一个SQL语句 120 121```Go 122affected, err := engine.Exec("update user set age = ? where name = ?", age, name) 123``` 124 125* `Insert` 插入一条或者多条记录 126 127```Go 128affected, err := engine.Insert(&user) 129// INSERT INTO struct () values () 130 131affected, err := engine.Insert(&user1, &user2) 132// INSERT INTO struct1 () values () 133// INSERT INTO struct2 () values () 134 135affected, err := engine.Insert(&users) 136// INSERT INTO struct () values (),(),() 137 138affected, err := engine.Insert(&user1, &users) 139// INSERT INTO struct1 () values () 140// INSERT INTO struct2 () values (),(),() 141``` 142 143* `Get` 查询单条记录 144 145```Go 146has, err := engine.Get(&user) 147// SELECT * FROM user LIMIT 1 148 149has, err := engine.Where("name = ?", name).Desc("id").Get(&user) 150// SELECT * FROM user WHERE name = ? ORDER BY id DESC LIMIT 1 151 152var name string 153has, err := engine.Table(&user).Where("id = ?", id).Cols("name").Get(&name) 154// SELECT name FROM user WHERE id = ? 155 156var id int64 157has, err := engine.Table(&user).Where("name = ?", name).Cols("id").Get(&id) 158has, err := engine.SQL("select id from user").Get(&id) 159// SELECT id FROM user WHERE name = ? 160 161var valuesMap = make(map[string]string) 162has, err := engine.Table(&user).Where("id = ?", id).Get(&valuesMap) 163// SELECT * FROM user WHERE id = ? 164 165var valuesSlice = make([]interface{}, len(cols)) 166has, err := engine.Table(&user).Where("id = ?", id).Cols(cols...).Get(&valuesSlice) 167// SELECT col1, col2, col3 FROM user WHERE id = ? 168``` 169 170* `Exist` 检测记录是否存在 171 172```Go 173has, err := testEngine.Exist(new(RecordExist)) 174// SELECT * FROM record_exist LIMIT 1 175 176has, err = testEngine.Exist(&RecordExist{ 177 Name: "test1", 178 }) 179// SELECT * FROM record_exist WHERE name = ? LIMIT 1 180 181has, err = testEngine.Where("name = ?", "test1").Exist(&RecordExist{}) 182// SELECT * FROM record_exist WHERE name = ? LIMIT 1 183 184has, err = testEngine.SQL("select * from record_exist where name = ?", "test1").Exist() 185// select * from record_exist where name = ? 186 187has, err = testEngine.Table("record_exist").Exist() 188// SELECT * FROM record_exist LIMIT 1 189 190has, err = testEngine.Table("record_exist").Where("name = ?", "test1").Exist() 191// SELECT * FROM record_exist WHERE name = ? LIMIT 1 192``` 193 194* `Find` 查询多条记录，当然可以使用Join和extends来组合使用 195 196```Go 197var users []User 198err := engine.Where("name = ?", name).And("age > 10").Limit(10, 0).Find(&users) 199// SELECT * FROM user WHERE name = ? AND age > 10 limit 10 offset 0 200 201type Detail struct { 202 Id int64 203 UserId int64 `xorm:"index"` 204} 205 206type UserDetail struct { 207 User `xorm:"extends"` 208 Detail `xorm:"extends"` 209} 210 211var users []UserDetail 212err := engine.Table("user").Select("user.*, detail.*") 213 Join("INNER", "detail", "detail.user_id = user.id"). 214 Where("user.name = ?", name).Limit(10, 0). 215 Find(&users) 216// SELECT user.*, detail.* FROM user INNER JOIN detail WHERE user.name = ? limit 10 offset 0 217``` 218 219* `Iterate` 和 `Rows` 根据条件遍历数据库，可以有两种方式: Iterate and Rows 220 221```Go 222err := engine.Iterate(&User{Name:name}, func(idx int, bean interface{}) error { 223 user := bean.(*User) 224 return nil 225}) 226// SELECT * FROM user 227 228err := engine.BufferSize(100).Iterate(&User{Name:name}, func(idx int, bean interface{}) error { 229 user := bean.(*User) 230 return nil 231}) 232// SELECT * FROM user Limit 0, 100 233// SELECT * FROM user Limit 101, 100 234 235rows, err := engine.Rows(&User{Name:name}) 236// SELECT * FROM user 237defer rows.Close() 238bean := new(Struct) 239for rows.Next() { 240 err = rows.Scan(bean) 241} 242``` 243 244* `Update` 更新数据，除非使用Cols,AllCols函数指明，默认只更新非空和非0的字段 245 246```Go 247affected, err := engine.ID(1).Update(&user) 248// UPDATE user SET ... Where id = ? 249 250affected, err := engine.Update(&user, &User{Name:name}) 251// UPDATE user SET ... Where name = ? 252 253var ids = []int64{1, 2, 3} 254affected, err := engine.In(ids).Update(&user) 255// UPDATE user SET ... Where id IN (?, ?, ?) 256 257// force update indicated columns by Cols 258affected, err := engine.ID(1).Cols("age").Update(&User{Name:name, Age: 12}) 259// UPDATE user SET age = ?, updated=? Where id = ? 260 261// force NOT update indicated columns by Omit 262affected, err := engine.ID(1).Omit("name").Update(&User{Name:name, Age: 12}) 263// UPDATE user SET age = ?, updated=? Where id = ? 264 265affected, err := engine.ID(1).AllCols().Update(&user) 266// UPDATE user SET name=?,age=?,salt=?,passwd=?,updated=? Where id = ? 267``` 268 269* `Delete` 删除记录，需要注意，删除必须至少有一个条件，否则会报错。要清空数据库可以用EmptyTable 270 271```Go 272affected, err := engine.Where(...).Delete(&user) 273// DELETE FROM user Where ... 274 275affected, err := engine.ID(2).Delete(&user) 276// DELETE FROM user Where id = ? 277 278affected, err := engine.Table("user").Where(...).Delete() 279// DELETE FROM user WHERE ... 280``` 281 282* `Count` 获取记录条数 283 284```Go 285counts, err := engine.Count(&user) 286// SELECT count(*) AS total FROM user 287``` 288 289* `Sum` 求和函数 290 291```Go 292agesFloat64, err := engine.Sum(&user, "age") 293// SELECT sum(age) AS total FROM user 294 295agesInt64, err := engine.SumInt(&user, "age") 296// SELECT sum(age) AS total FROM user 297 298sumFloat64Slice, err := engine.Sums(&user, "age", "score") 299// SELECT sum(age), sum(score) FROM user 300 301sumInt64Slice, err := engine.SumsInt(&user, "age", "score") 302// SELECT sum(age), sum(score) FROM user 303``` 304 305* 条件编辑器 306 307```Go 308err := engine.Where(builder.NotIn("a", 1, 2).And(builder.In("b", "c", "d", "e"))).Find(&users) 309// SELECT id, name ... FROM user WHERE a NOT IN (?, ?) AND b IN (?, ?, ?) 310``` 311 312* 在一个Go程中多次操作数据库，但没有事务 313 314```Go 315session := engine.NewSession() 316defer session.Close() 317 318user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} 319if _, err := session.Insert(&user1); err != nil { 320 return err 321} 322 323user2 := Userinfo{Username: "yyy"} 324if _, err := session.Where("id = ?", 2).Update(&user2); err != nil { 325 return err 326} 327 328if _, err := session.Exec("delete from userinfo where username = ?", user2.Username); err != nil { 329 return err 330} 331 332return nil 333``` 334 335* 在一个Go程中有事务 336 337```Go 338session := engine.NewSession() 339defer session.Close() 340 341// add Begin() before any action 342if err := session.Begin(); err != nil { 343 // if returned then will rollback automatically 344 return err 345} 346 347user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} 348if _, err := session.Insert(&user1); err != nil { 349 return err 350} 351 352user2 := Userinfo{Username: "yyy"} 353if _, err := session.Where("id = ?", 2).Update(&user2); err != nil { 354 return err 355} 356 357if _, err := session.Exec("delete from userinfo where username = ?", user2.Username); err != nil { 358 return err 359} 360 361// add Commit() after all actions 362return session.Commit() 363``` 364 365* 事务的简写方法 366 367```Go 368res, err := engine.Transaction(func(session *xorm.Session) (interface{}, error) { 369 user1 := Userinfo{Username: "xiaoxiao", Departname: "dev", Alias: "lunny", Created: time.Now()} 370 if _, err := session.Insert(&user1); err != nil { 371 return nil, err 372 } 373 374 user2 := Userinfo{Username: "yyy"} 375 if _, err := session.Where("id = ?", 2).Update(&user2); err != nil { 376 return nil, err 377 } 378 379 if _, err := session.Exec("delete from userinfo where username = ?", user2.Username); err != nil { 380 return nil, err 381 } 382 return nil, nil 383}) 384``` 385 386* 上下文缓存，如果启用，那么针对单个对象的查询将会被缓存到系统中，可以被下一个查询使用。 387 388```Go 389 sess := engine.NewSession() 390 defer sess.Close() 391 392 var context = xorm.NewMemoryContextCache() 393 394 var c2 ContextGetStruct 395 has, err := sess.ID(1).ContextCache(context).Get(&c2) 396 assert.NoError(t, err) 397 assert.True(t, has) 398 assert.EqualValues(t, 1, c2.Id) 399 assert.EqualValues(t, "1", c2.Name) 400 sql, args := sess.LastSQL() 401 assert.True(t, len(sql) > 0) 402 assert.True(t, len(args) > 0) 403 404 var c3 ContextGetStruct 405 has, err = sess.ID(1).ContextCache(context).Get(&c3) 406 assert.NoError(t, err) 407 assert.True(t, has) 408 assert.EqualValues(t, 1, c3.Id) 409 assert.EqualValues(t, "1", c3.Name) 410 sql, args = sess.LastSQL() 411 assert.True(t, len(sql) == 0) 412 assert.True(t, len(args) == 0) 413``` 414 415## 贡献 416 417如果您也想为Xorm贡献您的力量，请查看 [CONTRIBUTING](https://gitea.com/xorm/xorm/src/branch/master/CONTRIBUTING.md)。您也可以加入QQ群 技术帮助和讨论。 418群一：280360085 （已满） 419群二：795010183 420 421## Credits 422 423### Contributors 424 425感谢所有的贡献者. [[Contribute](CONTRIBUTING.md)]. 426<a href="graphs/contributors"><img src="https://opencollective.com/xorm/contributors.svg?width=890&button=false" /></a> 427 428### Backers 429 430感谢我们所有的 backers! �� [[成为 backer](https://opencollective.com/xorm#backer)] 431 432<a href="https://opencollective.com/xorm#backers" target="_blank"><img src="https://opencollective.com/xorm/backers.svg?width=890"></a> 433 434### Sponsors 435 436成为 sponsor 来支持 xorm。您的 logo 将会被显示并被链接到您的网站。 [[成为 sponsor](https://opencollective.com/xorm#sponsor)] 437 438# 案例 439 440* [Gitea](http://gitea.io) - [github.com/go-gitea/gitea](http://github.com/go-gitea/gitea) 441 442* [Gogs](http://try.gogits.org) - [github.com/gogits/gogs](http://github.com/gogits/gogs) 443 444* [grafana](https://grafana.com/) - [github.com/grafana/grafana](http://github.com/grafana/grafana) 445 446* [Go语言中文网](http://studygolang.com/) - [github.com/studygolang/studygolang](https://github.com/studygolang/studygolang) 447 448* [github.com/m3ng9i/qreader](https://github.com/m3ng9i/qreader) 449 450* [Wego](http://github.com/go-tango/wego) 451 452* [Docker.cn](https://docker.cn/) 453 454* [Xorm Adapter](https://github.com/casbin/xorm-adapter) for [Casbin](https://github.com/casbin/casbin) - [github.com/casbin/xorm-adapter](https://github.com/casbin/xorm-adapter) 455 456* [Gowalker](http://gowalker.org) - [github.com/Unknwon/gowalker](http://github.com/Unknwon/gowalker) 457 458* [Gobuild.io](http://gobuild.io) - [github.com/shxsun/gobuild](http://github.com/shxsun/gobuild) 459 460* [Sudo China](http://sudochina.com) - [github.com/insionng/toropress](http://github.com/insionng/toropress) 461 462* [Godaily](http://godaily.org) - [github.com/govc/godaily](http://github.com/govc/godaily) 463 464* [YouGam](http://www.yougam.com/) 465 466* [GoCMS - github.com/zzboy/GoCMS](https://github.com/zzdboy/GoCMS) 467 468* [GoBBS - gobbs.domolo.com](http://gobbs.domolo.com/) 469 470* [go-blog](http://wangcheng.me) - [github.com/easykoo/go-blog](https://github.com/easykoo/go-blog) 471 472 473## 更新日志 474 475请访问 [CHANGELOG.md](CHANGELOG.md) 获得更新日志。 476 477## LICENSE 478 479BSD License 480[http://creativecommons.org/licenses/BSD/](http://creativecommons.org/licenses/BSD/) 481
){kind=link}
){kind=link}
