seeder

Documentation

Overview

Package seeder runs database seeders with dependency ordering and transactional execution. A Seeder is any type that implements Seeder; the Runner topologically sorts the registered seeders and runs them in turn.

Index

• Variables
• func Register(s Seeder)
• type Dependent
• type FuncSeeder
  • func (f *FuncSeeder) Dependencies() []string
  • func (f *FuncSeeder) Name() string
  • func (f *FuncSeeder) Run(ctx context.Context, c *database.Connection) error
• type Options
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) Get(name string) (Seeder, bool)
  • func (r *Registry) Names() []string
  • func (r *Registry) Register(s Seeder)
  • func (r *Registry) Sorted() ([]Seeder, error)
• type Runner
  • func NewRunner(conn *database.Connection, registry *Registry, opts Options) *Runner
  • func (r *Runner) Run(ctx context.Context) error
• type Seeder
  • func Define(name string, deps []string, ...) Seeder

Variables

var Default = NewRegistry()

Default is the process-wide registry.

Functions

func Register

func Register(s Seeder)

Register is a package-level helper for Default.

Types

type Dependent

type Dependent interface {
	Dependencies() []string
}

Dependent is an optional interface for declaring dependencies. Seeders without Dependencies are ordered by registration order.

type FuncSeeder

type FuncSeeder struct {
	N    string
	Deps []string
	Fn   func(ctx context.Context, conn *database.Connection) error
}

FuncSeeder adapts a function to the Seeder interface.

func (*FuncSeeder) Dependencies

func (f *FuncSeeder) Dependencies() []string

func (*FuncSeeder) Name

func (f *FuncSeeder) Name() string

func (*FuncSeeder) Run

func (f *FuncSeeder) Run(ctx context.Context, c *database.Connection) error

type Options

type Options struct {
	// Transactional wraps each seeder run in a transaction.
	Transactional bool
	// Logger receives status messages.
	Logger *logger.Logger
	// Only restricts the run to the named seeders (and their deps).
	Only []string
}

Options configures Runner behavior.

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

Registry stores seeders.

func NewRegistry

func NewRegistry() *Registry

NewRegistry creates an empty registry.

func (*Registry) Get

func (r *Registry) Get(name string) (Seeder, bool)

Get returns a seeder by name.

func (*Registry) Names

func (r *Registry) Names() []string

Names returns registration order.

func (*Registry) Register

func (r *Registry) Register(s Seeder)

Register adds a seeder. Panics on duplicate.

func (*Registry) Sorted

func (r *Registry) Sorted() ([]Seeder, error)

Sorted returns seeders in dependency order. Cycles return an error.

type Runner

type Runner struct {
	Conn     *database.Connection
	Registry *Registry
	Opts     Options
}

Runner executes seeders.

func NewRunner

func NewRunner(conn *database.Connection, registry *Registry, opts Options) *Runner

NewRunner builds a Runner. registry may be nil to use Default.

func (*Runner) Run

func (r *Runner) Run(ctx context.Context) error

Run executes all (or selected) seeders.

type Seeder

type Seeder interface {
	Name() string
	Run(ctx context.Context, conn *database.Connection) error
}

Seeder defines the contract for a seeder. Name uniquely identifies the seeder; Dependencies declares names this seeder requires to run first.

func Define

func Define(name string, deps []string, fn func(ctx context.Context, conn *database.Connection) error) Seeder

Define builds an inline FuncSeeder.