gorm/README.md

# GORM

The fantastic ORM library for Golang, aims to be developer friendly.

[![go report card](https://goreportcard.com/badge/github.com/go-gorm/gorm "go report card")](https://goreportcard.com/report/github.com/go-gorm/gorm)
[![test status](https://github.com/go-gorm/gorm/workflows/tests/badge.svg?branch=master "test status")](https://github.com/go-gorm/gorm/actions)
[![Join the chat at https://gitter.im/jinzhu/gorm](https://img.shields.io/gitter/room/jinzhu/gorm.svg)](https://gitter.im/jinzhu/gorm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Open Collective Backer](https://opencollective.com/gorm/tiers/backer/badge.svg?label=backer&color=brightgreen "Open Collective Backer")](https://opencollective.com/gorm)
[![Open Collective Sponsor](https://opencollective.com/gorm/tiers/sponsor/badge.svg?label=sponsor&color=brightgreen "Open Collective Sponsor")](https://opencollective.com/gorm)
[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
[![Go.Dev reference](https://img.shields.io/badge/go.dev-reference-blue?logo=go&logoColor=white)](https://pkg.go.dev/gorm.io/gorm?tab=doc)

## Overview

* Full-Featured ORM
* Associations (Has One, Has Many, Belongs To, Many To Many, Polymorphism, Single-table inheritance)
* Hooks (Before/After Create/Save/Update/Delete/Find)
* Eager loading with `Preload`, `Joins`
* Transactions, Nested Transactions, Save Point, RollbackTo to Saved Point
* Context, Prepared Statement Mode, DryRun Mode
* Batch Insert, FindInBatches, Find To Map
* SQL Builder, Upsert, Locking, Optimizer/Index/Comment Hints, NamedArg, Search/Update/Create with SQL Expr
* Composite Primary Key
* Auto Migrations
* Logger
* Extendable, flexible plugin API: Database Resolver (Multiple Databases, Read/Write Splitting) / Prometheus…
* Every feature comes with tests
* Developer Friendly

## Getting Started

* GORM Guides [https://gorm.io](https://gorm.io)
* Gen Guides [https://gorm.io/gen/index.html](https://gorm.io/gen/index.html)

## Contributing

[You can help to deliver a better GORM, check out things you can do](https://gorm.io/contribute.html)

## License

© Jinzhu, 2013~time.Now

Released under the [MIT License](https://github.com/go-gorm/gorm/blob/master/License)
Initialize with README 2013-10-25 12:24:29 +04:00			`# GORM`

Update TODO 2014-01-03 10:54:47 +04:00			`The fantastic ORM library for Golang, aims to be developer friendly.`
Initialize with README 2013-10-25 12:24:29 +04:00
Fix typo 2020-06-09 07:00:43 +03:00			`[![go report card](https://goreportcard.com/badge/github.com/go-gorm/gorm "go report card")](https://goreportcard.com/report/github.com/go-gorm/gorm)`
Switch to github actions 2020-06-22 18:14:17 +03:00			`[![test status](https://github.com/go-gorm/gorm/workflows/tests/badge.svg?branch=master "test status")](https://github.com/go-gorm/gorm/actions)`
Update README 2018-02-13 12:59:29 +03:00			`[![Join the chat at https://gitter.im/jinzhu/gorm](https://img.shields.io/gitter/room/jinzhu/gorm.svg)](https://gitter.im/jinzhu/gorm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
			`[![Open Collective Backer](https://opencollective.com/gorm/tiers/backer/badge.svg?label=backer&color=brightgreen "Open Collective Backer")](https://opencollective.com/gorm)`
			`[![Open Collective Sponsor](https://opencollective.com/gorm/tiers/sponsor/badge.svg?label=sponsor&color=brightgreen "Open Collective Sponsor")](https://opencollective.com/gorm)`
Change gorm.io links to https 2019-05-05 11:23:52 +03:00			`[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)`
Replace godoc badge with pkg.go.dev (#3051) 2020-06-12 15:00:55 +03:00			`[![Go.Dev reference](https://img.shields.io/badge/go.dev-reference-blue?logo=go&logoColor=white)](https://pkg.go.dev/gorm.io/gorm?tab=doc)`
readme. add wrecker master branch badge to readme. 2014-11-24 07:38:42 +03:00
Update README 2013-10-28 06:09:44 +04:00			`## Overview`

Update README 2020-06-22 15:22:15 +03:00			`* Full-Featured ORM`
			`* Associations (Has One, Has Many, Belongs To, Many To Many, Polymorphism, Single-table inheritance)`
Update README 2018-02-16 19:33:52 +03:00			`* Hooks (Before/After Create/Save/Update/Delete/Find)`
Update README 2020-06-22 15:22:15 +03:00			* Eager loading with `Preload`, `Joins`
			`* Transactions, Nested Transactions, Save Point, RollbackTo to Saved Point`
Fix typo in README (#4012) 2021-01-28 05:21:58 +03:00			`* Context, Prepared Statement Mode, DryRun Mode`
Update README 2020-06-22 15:22:15 +03:00			`* Batch Insert, FindInBatches, Find To Map`
Add GormValuer interface support 2020-08-27 10:03:57 +03:00			`* SQL Builder, Upsert, Locking, Optimizer/Index/Comment Hints, NamedArg, Search/Update/Create with SQL Expr`
Update README 2016-03-07 16:18:48 +03:00			`* Composite Primary Key`
			`* Auto Migrations`
			`* Logger`
Update README 2020-08-26 07:22:11 +03:00			`* Extendable, flexible plugin API: Database Resolver (Multiple Databases, Read/Write Splitting) / Prometheus…`
Update README 2013-11-07 08:12:25 +04:00			`* Every feature comes with tests`
			`* Developer Friendly`
Update README 2013-10-28 06:09:44 +04:00
Update README 2016-02-29 17:06:15 +03:00			`## Getting Started`
Add support for primary key different from id 2014-04-02 12:59:07 +04:00
Change gorm.io links to https 2019-05-05 11:23:52 +03:00			`* GORM Guides [https://gorm.io](https://gorm.io)`
Update README 2022-10-14 15:30:28 +03:00			`* Gen Guides [https://gorm.io/gen/index.html](https://gorm.io/gen/index.html)`
Update README 2016-02-29 17:06:15 +03:00
Update README 2018-02-13 12:59:29 +03:00			`## Contributing`
Update README 2016-02-29 17:06:15 +03:00
Change gorm.io links to https 2019-05-05 11:23:52 +03:00			`[You can help to deliver a better GORM, check out things you can do](https://gorm.io/contribute.html)`
Add Contributors link 2015-11-16 05:59:24 +03:00
Use MIT License 2013-11-12 03:13:58 +04:00			`## License`

Update README 2018-02-13 13:12:09 +03:00			`© Jinzhu, 2013~time.Now`

Update README 2020-06-06 09:23:47 +03:00			`Released under the [MIT License](https://github.com/go-gorm/gorm/blob/master/License)`