ContextQMD
Back to Prisma

Getting Started

apps/docs/content/docs/studio/getting-started.mdx

latest2.0 KB
Original Source

Installation

Prisma Studio comes bundled with the Prisma CLI. To get started, make sure you have Node.js installed, then install the Prisma CLI:

npm
npm install -g prisma

Launching Studio

With a Prisma Project

If you have an existing Prisma project, navigate to your project directory and run:

npm
npx prisma studio

This will start the Studio server and open it in your default browser at http://localhost:5555.

Without a Prisma Project

You can also use Studio with any database by providing a connection string:

npm
npx prisma studio --url="postgresql://user:password@localhost:5432/yourdb"

Connecting to Your Database

  1. Using environment variables: Create a .env file in your project root with your database URL:

    DATABASE_URL="postgresql://user:password@localhost:5432/yourdb"

    Then run: npx prisma studio

  2. Using command line:

    bash
    npx prisma studio --url="your-database-connection-string"

Basic Usage

Browsing Data

  • The left sidebar lists all your database tables
  • Click on a table to view its data
  • Use the search bar to quickly find tables or columns

Editing Data

  • Edit cells: Double-click any cell to edit its value
  • Add records: Click the "+" button to add a new record
  • Delete records: Select records using checkboxes and click the trash icon

Filtering and Sorting

  • Click the filter icon to add filters
  • Click on column headers to sort the table
  • Use the search box to filter records by any field

Common Tasks

Viewing Table Relationships

  • Related tables are shown as expandable rows
  • Click the "+" icon to view related records

Exporting Data

  • Use the export button to download data as CSV or JSON
  • Select specific columns to include in the export

Next Steps