Getting started

The Getting started section contains practical guides to help you get started with Prisma.

• Quickstart (5 min)
• Set up Prisma
  • Add Prisma to an existing project (15 min)
  • Start from scratch (SQL migrations) (15 min)
  • Start from scratch (Prisma Migrate) (15 min)

Understand Prisma

The Understand Prisma section contains conceptual information about Prisma.

• Introduction
• Why Prisma?
• Prisma in your stack
  • REST
  • GraphQL
  • Is Prisma an ORM?
• Data modeling
• Under the hood

Reference

The Reference section contains technical information about Prisma.

• Tools and interfaces
  • Prisma schema
    • Prisma schema file
    • Data sources
    • Generators
    • Data model
    • Models
    • Relations
  • Prisma Client
    • API reference
    • Generating Prisma Client
    • Configuring the Prisma Client API
    • CRUD
    • Relation queries
    • Field selection
    • Raw database access
    • Connection management
    • Advanced usage of generated types
    • Logging
    • Debugging
    • Error formatting
    • Transactions
    • Deployment
    • Query engine
    • Module bundlers
    • Database polyfills
  • Prisma Migrate
  • Introspection
  • Prisma CLI
    • Installation
    • Command reference
• Database connectors
  • Features
  • Connection URLs
  • PostgreSQL
  • MySQL
  • SQLite
• More
  • Editor setup
  • Telemetry

Guides

The Guides section contains step-by-step tutorials on various topics.

• Database workflows
  • Setting up a database
    • PostgreSQL
    • MySQL
    • SQLite
  • Import and export data
    • PostgreSQL
    • MySQL
    • SQLite
  • Unique constraints and indexes
    • PostgreSQL
    • MySQL
    • SQLite
  • Foreign keys
    • PostgreSQL
    • MySQL
    • SQLite
  • Cascading deletes
    • PostgreSQL
    • MySQL
    • SQLite
  • Data validation
    • PostgreSQL
    • MySQL (coming soon)
    • SQLite (coming soon)
• Deployment
  • Deploying to AWS Lambda
  • Deploying to ZEIT Now
  • Deploying to Netlify

More

The More section contains meta information about Prisma and the documentation itself.

• About the docs
• Prisma style guide
• Supported databases
• Creating bug reports
• FAQ
• Limitations
• Roadmap

Ask a question about Prisma

You can ask questions and initiate discussions about Prisma-related topics in the prisma repository on GitHub.

Create a bug report for Prisma

If you see an error message or run into an issue, please make sure to create a bug report! You can find best practices for creating bug reports (like including additional debugging output) in these docs.

Submit a feature request

If Prisma currently doesn't have a certain, be sure to check out the roadmap to see if this is already planned for the future.

If the feature on the roadmap is linked to a GitHub issue, please make sure to leave a +1 on the issue and ideally a comment with your thoughts about the feature!