Tutorials
Setup Prisma
Demo Server
Create New DB
MySQL
Postgres
Connect Empty DB
MySQL
Postgres
Connect DB with Data
MySQL
Postgres
Build GraphQL Servers
Development
Build a GraphQL Server with Prisma
Build a GraphQL Server from Scratch
Build a Realtime GraphQL Server with Subscriptions
Deployment
Deployment with Now
Deployment with Up
Access Prisma from Scripts
Access Prisma from a Node script using Prisma Bindings
Connect to Prisma from the frontend
Bootstrapping Boilerplates
Reference
Service Configuration
Overview
Data Model
Data Modelling (SDL)
Migrations
Introspection
Server-side Subscriptions
Prisma Servers & DBs
Prisma Servers
OverviewDocker
Database Connectors
OverviewMySQLPostgres
Prisma Bindings
OverviewAPI
Code generation
Upgrade Guides
Upgrading Prisma
Overview
Upgrade to 1.7
Upgrade to 1.8

Overview

Last updated a day ago Edit this page

#What is the Prisma API?

A Prisma service exposes a GraphQL API that is automatically generated based on the deployed data model. It is also referred to as the Prisma API. The Prisma API defines CRUD operations for the types in the data model and allows to get realtime updates when events are happening in the database (e.g. new nodes are created or existing ones updated or deleted).

The Prisma API is defined by a corresponding GraphQL schema, called Prisma database schema.

#Exploring the Prisma API

The GraphQL Playground is the best tool to explore the Prisma API and get to know it better. You can use it to run GraphQL mutations, queries and subscriptions.

To open up a Playground for your database service, simply run the prisma playground command in the working directory of your service or paste your service's HTTP endpoint into the address bar of your browser.

Was this page helpful?