seed

README

👮‍♀️ Seed

Installation

$ go get github.com/zeiss/gorm-seed

Examples

See examples to understand the provided interfaces.

License

MIT

Documentation

Index

• type Database
  • func NewDatabase[R, W any](conn *gorm.DB, r ReadTxFactory[R], rw ReadWriteTxFactory[W]) (Database[R, W], error)
• type Migrator
• type Opt
  • func WithDatabase(db *gorm.DB) Opt
• type QueryError
  • func NewQueryError(query string, err error) *QueryError
  • func (e *QueryError) Error() string
  • func (e *QueryError) Unwrap() error
• type ReadTxFactory
• type ReadWriteTxFactory
• type Seed
• type SeedFunc
• type Seeder
  • func NewSeeder(db *gorm.DB, opts ...Opt) Seeder
• type Seeds
  • func (s Seeds) All() []Seed

Types

type Database

type Database[R, W any] interface {
	// ReadTx starts a read only transaction.
	ReadTx(context.Context, func(context.Context, R) error) error
	// ReadWriteTx starts a read write transaction.
	ReadWriteTx(context.Context, func(context.Context, W) error) error

	Migrator
	io.Closer
}

Database provides methods for transactional operations.

func NewDatabase

func NewDatabase[R, W any](conn *gorm.DB, r ReadTxFactory[R], rw ReadWriteTxFactory[W]) (Database[R, W], error)

NewDatabase returns a new instance of db.

type Migrator

type Migrator interface {
	// Migrate is a method that runs the migration.
	Migrate(context.Context, ...any) error
}

Migrator is a method that runs the migration.

type Opt

type Opt func(*seederImpl)

Opt is a function that configures the Seeder.

func WithDatabase

func WithDatabase(db *gorm.DB) Opt

WithDatabase sets the database for the Seeder.

type QueryError

type QueryError struct {
	// Query is the query that caused the error.
	Query string
	// Err is the error that occurred.
	Err error
}

QueryError is an error that occurred while executing a query.

func NewQueryError

func NewQueryError(query string, err error) *QueryError

NewQueryError returns a new QueryError.

func (*QueryError) Error

func (e *QueryError) Error() string

Error implements the error interface.

func (*QueryError) Unwrap

func (e *QueryError) Unwrap() error

Unwrap implements the errors.Wrapper interface.

type ReadTxFactory

type ReadTxFactory[R any] func(*gorm.DB) (R, error)

ReadTxFactory is a function that creates a new instance of Datastore.

type ReadWriteTxFactory

type ReadWriteTxFactory[W any] func(*gorm.DB) (W, error)

ReadWriteTxFactory is a function that creates a new instance of Datastore.

type Seed

type Seed struct {
	// Name is the name of the seed.
	Name string
	// Run is the function that seeds the data.
	Run SeedFunc
}

Seed is a struct that contains the data to be seeded.

type SeedFunc

type SeedFunc func(*gorm.DB) error

SeedFunc is a function that seeds data.

type Seeder

type Seeder interface {
	Seed(ctx context.Context, seeds ...Seed) error
}

Seeder is an interface for seeding data.

func NewSeeder

func NewSeeder(db *gorm.DB, opts ...Opt) Seeder

NewSeeder creates a new Seeder.

type Seeds

type Seeds []Seed

Seeds is a slice of Seed.

func (Seeds) All

func (s Seeds) All() []Seed

All returns all the seeds.