How yowainwright/prisma-migrations works
Project type and purpose
• This is a Node.js library + CLI tool (“prisma-migrations”) that provides migration management on top of Prisma ORM, offering Knex-style up/down, rollback, dry-run, versioning, and git-commit–based migration control.
Core components (to be nodes
a. CLI Layer
• src/cli.ts – parses user commands (up, down, create, status, test) and dispatches to the MigrationManager API.
b. Configuration Layer
• ConfigManager (src/config.ts) – loads config from package.json, prisma-migrations.config.*, and environment.
c. File Management Layer
• FileManager (src/file-manager.ts) – reads/writes migration files, parses up/down sections.
• Fixtures/e2e directories (for testing) not in runtime.
d. Versioning & Commit Layer
• CommitManager (src/commit-manager.ts) – interacts with Git to get commits/branches.
• VersionManager (src/version-manager.ts) – maps semantic versions or commits to sets of migrations.
e. Migration Orchestration
• MigrationManager (src/migration-manager.ts) – core orchestrator: computes which migrations to run/rollback, calls FileManager, DatabaseAdapter, Prisma Client, updates migration table.
f. Database Adapter Layer
• DatabaseAdapter (src/database-adapter.ts) – connects to the database, creates/updates _prisma_migrations table, executes raw SQL.
g. Prisma Client
• External library – used by migration code (prisma.$executeRaw, seeding via client API).
h. Persistence
• External Postgres/MySQL/etc. database – holds both application schema and _prisma_migrations table.
Relationships & data‐flow
• User → CLI (rectangle “CLI Interface”)
• CLI → MigrationManager (invoke runMigrations, rollback, createMigration)
• MigrationManager ↔ ConfigManager (load settings)
• MigrationManager ↔ FileManager (read migration files, generate new files)
• MigrationManager ↔ VersionManager (compute version‐based plan)
• VersionManager ↔ CommitManager (map commit SHA → migration list)
• MigrationManager ↔ DatabaseAdapter (fetch applied migrations, record/remove migration entries)
• DatabaseAdapter ↔ Prisma Client (execute raw SQL, seed data)
• Prisma Client ↔ Database (actual migration and seeding operations)
Architectural patterns & design principles
• Separation of Concerns: distinct modules for CLI, config, file I/O, versioning, Git integration, DB operations.
• Command/Strategy Pattern: each CLI command funnels into strategy methods on MigrationManager.
• Adapter Pattern: DatabaseAdapter abstracts underlying DB for executing and tracking migrations.
• Plugin-like extensibility: ConfigManager / FileManager allow custom directories/formats.