xorm/README.md

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

Xorm is a simple and powerful ORM for Go.

[![Build Status](https://drone.io/github.com/go-xorm/xorm/status.png)](https://drone.io/github.com/go-xorm/xorm/latest)  [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/go-xorm/xorm) [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/lunny/go-xorm/trend.png)](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/xorm/blob/master/xorm/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/lunny/godbc](https://github.com/lunny/godbc)

# Changelog

* **v0.3.2** 
	Improvements:
	* Add MustCols function

	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/QuickStartEn.md)

# Cases

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

# Contributors

If you want to pull request, please see [CONTRIBUTING](https://github.com/go-xorm/xorm/blob/master/CONTRIBUTING.md)

* [Lunny](https://github.com/lunny)
* [Nashtsai](https://github.com/nashtsai)

# LICENSE

 BSD License
 [http://creativecommons.org/licenses/BSD/](http://creativecommons.org/licenses/BSD/)
dos2unix format 2014-01-07 09:21:02 +00:00			`[中文](https://github.com/lunny/xorm/blob/master/README_CN.md)`

			`Xorm is a simple and powerful ORM for Go.`

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			`[![Build Status](https://drone.io/github.com/go-xorm/xorm/status.png)](https://drone.io/github.com/go-xorm/xorm/latest) [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/go-xorm/xorm) [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/lunny/go-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`

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
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			`* Database Reverse support, See [Xorm Tool README](https://github.com/go-xorm/xorm/blob/master/xorm/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)`

			`* MsSql: [github.com/lunny/godbc](https://github.com/lunny/godbc)`

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
pump xorm version 0.3.2 2014-04-14 14:15:01 +00:00			`* v0.3.2`
			`Improvements:`
			`* Add MustCols function`

			`Bug Fixes:`
			`* #46`
			`* #51`
			`* #53`
			`* #89`
			`* #86`
			`* #92`

dos2unix format 2014-01-07 09:21:02 +00:00			`* v0.3.1`

			`Features:`
v0.3.1 2014-01-02 09:48:57 +00:00			`* 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()`
add lib/pq support; bool on struct will not be as condition; 2013-11-06 07:36:38 +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			`[More changelogs ...](https://github.com/go-xorm/xorm/blob/master/docs/Changelog.md)`
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`
use gopm as get & build tool 2013-12-01 03:08:17 +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
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
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			`* [Quick Start](https://github.com/go-xorm/xorm/blob/master/docs/QuickStartEn.md)`
improved docs 2013-11-22 05:05:10 +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 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 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)`

dos2unix format 2014-01-07 09:21:02 +00:00			`* [Very Hour](http://veryhour.com/)`

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/)`


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

			`# Contributors`

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
merge null field codes 2013-12-08 13:40:58 +00:00			`* [Lunny](https://github.com/lunny)`
dos2unix format 2014-01-07 09:21:02 +00:00			`* [Nashtsai](https://github.com/nashtsai)`

			`# 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/)`