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

* Query Cache speed up

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


# Changelog

* **v0.2.3** : 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;
* **v0.2.2** : Postgres drivers now support lib/pq; Added method Iterate for record by record to handler；Added SetMaxConns(go1.2+) support; some bugs fixed.
* **v0.2.1** : Added database reverse tool, now support generate go & c++ codes, see [Xorm Tool README](https://github.com/lunny/xorm/blob/master/xorm/README.md); some bug fixed.
* **v0.2.0** : Added Cache supported, select is speeder up 3~5x; Added SameMapper for same name between struct and table; Added Sync method for auto added tables, columns, indexes;

[More changelogs ...](https://github.com/lunny/xorm/blob/master/docs/Changelog.md)


# Installation

	go get github.com/lunny/xorm

# Documents

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

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

* [Quick Start](https://github.com/lunny/xorm/blob/master/docs/QuickStartEn.md)

# Cases

* [Gowalker](http://gowalker.org) - [github.com/Unknwon/gowalker](http://github.com/Unknwon/gowalker)

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

# Discuss

Please visit [Xorm on Google Groups](https://groups.google.com/forum/#!forum/xorm)

# LICENSE

 BSD License
 [http://creativecommons.org/licenses/BSD/](http://creativecommons.org/licenses/BSD/)
-												imporved readme

											
										
										
											2013-05-12 05:43:09 +00:00
+								[中文](https://github.com/lunny/xorm/blob/master/README_CN.md)
-												init project

											
										
										
											2013-05-03 07:26:51 +00:00
-												improved docs

											
										
										
											2013-11-22 01:20:41 +00:00
+								Xorm is a simple and powerful ORM for Go.
-												fixed readme bugs
											
										
										
											2013-08-16 04:22:34 +00:00
-												improved docs

											
										
										
											2013-10-09 07:08:52 +00:00
+								[![Build Status](https://drone.io/github.com/lunny/xorm/status.png)](https://drone.io/github.com/lunny/xorm/latest)  [![Go Walker](http://gowalker.org/api/v1/badge)](http://gowalker.org/github.com/lunny/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
 								# Features
-												improved doc

											
										
										
											2013-09-11 08:30:17 +00:00
-												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
-												fixed readme bugs
											
										
										
											2013-08-16 04:22:34 +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
 								* Sync database sechmea Support
-												improved docs

											
										
										
											2013-11-22 05:05:10 +00:00
+								* Query Cache speed up
-												improved docs

											
										
										
											2013-11-22 01:20:41 +00:00
 								* Database Reverse support, See [Xorm Tool README](https://github.com/lunny/xorm/blob/master/xorm/README.md)
 								* 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
-												improved docs

											
										
										
											2013-11-22 01:20:41 +00:00
 								# Drivers Support
-												fixed readme bugs
											
										
										
											2013-08-16 04:22:34 +00:00
-												imporved README

											
										
										
											2013-05-11 10:38:43 +00:00
+								Drivers for Go's sql package which currently support database/sql includes:
-												init project

											
										
										
											2013-05-03 07:26:51 +00:00
-												improved docs

											
										
										
											2013-11-22 05:05:10 +00:00
+								* Mysql: [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
-												init project

											
										
										
											2013-05-03 07:26:51 +00:00
-												fixed readme bugs
											
										
										
											2013-08-16 04:22:34 +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)
-												improved docs

											
										
										
											2013-11-22 05:05:10 +00:00
+								* Postgres: [github.com/lib/pq](https://github.com/lib/pq)
-												fixed readme bugs
											
										
										
											2013-08-16 04:22:34 +00:00
-												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
-												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
+								* **v0.2.3** : 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;
-												improved docs

											
										
										
											2013-11-06 07:54:42 +00:00
+								* **v0.2.2** : Postgres drivers now support lib/pq; Added method Iterate for record by record to handler；Added SetMaxConns(go1.2+) support; some bugs fixed.
-												Added database reverse tool, now support generate go & c++ codes, some bug fixed.

											
										
										
											2013-10-15 02:40:21 +00:00
+								* **v0.2.1** : Added database reverse tool, now support generate go & c++ codes, see [Xorm Tool README](https://github.com/lunny/xorm/blob/master/xorm/README.md); some bug fixed.
-												improved docs

											
										
										
											2013-09-29 08:53:01 +00:00
+								* **v0.2.0** : Added Cache supported, select is speeder up 3~5x; Added SameMapper for same name between struct and table; Added Sync method for auto added tables, columns, indexes;
-												add lib/pq support; bool on struct will not be as condition;

											
										
										
											2013-11-06 07:36:38 +00:00
-												improved docs

											
										
										
											2013-11-26 03:27:29 +00:00
+								[More changelogs ...](https://github.com/lunny/xorm/blob/master/docs/Changelog.md)
-												fixed readme bugs
											
										
										
											2013-08-16 04:22:34 +00:00
-												init project

											
										
										
											2013-05-03 07:26:51 +00:00
-												improved docs

											
										
										
											2013-11-22 01:20:41 +00:00
+								# Installation
-												fixed readme bugs
											
										
										
											2013-08-16 04:22:34 +00:00
-												fix mysql test and sqlite test

											
										
										
											2013-05-06 08:01:17 +00:00
+									go get github.com/lunny/xorm
-												init project

											
										
										
											2013-05-03 07:26:51 +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
-												improved docs

											
										
										
											2013-11-22 01:20:41 +00:00
+								* [GoDoc](http://godoc.org/github.com/lunny/xorm)
-												fixed readme bugs
											
										
										
											2013-08-16 04:22:34 +00:00
-												improved docs

											
										
										
											2013-11-22 01:20:41 +00:00
+								* [GoWalker](http://gowalker.org/github.com/lunny/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 05:05:10 +00:00
+								* [Quick Start](https://github.com/lunny/xorm/blob/master/docs/QuickStartEn.md)
-												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 gowalker to cases

											
										
										
											2013-11-15 03:04:48 +00:00
+								* [Gowalker](http://gowalker.org) - [github.com/Unknwon/gowalker](http://github.com/Unknwon/gowalker)
-												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)
 								* [Very Hour](http://veryhour.com/)
-												fixed readme bugs
											
										
										
											2013-08-16 04:22:34 +00:00
-												improved docs

											
										
										
											2013-11-22 01:20:41 +00:00
+								# Discuss
 								Please visit [Xorm on Google Groups](https://groups.google.com/forum/#!forum/xorm)
-												init project

											
										
										
											2013-05-03 07:26:51 +00:00
-												improved docs

											
										
										
											2013-11-22 01:20:41 +00:00
+								# LICENSE
-												init project

											
										
										
											2013-05-03 07:26:51 +00:00
 								 BSD License
 								 [http://creativecommons.org/licenses/BSD/](http://creativecommons.org/licenses/BSD/)