So what does Pop do exactly? Well, it wraps the absolutely amazing 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 Ruby gem. What does this mean?
- Tables must have an "id" column and a corresponding "ID" field on the
structbeing used. - If there is a
timestampcolumn namedcreated_at, and aCreatedAt time.Timeattribute on thestruct, it will be set with the current time when the record is created. - If there is a
timestampcolumn namedupdated_at, and aUpdatedAt time.Timeattribute on thestruct, 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
structname. Examples: User{} is "users", FooBar{} is "foo_bars", etc...
Want to know more? Take a look at the documentation!
Please visit http://gobuffalo.io for the latest documentation, examples, and more.
Pop would not be possible if not for all of the great projects it depends on. Please see SHOULDERS.md to see a list of them.
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