index.mdx

title	metaTitle	metaDescription
Prisma Documentation	Prisma Documentation (Concepts, Reference & Guides)	Welcome to the Prisma documentation! Get started with Prisma and connect it to your database, read about the main Prisma concepts and explore the API reference.

Overview

Welcome to the Prisma documentation! You can find an overview of the available content in the sections below.

If you're using Prisma 1, please refer to the Prisma 1 documentation.

The fastest way to get started with Prisma is the Quickstart. Alternatively you can read the Introduction to get a high-level overview of what Prisma is and how it works.

Quickstart (5 min) Prisma introduction

Table of contents

---

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)

---

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

Need help?

Prisma has a large and supportive community of enthusiastic application developers which is most active on Slack and on GitHub.

Ask a question about Prisma

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

Ask a question

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.

<ButtonLink color="dark" type="primary" href="https://github.com/prisma/prisma/issues/new?assignees=&labels=&template=bug_report.md&title="

Create bug report

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!

<ButtonLink color="dark" type="primary" href="https://github.com/prisma/prisma/issues/new?assignees=&labels=&template=feature_request.md&title="

Submit feature request