README
¶
GOQU CRUD Generator
Work in progress!
Generates a basic repository by db model definition.
Expected to be used by goqu and sqlx users.
What is generated?
TODO: list and describe generated structs and methods.
Generator creates a repository definition file containing the main CRUD methods:
CreateGetUpdateDelete,DeleteMany
... and some special methods:
WithTrancurrently must be used for wrapping each repo method call.each,iterfor user future use in custom repo methods.
Install
$ go get github.com/funvit/goqu-crud-gen/cmd/...
Usage
Define a db-model.
Rules:
- model must have one field marked as primary key via adding option
primaryfor tagdb- supported field types:
- standard (
int64,string...) - any other which implements
ScannerandValuerinterfaces (ex: github.com/google/uuid)
- standard (
- supported field types:
- if model primary key field value is database-side generated
int64- useautooption for tagdb - generated file will be placed near model definition
See examples for mode info.
Examples
See ./examples folder.
TODO
- tests
- tests with mysql in docker
- string field maxlen rule by annotation?
-
new flag allowed customising(WithTranmethod name.-rename-with-tran)
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrNoTranInContext = errors.New("no transaction in context")
Functions ¶
func Transaction ¶
func Transaction(ctx context.Context, db *sqlx.DB, ct CtxTransaction, f func(ctx context.Context) error) error
Transaction calls func in transaction. Rollbacks if function return error.
Example:
err := Transaction(ctx, ct, func(ctx context.Context) error {
m, err := ...
if err != nil {
return err
}
// other db operation
return ...
})
Special method for generated repositories.
Types ¶
type CtxTransaction ¶
type CtxTransaction interface {
TxFromContext(ctx context.Context) (*sqlx.Tx, error)
NewContextWithTx(ctx context.Context, tx *sqlx.Tx) (context.Context, error)
}
CtxTransaction defines ctx transaction interface which allow transfer *sqlx.Tx via context.Context.
type Option ¶
type Option func(ds *goqu.SelectDataset)
func WithFilter ¶ added in v0.10.1
func WithFilter(exp ...exp.Expression) Option
WithFilter option used to filter select.
func WithLockForUpdate ¶
func WithLockForUpdate() Option
WithLockForUpdate option must be used for read methods to lock for update.
func WithOrder ¶ added in v0.10.1
func WithOrder(order ...exp.OrderedExpression) Option
WithOrder option used to order select.
type RepositoryOpt ¶
type RepositoryOpt struct {
CtxTran CtxTransaction
}
type RepositoryOption ¶
type RepositoryOption func(o *RepositoryOpt)
func WithCtxTran ¶
func WithCtxTran(ct CtxTransaction) RepositoryOption
WithCtxTran option used to set custom transaction getter from context.
type StdCtxTran ¶
StdCtxTran implements CtxTransaction via sqlx.DB. Used as default for generated repository.
func (*StdCtxTran) NewContextWithTx ¶
func (*StdCtxTran) TxFromContext ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
Package examples contains examples.
|
Package examples contains examples. |