Skip to content
Unreleased: these pages follow the main branch. The latest release is v0.5.
Seed the database

Seed the database

Fill a database with sample data for development, or with the reference data every environment needs.

Before you start

Create your tables with migrations.

Steps

1. Write seeders

A seeder is a name and a function. Use the db package inside it:

// Seeders fill a development database with sample data: go run . db:seed
var Seeders = []migrate.Seeder{
	{Name: "authors", Run: func(ctx context.Context) error {
		return db.CreateMany(ctx, []Author{
			{Name: "Ada", Email: "[email protected]"},
			{Name: "Grace", Email: "[email protected]"},
		})
	}},
	{Name: "posts", Run: func(ctx context.Context) error {
		ada, err := db.Query[Author](ctx).Where(AuthorCols.Email.Eq("[email protected]")).First()
		if err != nil {
			return err
		}
		now := anetos.Now(ctx).UTC()
		return db.CreateMany(ctx, []Post{
			{AuthorID: ada.ID, Title: "Hello, Anetos", Body: "The first post.", PublishedAt: &now},
			{AuthorID: ada.ID, Title: "A draft", Body: "Not published yet."},
		})
	}},
}

(Copied from examples/database/migrations.go, region seeders.)

AuthorCols holds the model’s typed columns, written by anetos generate.

For many rows, use a factory, the same one the tests use:

// Seeders add sample notes: go run . db:seed
var Seeders = []migrate.Seeder{
	{Name: "notes", Run: func(ctx context.Context) error {
		_, err := NoteFactory.CreateMany(ctx, 25) // see factories.go
		return err
	}},
}

(Copied from examples/forms/models.go, region seeders.)

In a project made with anetos new, factories go in database/factories and seeders in database/migrations.

2. Give them to the runner

// illustrative
runner, err := migrate.New(app, []*migrate.Set{Migrations}, migrate.WithSeeders(Seeders...))

3. Run them

./app db:seed                 # every seeder, in order
./app db:seed --seeder=posts  # one of them
./app migrate:fresh --seed    # rebuild the database and seed it (development and testing only)

In production, db:seed needs --force.

How it works

Seeders run in the order they are listed, each in its own transaction: if one fails, its changes are rolled back and the ones before it stay. Order them so data exists before other data refers to it.

Coming from another framework? Seeders play the role of Django’s fixtures, Laravel’s seeders or Rails’ db/seeds.rb, and the list passed to the runner is the order they run in. Factories are values made with factory.New, as factory_boy, Laravel’s factories and FactoryBot make them.

Testing it

runner.Seed(ctx) in a test fills a fresh in-memory database, which is a quick way to test code against realistic data.

Common problems

SymptomCauseFix
no seeder named "users"Not in the list passed with WithSeedersAdd it
A seeder fails with a unique-constraint error on the second runSeeders insert again each timeUse db.Upsert, or check with Exists first

Next steps