DB Migrations

Create a database migration with Drizzle on a fresh Neon branch. Use when changing the packages/db schema or generating migrations.

superset-sh Updated

File contents

DB migrations

  • Always spin up a new neon branch to create migrations. Update our root .env files to point at the neon branch locally.
  • Use drizzle to manage the migration. You can see the schema at packages/db/src/schema. Never run a migration yourself.
  • Create migrations by changing drizzle schema then running bunx drizzle-kit generate --name="<sample_name_snake_case>"
  • NEON_ORG_ID and NEON_PROJECT_ID env vars are set in .env
  • list_projects tool requires org_id passed in
  • NEVER manually edit files in packages/db/drizzle/ - this includes .sql migration files, meta/_journal.json, and snapshot files. These are auto-generated by Drizzle. If you need to create a migration, only modify the schema files in packages/db/src/schema/ and ask the user to run drizzle-kit generate.

Source: superset-sh/superset.agents/skills/db-migrations/SKILL.md

superset-sh/superset commit 243d027827

Frequently asked questions

npx skillmds@latest add superset-sh/db-migrations