https://github.com/gobuffalo/pop

A Tasty Treat For All Your Database Needs
https://github.com/gobuffalo/pop

cockroachdb database gobuffalo migrations mysql orm postgresql sqlite

Last synced: 5 days ago
JSON representation

A Tasty Treat For All Your Database Needs

• Host: GitHub
• URL: https://github.com/gobuffalo/pop
• Owner: gobuffalo
• License: mit
• Created: 2018-02-07T21:13:46.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-06-26T20:32:44.000Z (7 months ago)
• Last Synced: 2024-12-31T03:07:55.725Z (12 days ago)
• Topics: cockroachdb, database, gobuffalo, migrations, mysql, orm, postgresql, sqlite
• Language: Go
• Homepage:
• Size: 5.46 MB
• Stars: 1,456
• Watchers: 22
• Forks: 246
• Open Issues: 94
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-go - pop/soda - Database migration, creation, ORM, etc... for MySQL, PostgreSQL, and SQLite. (ORM / HTTP Clients)
• zero-alloc-awesome-go - pop/soda - Database migration, creation, ORM, etc... for MySQL, PostgreSQL, and SQLite. (ORM / HTTP Clients)
• go-awesome - POP - A database ORM tool based on the [sqlx](https://github.com/jmoiron/sqlx) package (Open source library / Database)
• awesome-go - pop/soda - Database migration, creation, ORM, etc... for MySQL, PostgreSQL, and SQLite. Stars:`1.5K`. (ORM / HTTP Clients)
• awesome-go-extra - pop - 02-07T21:13:46Z|2022-08-23T22:32:47Z| (ORM / HTTP Clients)
• awesome-go-zh - pop/soda
• awesome-go - pop - A Tasty Treat For All Your Database Needs - ★ 505 (ORM)

README

        




    

    



# POP

## A Tasty Treat For All Your Database Needs

So what does Pop do exactly? Well, it wraps the absolutely amazing [https://github.com/jmoiron/sqlx](https://github.com/jmoiron/sqlx) library. It cleans up some of the common patterns and work flows usually associated with dealing with databases in Go.

Pop makes it easy to do CRUD operations, run migrations, and build/execute queries.

Pop, by default, follows conventions that were influenced by the [ActiveRecord](http://www.rubyonrails.org) Ruby gem. What does this mean?

* Tables must have an "id" column and a corresponding "ID" field on the `struct` being used.

* If there is a `timestamp` column named `created_at`, and a `CreatedAt time.Time` attribute on the `struct`, it will be set with the current time when the record is created.

* If there is a `timestamp` column named `updated_at`, and a `UpdatedAt time.Time` attribute on the `struct`, it will be set with the current time when the record is updated.

* Default database table names are lowercase, plural, and underscored versions of the `struct` name. Examples: User{} is "users", FooBar{} is "foo_bars", etc...

Want to know more? Take a look at the documentation!

## Documentation

Please visit [http://gobuffalo.io](https://gobuffalo.io/docs/db/getting-started) for the latest documentation, examples, and more.

### Quick Start

* [CLI Installation](https://gobuffalo.io/docs/db/toolbox)

* [Configuration](https://gobuffalo.io/docs/db/configuration)

## Shoulders of Giants

Pop would not be possible if not for all of the great projects it depends on. Please see [SHOULDERS.md](SHOULDERS.md) to see a list of them.

## Contributing

First, thank you so much for wanting to contribute! It means so much that you care enough to want to contribute. We appreciate every PR from the smallest of typos to the be biggest of features.

To contribute, please read the contribution guidelines: [CONTRIBUTING](.github/CONTRIBUTING.md)