grove

Oct 20, 2026

Changes in this version

type Option

+ func WithCollectionLabel(fn func(collection string) string) Option

+ func WithCollectionLabelLimit(n int) Option

Oct 16, 2026

Changes in this version

type Option

+ func WithMetrics(m gometrics.Metrics) Option

Aug 3, 2026

Changes in this version

+ var ErrCyclicDependency = errors.New("grove: cyclic dependency in migration groups")

+ var ErrDriverClosed = errors.New("grove: driver connection pool has been closed")

+ var ErrDuplicateVersion = errors.New("grove: duplicate migration version")

+ var ErrHookDenied = errors.New("grove: hook denied the operation")

+ var ErrHookPanic = errors.New("grove: hook panicked during execution")

+ var ErrInvalidDSN = errors.New("grove: invalid data source name")

+ var ErrInvalidRelation = errors.New("grove: invalid relation definition")

+ var ErrInvalidTag = errors.New("grove: invalid struct tag syntax")

+ var ErrMigrationFailed = errors.New("grove: migration failed")

+ var ErrMigrationLocked = errors.New("grove: migration lock held by another process")

+ var ErrModelNotRegistered = errors.New("grove: model not registered")

+ var ErrNoPrimaryKey = errors.New("grove: model has no primary key field")

+ var ErrNoRows = errors.New("grove: no rows in result set")

+ var ErrNotSupported = errors.New("grove: operation not supported by driver")

+ var ErrTxDone = errors.New("grove: transaction has already been committed or rolled back")

+ func Drivers() []string

+ func RegisterDriver(name string, factory DriverFactory)

+ type BaseModel struct

+ type DB struct

+ func Open(drv GroveDriver, opts ...Option) (*DB, error)

+ func (db *DB) BeginTx(ctx context.Context, opts *TxOptions) (*Tx, error)

+ func (db *DB) Close() error

+ func (db *DB) Driver() GroveDriver

+ func (db *DB) Hooks() *hook.Engine

+ func (db *DB) NewDelete(model any) any

+ func (db *DB) NewInsert(model any) any

+ func (db *DB) NewSelect(model ...any) any

+ func (db *DB) NewUpdate(model any) any

+ func (db *DB) Ping(ctx context.Context) error

+ func (db *DB) RegisterModel(models ...any)

+ type DriverFactory func(ctx context.Context, dsn string) (GroveDriver, error)

+ type GroveDriver interface

+ Close func() error

+ Name func() string

+ Ping func(ctx context.Context) error

+ func OpenDriver(ctx context.Context, name, dsn string) (GroveDriver, error)

+ type ModelRegistry interface

+ Get func(model any) any

+ Register func(model any) (any, error)

+ type Option func(*options)

+ func WithLogger(l log.Logger) Option

+ func WithPoolSize(n int) Option

+ func WithQueryTimeout(d time.Duration) Option

+ type Tx struct

+ func (tx *Tx) Commit() error

+ func (tx *Tx) Raw() any

+ func (tx *Tx) Rollback() error

+ type TxOptions struct

+ IsolationLevel int

+ ReadOnly bool