Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fs02/grimoire
Database access layer for golang
https://github.com/fs02/grimoire
changeset database golang mysql orm postgres sqlite3 validation
Last synced: about 1 month ago
JSON representation
Database access layer for golang
- Host: GitHub
- URL: https://github.com/fs02/grimoire
- Owner: Fs02
- License: mit
- Created: 2018-03-05T16:52:20.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-10-25T23:52:11.000Z (about 3 years ago)
- Last Synced: 2024-11-09T00:35:29.453Z (about 2 months ago)
- Topics: changeset, database, golang, mysql, orm, postgres, sqlite3, validation
- Language: Go
- Homepage: https://fs02.github.io/grimoire
- Size: 896 KB
- Stars: 164
- Watchers: 6
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changeset/add_error.go
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# grimoire
[](https://godoc.org/github.com/Fs02/grimoire) [](https://travis-ci.org/Fs02/grimoire) [](https://goreportcard.com/report/github.com/Fs02/grimoire) [](https://codeclimate.com/github/Fs02/grimoire/maintainability) [](https://codeclimate.com/github/Fs02/grimoire/test_coverage)
[](https://app.fossa.io/projects/git%2Bgithub.com%2FFs02%2Fgrimoire?ref=badge_shield)
> :warning: Grimoire V2 is available as [REL](https://github.com/go-rel/rel) and [Changeset](https://github.com/Fs02/changeset) package.
Grimoire is a database access layer inspired by Ecto. It features a flexible query API and built-in validation. It currently supports MySQL, PostgreSQL, and SQLite3 but a custom adapter can be implemented easily using the Adapter interface.
Features:
- Query Builder
- Association Preloading
- Struct style create and update
- Changeset Style create and update
- Builtin validation using changeset
- Multi adapter support
- Logger
## Motivation
Common go ORM accepts struct as a value for modifying records which has a problem of unable to differentiate between an empty, nil, or undefined value. It's a tricky problem especially when you want to have an endpoint that supports partial updates. Grimoire attempts to solve that problem by integrating Changeset system inspired from Elixir's Ecto. Changeset is a form like entity which allows us to not only solve that problem but also help us with casting, validations, and constraints check.
## Install
```bash
go get github.com/Fs02/grimoire
```
## Quick Start
```golang
package main
import (
"time"
"github.com/Fs02/grimoire"
"github.com/Fs02/grimoire/adapter/mysql"
"github.com/Fs02/grimoire/changeset"
"github.com/Fs02/grimoire/params"
)
type Product struct {
ID int
Name string
Price int
CreatedAt time.Time
UpdatedAt time.Time
}
// ChangeProduct prepares data before database operation.
// Such as casting value to appropriate types and perform validations.
func ChangeProduct(product interface{}, params params.Params) *changeset.Changeset {
ch := changeset.Cast(product, params, []string{"name", "price"})
changeset.ValidateRequired(ch, []string{"name", "price"})
changeset.ValidateMin(ch, "price", 100)
return ch
}
func main() {
// initialize mysql adapter.
adapter, err := mysql.Open("root@(127.0.0.1:3306)/db?charset=utf8&parseTime=True&loc=Local")
if err != nil {
panic(err)
}
defer adapter.Close()
// initialize grimoire's repo.
repo := grimoire.New(adapter)
var product Product
// Inserting Products.
// Changeset is used when creating or updating your data.
ch := ChangeProduct(product, params.Map{
"name": "shampoo",
"price": 1000,
})
if ch.Error() != nil {
// handle error
}
// Changeset can also be created directly from json string.
jsonch := ChangeProduct(product, params.ParseJSON(`{
"name": "soap",
"price": 2000,
}`))
// Create products with changeset and return the result to &product,
if err = repo.From("products").Insert(&product, ch); err != nil {
// handle error
}
// or panic when insertion failed
repo.From("products").MustInsert(&product, jsonch)
// Querying Products.
// Find a product with id 1.
repo.From("products").Find(1).MustOne(&product)
// Updating Products.
// Update products with id=1.
repo.From("products").Find(1).MustUpdate(&product, ch)
// Deleting Products.
// Delete Product with id=1.
repo.From("products").Find(1).MustDelete()
}
```
## Examples
- [Todo API](https://github.com/Fs02/grimoire-todo-example)
## Documentation
Guides: [https://fs02.github.io/grimoire](https://fs02.github.io/grimoire)
API Documentation: [https://godoc.org/github.com/Fs02/grimoire](https://godoc.org/github.com/Fs02/grimoire)
## License
Released under the [MIT License](https://github.com/Fs02/grimoire/blob/master/LICENSE)
[](https://app.fossa.io/projects/git%2Bgithub.com%2FFs02%2Fgrimoire?ref=badge_large)