Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,14 @@ You should see the created user and all users printed to the console!

<ExploreData />

:::note[SQLite requirements for Prisma Studio]
- File paths must have a `file:` protocol right now in the database url for SQLite
- Node.js 22.5+: Works out of the box with the built-in `node:sqlite` module
- Node.js 20: Requires installing `better-sqlite3` as a dependency
- If using pnpm 10+, you'll also need to allow the `better-sqlite3` install script

:::

## Next steps

<NextSteps />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -268,9 +268,11 @@ npx tsx script.ts

You should see the created user and all users printed to the console!

## 9. Explore your data with Prisma Studio
## 9. Explore your data

<ExploreData />
Explore the options suggested by [CockroachDB](https://www.cockroachlabs.com/blog/cockroachdb-gui-options/) to view and manage your data.

[Prisma Studio](/orm/tools/prisma-studio) does not currently support CockroachDB. Support may be added in a future release. See [Databases supported by Prisma Studio](/orm/tools/prisma-studio#databases-supported-by-prisma-studio) for more information.

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,9 +276,11 @@ npx tsx script.ts

You should see the created user and all users printed to the console!

## 9. Explore your data with Prisma Studio
## 9. Explore your data

<ExploreData />
You can use [MongoDB Atlas](https://www.mongodb.com/cloud/atlas), the MongoDB shell, or MongoDB Compass to view and manage your data.

[Prisma Studio](/orm/tools/prisma-studio) does not currently support MongoDB. Support may be added in a future release. See [Databases supported by Prisma Studio](/orm/tools/prisma-studio#databases-supported-by-prisma-studio) for more information.

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,15 @@ This command will:

<ExploreData />

:::note[SQLite requirements for Prisma Studio]

- File paths must have a `file:` protocol right now in the database url for SQLite
- Node.js 22.5+: Works out of the box with the built-in `node:sqlite` module
- Node.js 20: Requires installing `better-sqlite3` as a dependency
- If using pnpm 10+, you'll also need to allow the `better-sqlite3` install script

:::

## Next steps

<NextSteps />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,9 +246,11 @@ This command will:
- Apply the migration to your database
- Regenerate Prisma Client

## 10. Explore your data with Prisma Studio
## 10. Explore your data

<ExploreData />
Explore the options suggested by [CockroachDB](https://www.cockroachlabs.com/blog/cockroachdb-gui-options/) to view and manage your data.

[Prisma Studio](/orm/tools/prisma-studio) does not currently support CockroachDB. Support may be added in a future release. See [Databases supported by Prisma Studio](/orm/tools/prisma-studio#databases-supported-by-prisma-studio) for more information.

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -292,9 +292,11 @@ Prisma Migrate is not supported for MongoDB. Use `prisma db push` to sync your s

:::

## 9. Explore your data with Prisma Studio
## 9. Explore your data

<ExploreData />
You can use [MongoDB Atlas](https://www.mongodb.com/cloud/atlas), the MongoDB shell, or MongoDB Compass to view and manage your data.

[Prisma Studio](/orm/tools/prisma-studio) does not currently support MongoDB. Support may be added in a future release. See [Databases supported by Prisma Studio](/orm/tools/prisma-studio#databases-supported-by-prisma-studio) for more information.

## Next steps

Expand Down
6 changes: 6 additions & 0 deletions content/100-getting-started/_components/_explore-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@ npx prisma studio --config ./prisma.config.ts
```

This opens a web interface where you can view and edit your data.

:::info[Supported databases]

Prisma Studio currently supports PostgreSQL, MySQL, and SQLite. For more details, see [Databases supported by Prisma Studio](/orm/tools/prisma-studio#databases-supported-by-prisma-studio).

:::
283 changes: 83 additions & 200 deletions content/200-orm/400-tools/06-prisma-studio.mdx

Large diffs are not rendered by default.

34 changes: 29 additions & 5 deletions content/200-orm/500-reference/200-prisma-cli-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1707,6 +1707,16 @@ Starts the [Prisma MCP server](/postgres/integrations/mcp-server).

The `studio` command allows you to interact with and manage your data interactively. It does this by starting a local web server with a web app configured with your project's data schema and records.

Prisma ORM v7 introduces a more stable version of Prisma Studio with improved performance and a modernized architecture.

:::info[Supported databases]

Prisma Studio currently supports PostgreSQL, MySQL, and SQLite. Support for CockroachDB and MongoDB is not available yet but may be added in future releases.

For detailed database support information, including SQLite requirements, see [Databases supported by Prisma Studio](/orm/tools/prisma-studio#databases-supported-by-prisma-studio).

:::

#### Prerequisites

Before using the `studio` command, you must configure your database connection in your `prisma.config.ts` file.
Expand Down Expand Up @@ -1742,11 +1752,13 @@ export default defineConfig({

The `studio` command recognizes the following options:

| Option | Required | Description | Default |
| ----------------- | -------- | ----------------------------------- | ------------------------ |
| `-b`, `--browser` | No | The browser to auto-open Studio in. | `<your-default-browser>` |
| `-h`, `--help` | No | Show all available options and exit | |
| `-p`, `--port` | No | The port number to start Studio on. | 5555 |
| Option | Required | Description | Default |
| ----------------- | -------- | -------------------------------------------------------------------------------- | ------------------------ |
| `-b`, `--browser` | No | The browser to auto-open Studio in. | `<your-default-browser>` |
| `-h`, `--help` | No | Show all available options and exit | |
| `-p`, `--port` | No | The port number to start Studio on. | 5555 |
| `--config` | No | Custom path to your Prisma config file | |
| `--url` | No | Database connection string (overrides the one in your Prisma config) | |

#### Arguments

Expand Down Expand Up @@ -1780,6 +1792,18 @@ prisma studio --browser firefox
prisma studio --browser none
```

#### Start Studio with a custom Prisma config file

```terminal
prisma studio --config=./prisma.config.ts
```

#### Start Studio with a direct database connection string

```terminal
prisma studio --url="postgresql://user:password@localhost:5432/dbname"
```

## `package.json` entry options

### `schema`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ toc: true

You can use Prisma Studio directly in VS Code via the [Prisma VS Code extension](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma).

:::info[Supported databases]

Prisma Studio currently supports PostgreSQL, MySQL, and SQLite. Support for CockroachDB and MongoDB is not available yet but may be added in future releases.

For detailed database support information, including SQLite requirements, see [Databases supported by Prisma Studio](/orm/tools/prisma-studio#databases-supported-by-prisma-studio).

:::

## Usage

1. Install the [Prisma VS Code extension](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma)
Expand Down
Loading