docs(prisma-postgres): clarify local vs managed Prisma init commands #7436
Conversation
Added instructions for initializing Prisma with managed Postgres database.
WalkthroughThis documentation change restructures the Prisma PostgreSQL quickstart initialization instructions to clearly distinguish between two setup paths: local self-managed Postgres configuration using Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (1)📚 Learning: 2026-01-06T22:06:57.725ZApplied to files:
🔇 Additional comments (1)
✏️ Tip: You can disable this entire section by setting Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
content/100-getting-started/02-prisma-orm/100-quickstart/100-prisma-postgres.mdx (3)
69-87: Section title and content flow need alignment.There's a mismatch here that could confuse readers:
The section title says "Initialize Prisma ORM and create a Prisma Postgres database" but only the
--dbvariant actually creates a managed database. Consider updating the title to something like "Initialize Prisma ORM" or splitting into two distinct subsections.This is the Prisma Postgres quickstart, so leading with the local/self-managed path feels counterintuitive. Users landing here likely want the managed Prisma Postgres experience. Consider swapping the order—show the
--dbcommand first as the recommended path for this guide, then mention the local alternative.The phrasing "you manage Postgres yourself" on line 77 is slightly ambiguous—it could mean an existing local Postgres instance or a cloud-hosted one you provision manually. A small clarification like "(e.g., a local or existing PostgreSQL instance)" would help.
📝 Suggested restructure
## 4. Initialize Prisma ORM and create a Prisma Postgres database You can now invoke the Prisma CLI by prefixing it with `npx`: ```terminal npx prisma-Initialize Prisma locally (you manage Postgres yourself):
+To provision a managed Prisma Postgres database (handles login + database creation for you), run:-npx prisma init +npx prisma init --db --output ../generated/prisma-If you want Prisma to provision a managed Prisma Postgres database (online login + database creation), use:
+Alternatively, if you already have your own PostgreSQL instance (local or cloud-hosted), initialize without the--dbflag:-npx prisma init --db --output ../generated/prisma +npx prisma init</details> --- `89-100`: **Info block and bullet list apply only to the `--db` path.** The info block about "answering a few questions" and the bullet point "Creates a new Prisma Postgres database (when using `--db` flag)" only apply to the managed setup. However, positioned after both commands, readers following the local path might be confused when no prompts appear. Consider either: - Moving the info block directly under the `--db` command block, or - Adding a note clarifying that users who ran `npx prisma init` (without `--db`) can skip to the next step since no interactive prompts or database provisioning occurs. --- `102-130`: **Generated config examples assume the `--db --output` path.** The `prisma.config.ts` and `schema.prisma` examples show `output = "../generated/prisma"`, which is only generated when using `--db --output ../generated/prisma`. Users who run plain `npx prisma init` will see different defaults (no custom output path, and the Prisma Client would be generated to `node_modules/.prisma/client` by default in the classic generator, or would need manual configuration for the new `prisma-client` generator). For users on the local path, the subsequent steps (like `import { PrismaClient } from '../generated/prisma/client'` on line 188) won't work out of the box. You should either: 1. Note that users on the local path need to manually add the `output` directive, or 2. Explicitly state this guide's remaining steps assume the managed `--db` path was used. </blockquote></details> </blockquote></details>📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/100-getting-started/02-prisma-orm/100-quickstart/100-prisma-postgres.mdx🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-06T22:06:57.725Z
Learnt from: newclarityex Repo: prisma/docs PR: 7425 File: content/200-orm/050-overview/500-databases/400-mysql.mdx:80-80 Timestamp: 2026-01-06T22:06:57.725Z Learning: In Prisma docs, when showing examples of instantiating driver adapters with connection strings from environment variables, use the template literal pattern `const connectionString = `${process.env.DATABASE_URL}`` for consistency across all database adapter examples (PostgreSQL, MySQL/MariaDB, etc.).Applied to files:
content/100-getting-started/02-prisma-orm/100-quickstart/100-prisma-postgres.mdx🔇 Additional comments (1)
content/100-getting-started/02-prisma-orm/100-quickstart/100-prisma-postgres.mdx (1)
77-81: Good intent—clarifying the two paths is valuable.The PR objective to distinguish local vs. managed setups addresses a real source of confusion (Issue
#7435). The direction is right; the execution just needs some polish around sequencing and ensuring downstream steps remain valid for both paths.✏️ Tip: You can disable this entire section by setting
review_detailstofalsein your review settings.
1 participant
Summary
Clarifies Prisma ORM initialization in the Prisma Postgres quickstart by separating local vs managed setup.
Context
npx prisma init --db ...provisions a managed Prisma Postgres database (online login + database creation), while local/self-managed Postgres setups should usenpx prisma init.Changes
npx prisma initfor local/self-managed Postgresnpx prisma init --db --output ../generated/prismafor managed Prisma Postgres provisioningRelated
Fixes #7435
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.