studio  by prisma

Database GUI and embeddable data editor

Created 6 years ago
2,194 stars

Top 20.1% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

Prisma Studio offers a visual interface for Prisma ORM users to explore, query, and manipulate database data directly within projects. It simplifies data management tasks, providing a user-friendly alternative to command-line or raw SQL interfaces and integrating seamlessly into existing applications.

How It Works

The core is the embeddable @prisma/studio-core React component. It uses data adapters (e.g., createPostgresAdapter) and a Backend-for-Frontend (BFF) client to communicate via a JSON-over-HTTP contract. This enables browsing, editing, filtering, and SQL execution. Optional AI features for SQL generation, filtering, and visualization are supported via an LLM transport hook.

Quick Start & Requirements

  • Usage: Existing Prisma projects: npx prisma studio.
  • Local Dev: Clone repo, pnpm install, pnpm demo:ppg. Access demo at http://localhost:4310.
  • Prerequisites: Node.js (^20.19 || ^22.12 || >=24.0), pnpm 8.
  • AI Demo: Set ANTHROPIC_API_KEY in .env.
  • Docs: Issues/requests at github.com/prisma/studio/issues.

Highlighted Details

  • Embeddable UI: @prisma/studio-core is a React component for host application integration.
  • AI-Powered Features: Optional AI assistance for SQL generation, filtering, and visualization.
  • BFF Contract: Defines a JSON-over-HTTP API supporting query, sequence, transaction, and sql-lint procedures.
  • Atomic Transactions: Enables safe, multi-row data updates.
  • SQL Linting: Provides real-time diagnostics for SQL queries.

Maintenance & Community

This repo is the OSS home for @prisma/studio-core. Report bugs/features via GitHub Issues. Discuss on the Prisma Discord. Security issues to security@prisma.io. Issue-first contributions are encouraged.

Licensing & Compatibility

The specific open-source license is not explicitly stated in the README. Prisma projects are typically MIT licensed. Its embeddable nature allows integration into various host applications meeting Node.js/React requirements.

Limitations & Caveats

@prisma/studio-core is an embeddable React surface, not a standalone app shell; the host must provide UI and routing. AI features require a configured LLM transport hook. A Backend-for-Frontend (BFF) is necessary for database interactions and serving Studio.

Health Check
Last Commit

3 days ago

Responsiveness

Inactive

Pull Requests (30d)
19
Issues (30d)
12
Star History
16 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.