Skip to content

Commit 6a62234

Browse files
ankur-archaidankmcalister
authored andcommitted
feat: add mentions of new Prisma Studio (#7270)
* feat: add mentions of new Prisma Studio * feat: add note for Studio for SQLite * Update content/100-getting-started/02-prisma-orm/100-quickstart/200-sqlite.mdx * Update content/100-getting-started/02-prisma-orm/200-add-to-existing-project/200-sqlite.mdx * fix: make prisma studio docs more accurate * fix: add missing punctuation
1 parent 3b12528 commit 6a62234

File tree

10 files changed

+159
-213
lines changed

10 files changed

+159
-213
lines changed

content/100-getting-started/02-prisma-orm/100-quickstart/200-sqlite.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,14 @@ You should see the created user and all users printed to the console!
266266

267267
<ExploreData />
268268

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

271279
<NextSteps />

content/100-getting-started/02-prisma-orm/100-quickstart/700-cockroachdb.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,9 +268,11 @@ npx tsx script.ts
268268

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

271-
## 9. Explore your data with Prisma Studio
271+
## 9. Explore your data
272272

273-
<ExploreData />
273+
Explore the options suggested by [CockroachDB](https://www.cockroachlabs.com/blog/cockroachdb-gui-options/) to view and manage your data.
274+
275+
[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.
274276

275277
## Next steps
276278

content/100-getting-started/02-prisma-orm/100-quickstart/800-mongodb.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,9 +276,11 @@ npx tsx script.ts
276276

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

279-
## 9. Explore your data with Prisma Studio
279+
## 9. Explore your data
280280

281-
<ExploreData />
281+
You can use [MongoDB Atlas](https://www.mongodb.com/cloud/atlas), the MongoDB shell, or MongoDB Compass to view and manage your data.
282+
283+
[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.
282284

283285
## Next steps
284286

content/100-getting-started/02-prisma-orm/200-add-to-existing-project/200-sqlite.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,15 @@ This command will:
249249

250250
<ExploreData />
251251

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

254263
<NextSteps />

content/100-getting-started/02-prisma-orm/200-add-to-existing-project/700-cockroachdb.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,11 @@ This command will:
246246
- Apply the migration to your database
247247
- Regenerate Prisma Client
248248

249-
## 10. Explore your data with Prisma Studio
249+
## 10. Explore your data
250250

251-
<ExploreData />
251+
Explore the options suggested by [CockroachDB](https://www.cockroachlabs.com/blog/cockroachdb-gui-options/) to view and manage your data.
252+
253+
[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.
252254

253255
## Next steps
254256

content/100-getting-started/02-prisma-orm/200-add-to-existing-project/800-mongodb.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -292,9 +292,11 @@ Prisma Migrate is not supported for MongoDB. Use `prisma db push` to sync your s
292292

293293
:::
294294

295-
## 9. Explore your data with Prisma Studio
295+
## 9. Explore your data
296296

297-
<ExploreData />
297+
You can use [MongoDB Atlas](https://www.mongodb.com/cloud/atlas), the MongoDB shell, or MongoDB Compass to view and manage your data.
298+
299+
[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.
298300

299301
## Next steps
300302

content/100-getting-started/_components/_explore-data.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,9 @@ npx prisma studio --config ./prisma.config.ts
55
```
66

77
This opens a web interface where you can view and edit your data.
8+
9+
:::info[Supported databases]
10+
11+
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).
12+
13+
:::

content/200-orm/400-tools/06-prisma-studio.mdx

Lines changed: 83 additions & 200 deletions
Large diffs are not rendered by default.

content/200-orm/500-reference/200-prisma-cli-reference.mdx

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1707,6 +1707,16 @@ Starts the [Prisma MCP server](/postgres/integrations/mcp-server).
17071707
17081708
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.
17091709

1710+
Prisma ORM v7 introduces a more stable version of Prisma Studio with improved performance and a modernized architecture.
1711+
1712+
:::info[Supported databases]
1713+
1714+
Prisma Studio currently supports PostgreSQL, MySQL, and SQLite. Support for CockroachDB and MongoDB is not available yet but may be added in future releases.
1715+
1716+
For detailed database support information, including SQLite requirements, see [Databases supported by Prisma Studio](/orm/tools/prisma-studio#databases-supported-by-prisma-studio).
1717+
1718+
:::
1719+
17101720
#### Prerequisites
17111721

17121722
Before using the `studio` command, you must configure your database connection in your `prisma.config.ts` file.
@@ -1742,11 +1752,13 @@ export default defineConfig({
17421752
17431753
The `studio` command recognizes the following options:
17441754
1745-
| Option | Required | Description | Default |
1746-
| ----------------- | -------- | ----------------------------------- | ------------------------ |
1747-
| `-b`, `--browser` | No | The browser to auto-open Studio in. | `<your-default-browser>` |
1748-
| `-h`, `--help` | No | Show all available options and exit | |
1749-
| `-p`, `--port` | No | The port number to start Studio on. | 5555 |
1755+
| Option | Required | Description | Default |
1756+
| ----------------- | -------- | -------------------------------------------------------------------------------- | ------------------------ |
1757+
| `-b`, `--browser` | No | The browser to auto-open Studio in. | `<your-default-browser>` |
1758+
| `-h`, `--help` | No | Show all available options and exit | |
1759+
| `-p`, `--port` | No | The port number to start Studio on. | 5555 |
1760+
| `--config` | No | Custom path to your Prisma config file | |
1761+
| `--url` | No | Database connection string (overrides the one in your Prisma config) | |
17501762
17511763
#### Arguments
17521764
@@ -1780,6 +1792,18 @@ prisma studio --browser firefox
17801792
prisma studio --browser none
17811793
```
17821794
1795+
#### Start Studio with a custom Prisma config file
1796+
1797+
```terminal
1798+
prisma studio --config=./prisma.config.ts
1799+
```
1800+
1801+
#### Start Studio with a direct database connection string
1802+
1803+
```terminal
1804+
prisma studio --url="postgresql://user:password@localhost:5432/dbname"
1805+
```
1806+
17831807
## `package.json` entry options
17841808
17851809
### `schema`

content/250-postgres/300-database/675-prisma-studio/50-studio-in-vs-code.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ toc: true
1010

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

13+
:::info[Supported databases]
14+
15+
Prisma Studio currently supports PostgreSQL, MySQL, and SQLite. Support for CockroachDB and MongoDB is not available yet but may be added in future releases.
16+
17+
For detailed database support information, including SQLite requirements, see [Databases supported by Prisma Studio](/orm/tools/prisma-studio#databases-supported-by-prisma-studio).
18+
19+
:::
20+
1321
## Usage
1422

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

0 commit comments

Comments
 (0)