nabladev/prisma2

Database framework enabling type-safe data access, schema migrations and development workflows

Prisma Framework

This repository is used as a central point to collect information and issues around the Prisma Framework (formerly called Prisma 2) while it's in Preview. It also contains the documentation and the code of the Prisma 2 CLI.

💡 The Prisma Framework is currently in Preview! Limitations include missing features, limited performance and stability issues. You can track the progress of the Prisma Framework on isprisma2ready.com.

To get started, you can explore a number of ready-to-run examples or follow the holistic tutorial. The example projects include use cases such as building GraphQL, REST or gRPC APIs (with Node.js or TypeScript) using the Prisma Framework.

What is the Prisma Framework?

The Prisma Framework (formerly called Prisma 2) is an application data framework that consists of these tools:

• Photon: Type-safe and auto-generated database client ("ORM replacement")
• Lift: Declarative data modeling and migrations
• Studio: Admin UI to support various database workflows

While each tool can be used standalone (in both greenfield and brownfield projects), they integrate nicely through common components like the Prisma schema or the Prisma Framework CLI.

Getting started

The easiest way to get started with Photon and/or Lift is by using the init command of the prisma2 CLI via npx:

npx prisma2 init hello-prisma

Alternatively, you can install the prisma2 CLI globally and run the init command then:

npm install -g prisma2
prisma2 init hello-prisma

The interactive prompt will ask you to provide database credentials for your database. If you don't have a database yet, select SQLite and let the CLI set up a database file for you.

Contents

• Getting started
• Tutorial
• Prisma schema file
• Data sources
• Data modeling
• Relations
• Prisma 2 CLI
• Development mode
• Introspection
• Limitations
• Core
  • Connectors
    • MySQL
    • PostgreSQL
    • SQLite
    • MongoDB
  • Generators
    • Photon.js
• Photon
  • API
  • Use only Photon
  • Code generation & Node.js setup
  • Deployment
• Lift
  • Steps
  • Migration files
  • Use only Lift
• Supported databases
• Telemetry
• How to provide feedback for Prisma 2?
• Release process
• FAQ
• Glossary