144 lines
4.0 KiB
Markdown
144 lines
4.0 KiB
Markdown
---
|
|
root: true
|
|
name: Introduction
|
|
sort: 0
|
|
---
|
|
|
|
[中文](https://github.com/go-xorm/xorm/blob/master/README_CN.md)
|
|
|
|
Xorm is a simple and powerful ORM for Go.
|
|
|
|
[](https://drone.io/github.com/go-xorm/tests/latest) [](http://gowalker.org/github.com/go-xorm/xorm) [](https://bitdeli.com/free "Bitdeli Badge")
|
|
|
|
# Features
|
|
|
|
* Struct <-> Table Mapping Support
|
|
|
|
* Chainable APIs
|
|
|
|
* Transaction Support
|
|
|
|
* Both ORM and raw SQL operation Support
|
|
|
|
* Sync database schema Support
|
|
|
|
* Query Cache speed up
|
|
|
|
* Database Reverse support, See [Xorm Tool README](https://github.com/go-xorm/cmd/blob/master/README.md)
|
|
|
|
* Simple cascade loading support
|
|
|
|
* Optimistic Locking support
|
|
|
|
|
|
# Drivers Support
|
|
|
|
Drivers for Go's sql package which currently support database/sql includes:
|
|
|
|
* Mysql: [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
|
|
|
|
* MyMysql: [github.com/ziutek/mymysql/godrv](https://github.com/ziutek/mymysql/godrv)
|
|
|
|
* SQLite: [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
|
|
|
|
* Postgres: [github.com/lib/pq](https://github.com/lib/pq)
|
|
|
|
* MsSql: [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)
|
|
|
|
* MsSql: [github.com/lunny/godbc](https://github.com/lunny/godbc)
|
|
|
|
|
|
|
|
# Changelog
|
|
|
|
* **v0.4.0 RC1**
|
|
Changes:
|
|
* moved xorm cmd to [github.com/go-xorm/cmd](github.com/go-xorm/cmd)
|
|
* refactored general DB operation a core lib at [github.com/go-xorm/core](https://github.com/go-xorm/core)
|
|
* moved tests to github.com/go-xorm/tests [github.com/go-xorm/tests](github.com/go-xorm/tests)
|
|
|
|
Improvements:
|
|
* Prepared statement cache
|
|
* Add Incr API
|
|
* Specify Timezone Location
|
|
|
|
* **v0.3.2**
|
|
Improvements:
|
|
* Add AllCols & MustCols function
|
|
* Add TableName for custom table name
|
|
|
|
Bug Fixes:
|
|
* #46
|
|
* #51
|
|
* #53
|
|
* #89
|
|
* #86
|
|
* #92
|
|
|
|
* **v0.3.1**
|
|
|
|
Features:
|
|
* Support MSSQL DB via ODBC driver ([github.com/lunny/godbc](https://github.com/lunny/godbc));
|
|
* Composite Key, using multiple pk xorm tag
|
|
* Added Row() API as alternative to Iterate() API for traversing result set, provide similar usages to sql.Rows type
|
|
* ORM struct allowed declaration of pointer builtin type as members to allow null DB fields
|
|
* Before and After Event processors
|
|
|
|
Improvements:
|
|
* Allowed int/int32/int64/uint/uint32/uint64/string as Primary Key type
|
|
* Performance improvement for Get()/Find()/Iterate()
|
|
|
|
[More changelogs ...](https://github.com/go-xorm/xorm/blob/master/docs/Changelog.md)
|
|
|
|
# Installation
|
|
|
|
If you have [gopm](https://github.com/gpmgo/gopm) installed,
|
|
|
|
gopm get github.com/go-xorm/xorm
|
|
|
|
Or
|
|
|
|
go get github.com/go-xorm/xorm
|
|
|
|
# Documents
|
|
|
|
* [GoDoc](http://godoc.org/github.com/go-xorm/xorm)
|
|
|
|
* [GoWalker](http://gowalker.org/github.com/go-xorm/xorm)
|
|
|
|
* [Quick Start](https://github.com/go-xorm/xorm/blob/master/docs/QuickStart.md)
|
|
|
|
# Cases
|
|
|
|
* [Gorevel](http://http://gorevel.cn/) - [github.com/goofcc/gorevel](http://github.com/goofcc/gorevel)
|
|
|
|
* [Gogs](http://try.gogits.org) - [github.com/gogits/gogs](http://github.com/gogits/gogs)
|
|
|
|
* [Gowalker](http://gowalker.org) - [github.com/Unknwon/gowalker](http://github.com/Unknwon/gowalker)
|
|
|
|
* [Gobuild.io](http://gobuild.io) - [github.com/shxsun/gobuild](http://github.com/shxsun/gobuild)
|
|
|
|
* [Sudo China](http://sudochina.com) - [github.com/insionng/toropress](http://github.com/insionng/toropress)
|
|
|
|
* [Godaily](http://godaily.org) - [github.com/govc/godaily](http://github.com/govc/godaily)
|
|
|
|
* [Very Hour](http://veryhour.com/)
|
|
|
|
* [GoCMS - github.com/zzboy/GoCMS](https://github.com/zzdboy/GoCMS)
|
|
|
|
* [GoBBS - gobbs.domolo.com](http://gobbs.domolo.com/)
|
|
|
|
|
|
# Discuss
|
|
|
|
Please visit [Xorm on Google Groups](https://groups.google.com/forum/#!forum/xorm)
|
|
|
|
# Contributing
|
|
|
|
If you want to pull request, please see [CONTRIBUTING](https://github.com/go-xorm/xorm/blob/master/CONTRIBUTING.md)
|
|
|
|
# LICENSE
|
|
|
|
BSD License
|
|
[http://creativecommons.org/licenses/BSD/](http://creativecommons.org/licenses/BSD/)
|