# yowainwright/prisma-migrations architecture

> Architecture diagram of the GitHub repository yowainwright/prisma-migrations, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yowainwright/prisma-migrations
- Repository: https://github.com/yowainwright/prisma-migrations

## Overview

##### 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.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Internal Modules
    subgraph "Programmatic Usage"
        ProgrammaticAPI["Programmatic API"]:::internal
    end

    subgraph "CLI Layer"
        CLI["CLI Interface"]:::internal
    end

    subgraph "Core Managers"
        MigrationManager["MigrationManager"]:::internal
        ConfigManager["ConfigManager"]:::internal
        FileManager["FileManager"]:::internal
        VersionManager["VersionManager"]:::internal
        CommitManager["CommitManager"]:::internal
    end

    subgraph "Database Layer"
        DatabaseAdapter["DatabaseAdapter"]:::internal
    end

    %% External Dependencies
    subgraph "External Services"
        PrismaClient["Prisma Client"]:::external
        Git["Git"]:::external
        DB[(Database)]:::database
    end

    %% Connections
    ProgrammaticAPI -->|"new MigrationManager()"| MigrationManager
    CLI -->|"runCommand()"| MigrationManager
    MigrationManager -->|"loadConfig()"| ConfigManager
    MigrationManager -->|"getMigrationFiles()"| FileManager
    MigrationManager -->|"computePlan()"| VersionManager
    VersionManager -->|"mapCommits()"| CommitManager
    CommitManager -->|"git info"| Git
    MigrationManager -->|"fetchApplied()/recordMigration()"| DatabaseAdapter
    DatabaseAdapter -->|"executeRaw()"| PrismaClient
    PrismaClient -->|"SQL queries"| DB

    %% Click Events
    click CLI "https://github.com/yowainwright/prisma-migrations/blob/main/src/cli.ts"
    click ConfigManager "https://github.com/yowainwright/prisma-migrations/blob/main/src/config.ts"
    click FileManager "https://github.com/yowainwright/prisma-migrations/blob/main/src/file-manager.ts"
    click CommitManager "https://github.com/yowainwright/prisma-migrations/blob/main/src/commit-manager.ts"
    click VersionManager "https://github.com/yowainwright/prisma-migrations/blob/main/src/version-manager.ts"
    click MigrationManager "https://github.com/yowainwright/prisma-migrations/blob/main/src/migration-manager.ts"
    click DatabaseAdapter "https://github.com/yowainwright/prisma-migrations/blob/main/src/database-adapter.ts"
    click ProgrammaticAPI "https://github.com/yowainwright/prisma-migrations/blob/main/src/index.ts"

    %% Styles
    classDef internal fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef external fill:#90EE90,stroke:#333,stroke-width:1px
    classDef database fill:#D3D3D3,stroke:#333,stroke-width:1px
```
