Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kgajera/platformatic-prisma
Generate migrations for your Platformatic DB using a Prisma schema
https://github.com/kgajera/platformatic-prisma
platformatic prisma
Last synced: 12 days ago
JSON representation
Generate migrations for your Platformatic DB using a Prisma schema
- Host: GitHub
- URL: https://github.com/kgajera/platformatic-prisma
- Owner: kgajera
- License: mit
- Created: 2022-11-12T04:12:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-26T00:39:41.000Z (10 months ago)
- Last Synced: 2024-11-01T12:35:51.753Z (19 days ago)
- Topics: platformatic, prisma
- Language: JavaScript
- Homepage:
- Size: 1.11 MB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Platformatic Prisma
[](https://www.npmjs.com/package/platformatic-prisma)
Remove the friction to create migrations for your [Platformatic DB](https://oss.platformatic.dev/docs/reference/db/introduction) by generating them using a [Prisma schema](https://www.prisma.io/docs/concepts/components/prisma-schema).
- Use Prisma schema to manage your data models
- Generate Platformatic DB compatible up and down [migrations](https://oss.platformatic.dev/docs/reference/db/migrations) when changes are made to your Prisma schema
- Migrations will be [run](https://oss.platformatic.dev/docs/reference/db/migrations#how-to-run-migrations) by Platformatic DB
View the [example project](./example) to see it in action.
## Getting Started
Install `platformatic-prisma` and `prisma`:
```
npm install prisma platformatic-prisma -D
```
Create a `./prisma/schema.prisma` file with the following contents:
```prisma
datasource db {
// Any provider supported by Platformatic
// https://oss.platformatic.dev/docs/reference/db/introduction#supported-databases
provider = "postgresql"
url = env("DATABASE_URL")
}
// Table used by Platformatic/Postgrator to manage migrations
model Version {
version BigInt @id
name String?
md5 String?
run_at DateTime? @db.Timestamptz(6)
@@map("versions")
@@ignore
}
```
Create an [`.env` file](https://www.prisma.io/docs/guides/development-environment/environment-variables#using-env-files) containing the database connection URL to connect to your database:
```
DATABASE_URL="postgresql://postgres:@localhost:5432/platformatic-prisma?schema=public"
```
## Generating Migrations
> **Note**
> If you are just starting with a new Platformatic DB project, run `npx platformatic db migrate` before generating your first migration. This is needed to allow Platformatic DB to initialize the database with it's migrations table.
When changes are made to your `schema.prisma` file, run `npx platformatic-prisma` to generate migrations. This will generate up and down migration files in the migrations directory that is specified in your Platformatic [configuration file](https://oss.platformatic.dev/docs/reference/db/configuration#configuration-file).
To run migrations, refer to [Platformatic's documentation](https://oss.platformatic.dev/docs/reference/db/migrations).
### Options
| Option | Required | Description | Default |
| --------------- | -------- | ----------------------------------------------------------------- | ---------------------- |
| `--description` | No | Label to include in migration filename. Must not contain periods. | |
| `--no-down` | No | Prevents generation of the down migration file. | `false` |
| `--no-up` | No | Prevents generation of the up migration file. | `false` |
| `--schema` | No | Specifies the path to the `schema.prisma` file. | `prisma/schema.prisma` |