https://github.com/hyperjumptech/prisma-migration-checker
CLI tool to check if new Prisma migrations can be applied safely to the database
https://github.com/hyperjumptech/prisma-migration-checker
Last synced: 8 months ago
JSON representation
CLI tool to check if new Prisma migrations can be applied safely to the database
- Host: GitHub
- URL: https://github.com/hyperjumptech/prisma-migration-checker
- Owner: hyperjumptech
- License: mit
- Created: 2022-11-18T08:02:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-04T21:58:17.000Z (about 3 years ago)
- Last Synced: 2025-03-13T10:17:15.018Z (about 1 year ago)
- Language: TypeScript
- Size: 20.5 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Prisma Migration Checker
## About
Prisma Migration Checker is a CLI tool to check if new Prisma migrations can be applied safely to the database.
## Motivation
When you use Prisma in your web app, you might have encountered [failed migrations](https://www.prisma.io/docs/guides/database/production-troubleshooting#failed-migration) when deploying the migrations to the production database. While Prisma has documented the methods to fix this issue, it's not easy and straightforward.
It'd have much better if you can check if the new migrations will succeed **before** actually deploying the migrations, say in your CI/CD pipeline. This is where Prisma Migration Checker comes to play.
# Installation
Prisma Migration Checker is developed using Node.js and TypeScript. So you can install it from the NPM as follows
```
npm install -g @hyperjumptech/prisma-migration-checker
```
# Usage
## Directly
You need to provide two schema files which are the schema file with the new migrations and another schema file without the new migrations.
```
prisma-migration-checker --new --current
```
Note that before running Prisma Migration Checker, you need to:
- have the database used in your prisma.schema running (Postgres, MongoDB, SQLite, etc).
## In CI Pipeline
To check if a schema.prisma file that was changed in a pull request, you can checkout first the schema.prisma from the main branch before running Prisma Migration Checker in your CI pipeline.
```
git show main:prisma/schema.prisma > prisma/schema-main.prisma
prisma-migration-checker --new prisma/schema.prisma --current prisma/schema-main.prisma
```
# Development
clone the repo.
if you want to use `prisma-seeder` locally, you can build it by running `npm pack --pack-destination ~` in the `prisma-seeder` directory.
Then find the generated file on `~/hyperjumptech-prisma-seeder-0.0.3.tgz` (version is defined in package.json). Then update your `package.json > dependences`
```
"dependencies": {
...
"@hyperjumptch/prisma-seeder": "file:~/hyperjumptech-prisma-seeder-0.0.3.tgz",
...
}
```
then install dependencies using
```
npm install
```
then run this to start the package
```
./bin/dev --new --current --database-url
```
# How It Works
1. Prisma Migration Checker will apply the current migrations to the database.
2. It will then populate the database with fake data.
3. Finally it will apply the new migrations from the new schema file.
# License
MIT