Files
repo/README.md

72 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2025-05-03 20:31:05 +03:00
# repo
2025-05-04 21:39:59 +03:00
This module is mainly an exercise with generics. Although it is a fully functional repository for any Go structs.
Might be useful for pet-projects and like.
Example usage.
```go
import (
"code.uint32.ru/tiny/repo"
_ "github.com/mattn/go-sqlite3"
)
type My struct {
A string
B int
}
func main() {
db, err := sql.Open("sqlite3", "test.db")
if err != nil {
panic(err)
}
defer db.Close()
ctx := context.Background()
// init repository for our type "My"
r, err := repo.OpenOrCreate[My](ctx, db, "my_test_table")
if err != nil {
panic(err)
}
first := &My{
A: "hello",
B: 42,
}
if err := r.Create(ctx, "first_record", first); err != nil {
panic(err)
}
duplicate, err = r.Read(ctx, "first_record")
if err != nil {
panic(err)
}
fmt.Printf("Type: %T, Value: %+v", duplicate)
}
```
The interface is a plain CRUD.
```go
type Repo[T any] interface {
// Create inserts object into repository table. If id already exists
// in the database it is an error.
Create(ctx context.Context, id string, v *T) error
// Read returns object with specified id or ErrNotFound
Read(ctx context.Context, id string) (*T, error)
// Update updates object with id.
Update(ctx context.Context, id string, v *T) error
// Delete performs soft-delete (actually marks object as unavailable).
Delete(ctx context.Context, id string) error
// Purge actually deletes database record with id.
Purge(ctx context.Context, id string) error
}
```