Git Product home page Git Product logo

platformatic-prisma's Introduction

Platformatic Prisma

npm version

Remove the friction to create migrations for your Platformatic DB by generating them using a Prisma schema.

  • Use Prisma schema to manage your data models
  • Generate Platformatic DB compatible up and down migrations when changes are made to your Prisma schema
  • Migrations will be run by Platformatic DB

View the example project 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:

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

To run migrations, refer to Platformatic's documentation.

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

platformatic-prisma's People

Contributors

kgajera avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.