xorm/README.md

[中文](https://github.com/go-xorm/xorm/blob/master/README_CN.md)

Xorm is a simple and powerful ORM for Go.

[![Build Status](https://drone.io/github.com/go-xorm/tests/status.png)](https://drone.io/github.com/go-xorm/tests/latest)  [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/go-xorm/xorm) [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/lunny/xorm/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

# Features

[![Join the chat at https://gitter.im/go-xorm/xorm](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/go-xorm/xorm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

* 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)

* Oracle: [github.com/mattn/go-oci8](https://github.com/mattn/go-oci8) (experiment)

# Changelog

* **v0.4.3**
    * Json column type support
    * oracle expirement support
    * bug fixed

* **v0.4.2**
	* Transaction will auto rollback if not Rollback or Commit be called.
    * Gonic Mapper support
    * bug fixed

[More changelogs ...](https://github.com/go-xorm/manual-en-US/tree/master/chapter-16)

# 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

* [Manual](http://xorm.io/docs)

* [GoDoc](http://godoc.org/github.com/go-xorm/xorm)

* [GoWalker](http://gowalker.org/github.com/go-xorm/xorm)

# Cases

* [github.com/m3ng9i/qreader](https://github.com/m3ng9i/qreader)

* [Wego](http://github.com/go-tango/wego)

* [Docker.cn](https://docker.cn/)

* [Gogs](http://try.gogits.org) - [github.com/gogits/gogs](http://github.com/gogits/gogs)

* [Gorevel](http://gorevel.cn/) - [github.com/goofcc/gorevel](http://github.com/goofcc/gorevel)

* [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)

* [YouGam](http://www.yougam.com/)

* [GoCMS - github.com/zzboy/GoCMS](https://github.com/zzdboy/GoCMS)

* [GoBBS - gobbs.domolo.com](http://gobbs.domolo.com/)

* [go-blog](http://wangcheng.me) - [github.com/easykoo/go-blog](https://github.com/easykoo/go-blog)

# 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/)
renamed import path 2014-04-11 09:16:43 +00:00			`[中文](https://github.com/go-xorm/xorm/blob/master/README_CN.md)`
dos2unix format 2014-01-07 09:21:02 +00:00
			`Xorm is a simple and powerful ORM for Go.`

bug fixed build status 2014-10-20 02:06:45 +00:00			`[![Build Status](https://drone.io/github.com/go-xorm/tests/status.png)](https://drone.io/github.com/go-xorm/tests/latest) [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/go-xorm/xorm) [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/lunny/xorm/trend.png)](https://bitdeli.com/free "Bitdeli Badge")`
improved docs 2013-11-22 01:20:41 +00:00
dos2unix format 2014-01-07 09:21:02 +00:00			`# Features`

Added Gitter badge 2015-08-25 23:15:57 +00:00			`[![Join the chat at https://gitter.im/go-xorm/xorm](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/go-xorm/xorm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`

improved docs 2013-11-22 01:20:41 +00:00			`* Struct <-> Table Mapping Support`
improved docs 2013-09-29 14:39:59 +00:00
improved docs 2013-11-22 01:20:41 +00:00			`* Chainable APIs`

			`* Transaction Support`
dos2unix format 2014-01-07 09:21:02 +00:00
improved docs 2013-11-22 05:05:10 +00:00			`* Both ORM and raw SQL operation Support`
improved docs 2013-11-22 01:20:41 +00:00
Fixing typo in readme.md schema 2014-04-15 12:09:20 +00:00			`* Sync database schema Support`
improved docs 2013-11-22 01:20:41 +00:00
improved docs 2013-11-22 05:05:10 +00:00			`* Query Cache speed up`
improved docs 2013-11-22 01:20:41 +00:00
fixed reference of README.md 2014-05-02 03:11:19 +00:00			`* Database Reverse support, See [Xorm Tool README](https://github.com/go-xorm/cmd/blob/master/README.md)`
improved docs 2013-11-22 01:20:41 +00:00
			`* Simple cascade loading support`
Improved documents; Optimistic Locking support; Timestamp with time zone support; Mapper change to tableMapper and columnMapper & added PrefixMapper & SuffixMapper support custom table or column name's prefix and suffix;Insert now return affected, err instead of id, err; Added UseBool & Distinct; 2013-11-29 03:50:28 +00:00
			`* Optimistic Locking support`

dos2unix format 2014-01-07 09:21:02 +00:00
			`# Drivers Support`

			`Drivers for Go's sql package which currently support database/sql includes:`

improved docs 2013-11-22 05:05:10 +00:00			`* Mysql: [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)`
dos2unix format 2014-01-07 09:21:02 +00:00
			`* 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)`

add mssql driver support 2014-07-01 07:38:05 +00:00			`* MsSql: [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)`

dos2unix format 2014-01-07 09:21:02 +00:00			`* MsSql: [github.com/lunny/godbc](https://github.com/lunny/godbc)`

update readme 2015-04-01 13:53:17 +00:00			`* Oracle: [github.com/mattn/go-oci8](https://github.com/mattn/go-oci8) (experiment)`

improved docs 2013-11-22 01:20:41 +00:00			`# Changelog`
Added database reverse tool, now support generate go & c++ codes, some bug fixed. 2013-10-15 02:40:21 +00:00
resolved #176 & cache bug fixed 2015-04-01 08:32:17 +00:00			`* v0.4.3`
			`* Json column type support`
			`* oracle expirement support`
			`* bug fixed`
update README 2014-04-21 02:02:47 +00:00
resolved #176 & cache bug fixed 2015-04-01 08:32:17 +00:00			`* v0.4.2`
			`* Transaction will auto rollback if not Rollback or Commit be called.`
			`* Gonic Mapper support`
			`* bug fixed`
add lib/pq support; bool on struct will not be as condition; 2013-11-06 07:36:38 +00:00
resolved #176 & cache bug fixed 2015-04-01 08:32:17 +00:00			`[More changelogs ...](https://github.com/go-xorm/manual-en-US/tree/master/chapter-16)`
dos2unix format 2014-01-07 09:21:02 +00:00
use gopm as get & build tool 2013-12-01 03:08:17 +00:00			`# Installation`

			`If you have [gopm](https://github.com/gpmgo/gopm) installed,`

Updated the references to the old repository changed the links to point to https://github.com/go-xorm/xorm not https://github.com/lunny/xorm 2014-04-15 13:52:19 +00:00			`gopm get github.com/go-xorm/xorm`
add cache for string 2014-11-07 09:56:33 +00:00
dos2unix format 2014-01-07 09:21:02 +00:00			`Or`

Updated the references to the old repository changed the links to point to https://github.com/go-xorm/xorm not https://github.com/lunny/xorm 2014-04-15 13:52:19 +00:00			`go get github.com/go-xorm/xorm`
dos2unix format 2014-01-07 09:21:02 +00:00
improved docs 2013-11-22 05:05:10 +00:00			`# Documents`
Added database reverse tool, now support generate go & c++ codes, some bug fixed. 2013-10-15 02:40:21 +00:00
new doc links 2014-10-19 06:41:47 +00:00			`* [Manual](http://xorm.io/docs)`

Updated the references to the old repository changed the links to point to https://github.com/go-xorm/xorm not https://github.com/lunny/xorm 2014-04-15 13:52:19 +00:00			`* [GoDoc](http://godoc.org/github.com/go-xorm/xorm)`
dos2unix format 2014-01-07 09:21:02 +00:00
Updated the references to the old repository changed the links to point to https://github.com/go-xorm/xorm not https://github.com/lunny/xorm 2014-04-15 13:52:19 +00:00			`* [GoWalker](http://gowalker.org/github.com/go-xorm/xorm)`
Added database reverse tool, now support generate go & c++ codes, some bug fixed. 2013-10-15 02:40:21 +00:00
improved docs 2013-11-22 01:20:41 +00:00			`# Cases`
Added database reverse tool, now support generate go & c++ codes, some bug fixed. 2013-10-15 02:40:21 +00:00
add qreader case 2015-05-26 08:27:18 +00:00			`* [github.com/m3ng9i/qreader](https://github.com/m3ng9i/qreader)`

add wego as case 2015-02-18 00:58:07 +00:00			`* [Wego](http://github.com/go-tango/wego)`

Update README.md 2014-11-13 01:18:40 +00:00			`* [Docker.cn](https://docker.cn/)`
bug fixed 2014-04-20 08:01:53 +00:00
add use case gogs 2014-03-27 14:16:06 +00:00			`* [Gogs](http://try.gogits.org) - [github.com/gogits/gogs](http://github.com/gogits/gogs)`

add wego as case 2015-02-18 00:58:07 +00:00			`* [Gorevel](http://gorevel.cn/) - [github.com/goofcc/gorevel](http://github.com/goofcc/gorevel)`
Update README.md 2014-11-13 01:18:40 +00:00
add gowalker to cases 2013-11-15 03:04:48 +00:00			`* [Gowalker](http://gowalker.org) - [github.com/Unknwon/gowalker](http://github.com/Unknwon/gowalker)`

add gobuild as cases 2014-02-12 07:10:37 +00:00			`* [Gobuild.io](http://gobuild.io) - [github.com/shxsun/gobuild](http://github.com/shxsun/gobuild)`

Added database reverse tool, now support generate go & c++ codes, some bug fixed. 2013-10-15 02:40:21 +00:00			`* [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)`

Update README.md 2014-10-27 04:05:26 +00:00			`* [YouGam](http://www.yougam.com/)`
dos2unix format 2014-01-07 09:21:02 +00:00
add use case gogs 2014-03-27 14:16:06 +00:00			`* [GoCMS - github.com/zzboy/GoCMS](https://github.com/zzdboy/GoCMS)`
dos2unix format 2014-01-07 09:21:02 +00:00
add use case gobbs 2014-04-13 06:32:21 +00:00			`* [GoBBS - gobbs.domolo.com](http://gobbs.domolo.com/)`

add go-blog example 2014-10-28 02:37:37 +00:00			`* [go-blog](http://wangcheng.me) - [github.com/easykoo/go-blog](https://github.com/easykoo/go-blog)`
add use case gobbs 2014-04-13 06:32:21 +00:00
improved docs 2013-11-22 01:20:41 +00:00			`# Discuss`

merge null field codes 2013-12-08 13:40:58 +00:00			`Please visit [Xorm on Google Groups](https://groups.google.com/forum/#!forum/xorm)`

docs small improved 2014-04-23 06:57:40 +00:00			`# Contributing`
merge null field codes 2013-12-08 13:40:58 +00:00
Updated the references to the old repository changed the links to point to https://github.com/go-xorm/xorm not https://github.com/lunny/xorm 2014-04-15 13:52:19 +00:00			`If you want to pull request, please see [CONTRIBUTING](https://github.com/go-xorm/xorm/blob/master/CONTRIBUTING.md)`
improved docs 2013-12-31 06:33:02 +00:00
dos2unix format 2014-01-07 09:21:02 +00:00			`# LICENSE`

			`BSD License`
Fixing typo in readme.md schema 2014-04-15 12:09:20 +00:00			`[http://creativecommons.org/licenses/BSD/](http://creativecommons.org/licenses/BSD/)`