Seeding

Seeders fill the database with known rows for demos, local development, and tests. All seeders live in database/seeders.

Writing seeders

database/
  seeders/
    __init__.py
    database_seeder.py   # DatabaseSeeder — default entry point
    user_seeder.py

almasix new ships an empty DatabaseSeeder. Override run and call child seeders:

from almasix.orm import Seeder
from database.seeders.user_seeder import UserSeeder

class DatabaseSeeder(Seeder):
    async def run(self) -> None:
        await self.call([UserSeeder])
        # await self.call_once(UserSeeder)
        # await self.call_with(UserSeeder, {"count": 10})
        # await self.call_silent([UserSeeder])

from almasix.orm import Seeder


class UserSeeder(Seeder):
    async def run(self, count: int = 1) -> None:
        from app.models.user import User

        for i in range(count):
            await User.create(email=f"u{i}@example.com", name=f"User {i}")

call runs each seeder; call_once skips a class that already ran in this process; call_with passes keyword arguments into run; call_silent suppresses the console output for nested calls.

Seeding with factories

Writing rows out by hand gets old at the third one. A factory describes the row once and a seeder asks for as many as it wants, pinning only the columns that matter:

from almasix.orm import Seeder

from app.models.post import Post
from app.models.user import User


class DemoSeeder(Seeder):
    async def run(self) -> None:
        ada = await User.factory().create({"email": "[email protected]", "name": "Ada"})
        await Post.factory().count(3).for_(ada, "author").create()
        await User.factory().count(10).has(Post.factory().count(2), "posts").create()

Suppressing model events

from almasix.orm import Seeder, WithoutModelEvents

from app.models.user import User


class QuietSeeder(WithoutModelEvents, Seeder):
    async def run(self) -> None:
        await User.create(email="[email protected]", name="Quiet")

You may also wrap a block with without_model_events().

Running seeders

smith make:seeder UserSeeder
smith db:seed
smith db:seed --class UserSeeder
smith migrate --seed
smith migrate --seed --seeder UserSeeder
smith migrate:fresh --seed

--seeder implies seeding (you may omit --seed when --seeder is set). The default class is DatabaseSeeder.