Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevenferrer/nero
A library for generating the repository pattern.
https://github.com/stevenferrer/nero
code-generation code-generator go golang postgres postgresql repository-pattern sql sqlite3
Last synced: 1 day ago
JSON representation
A library for generating the repository pattern.
- Host: GitHub
- URL: https://github.com/stevenferrer/nero
- Owner: stevenferrer
- License: apache-2.0
- Created: 2020-07-30T17:18:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-07T15:28:35.000Z (over 2 years ago)
- Last Synced: 2024-06-21T03:23:39.971Z (5 months ago)
- Topics: code-generation, code-generator, go, golang, postgres, postgresql, repository-pattern, sql, sqlite3
- Language: Go
- Homepage:
- Size: 804 KB
- Stars: 34
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pkg.go.dev/github.com/stevenferrer/nero)
[](https://coveralls.io/github/stevenferrer/nero?branch=main)
[](https://goreportcard.com/report/github.com/stevenferrer/nero)
# Nero
A library for generating the repository pattern.
## Motivation
We heavily use the _[repository pattern](https://threedots.tech/post/repository-pattern-in-go/)_ in our codebases and we often [write our queries manually](https://golang.org/pkg/database/sql/#example_DB_QueryContext). It becomes tedious and repetitive as we have more tables/models to maintain. So, we decided to experiment on creating this library to generate our repositories automatically.
## Goals
- Decouple implementation from the `Repository` interface
- Easy integration with existing codebase
- Minimal API
## Installation
```console
$ go get github.com/stevenferrer/nero
```
## Example
See the [official example](https://github.com/stevenferrer/nero-example) and [integration test](./test/integration/playerrepo) for a more complete demo.
```go
import (
"database/sql"
// import the generated package
"github.com/stevenferrer/nero-example/productrepo"
)
func main() {
dsn := "postgres://postgres:postgres@localhost:5432/postgres?sslmode=disable"
db, err := sql.Open("postgres", dsn)
...
ctx := context.Background()
// initialize the repository (and optionally enable debug)
productRepo := productrepo.NewPostgresRepository(db).Debug()
// create
creator := productrepo.NewCreator().Name("Product 1")
productID, err := productRepo.Create(ctx, creator)
...
// query
queryer := productrepo.NewQueryer().Where(productrepo.IDEq(product1ID))
product, err := productRepo.QueryOne(ctx, queryer)
...
// update
now := time.Now()
updater := productrepo.NewUpdater().Name("Updated Product 1").
UpdatedAt(&now).Where(productrepo.IDEq(product1ID))
_, err = productRepo.Update(ctx, updater)
...
// delete
deleter := productrepo.NewDeleter().Where(productrepo.IDEq(product1ID))
_, err = productRepo.Delete(ctx, deleter)
...
}
```
## Supported back-ends
Below is the list of supported back-ends.
| Back-end | Library |
| -------------------- | ------------------------------------------------------------- |
| PostgreSQL | [lib/pq](http://github.com/lib/pq) |
| SQLite | [mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) |
| MySQL/MariaDB (soon) | [go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) |
If your your back-end is not yet supported, you can implement your own [custom back-end](#custom-back-ends).
## Custom back-ends
Implementing a custom back-end is very easy. In fact, you don't have to use the official back-ends. You can implement custom back-ends (Oracle, MSSQL, BoltDB, MongoDB, etc.) by implementing the [_Template_](./template.go) interface.
See official [postgres template](./pg_template.go) for reference.
## Limitations
Currently, we only support basic CRUD and aggregate operations (i.e. count, sum). If you have more complex requirements other than that, we suggest that you just write your repositories manually, at least for now.
We're still in the process of brain-storming how to elegantly support other operations such as joins. If you have any ideas, we'd love to hear from you!
## Standing on the shoulders of giants
This project wouldn't be possible without the amazing open-source projects it was built upon:
- [Masterminds/squirrel](https://github.com/Masterminds/squirrel) - Fluent SQL generation in golang
- [lib/pq](https://github.com/lib/pq) - Pure Go Postgres driver for database/sql
- [mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) - sqlite3 driver conforming to the built-in database/sql interface
- [pkg/errors](https://github.com/pkg/errors) - Simple error handling primitives
- [hashicorp/multierror](https://github.com/hashicorp/go-multierror) - A Go (golang) package for representing a list of errors as a single error.
- [jinzhu/inflection](https://github.com/jinzhu/inflection) - Pluralizes and singularizes English nouns
- [stretchr/testify](https://github.com/stretchr/testify) - A toolkit with common assertions and mocks that plays nicely with the standard library
Also, the following have a huge influence on this project and deserves most of the credits:
- [ent](https://github.com/facebook/ent) - An entity framework for Go. Simple, yet powerful ORM for modeling and querying data.
- [SQLBoiler](https://github.com/volatiletech/sqlboiler) - Generate a Go ORM tailored to your database schema.
## What's in the name?
The project name is inspired by an [anti-bird](https://blackclover.fandom.com/wiki/Anti-bird) in an anime called [Black Clover](https://blackclover.fandom.com/wiki/Black_Clover_Wiki). The anti-bird, which the [Black Bulls](https://blackclover.fandom.com/wiki/Black_Bull) squad calls _Nero_ is apparently a human named [Secre Swallowtail](https://blackclover.fandom.com/wiki/Secre_Swallowtail). It's a really cool anime with lots of magic!
## Contributing
Any suggestions and ideas are very much welcome, feel free to [open an issue](https://github.com/stevenferrer/nero/issues) or [make a pull request](https://github.com/stevenferrer/nero/pulls)!
## License
[Apache-2.0](LICENSE)