chore: update api's for ppg_dev

[ankur-arch]

Summary by CodeRabbit

Release Notes

• Documentation
  • Updated local development setup guide with renamed API function and enhanced configuration options
  • Added optional parameters for debugging, dry runs, and timeout settings
  • Simplified port configuration with static default values
  • Included TypeScript type import examples for better developer experience

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The pull request updates the Postgres local development documentation to reflect API changes for the Prisma dev server. It renames unstable_startServer to startPrismaDevServer, switches from dynamic port generation to static port values, marks the name parameter as optional with default 'default', and documents additional configuration options including timeout and debug settings.

Changes

Cohort / File(s)	Summary
Documentation update content/250-postgres/300-database/550-local-development.mdx	Renamed API function from unstable_startServer to startPrismaDevServer; replaced dynamic port generation (get-port-please) with static port configuration; updated public options table to mark name as optional with default value and added new options (debug, dryRun, timeout parameters); added TypeScript type import example for ServerOptions from @prisma/dev

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Document local Prisma Postgres management in Node.js #7175: Introduced the initial unstable_startServer example with dynamic port generation that this PR updates and renames to reflect the stable API.
• docs: update prisma dev command documentation #7426: Updates Prisma Dev documentation to set the --name default to "default", which aligns with the parameter change documented here.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title mentions 'ppg_dev' but the changeset updates documentation for 'startPrismaDevServer' API with no clear reference to what 'ppg_dev' means or how it relates to the actual changes.	Clarify the title to directly reference the main change: consider 'docs: update startPrismaDevServer API documentation' or explain what 'ppg_dev' represents in the context of this change.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

Dangerous URL check

No absolute URLs to prisma.io/docs found.
No local URLs found.

[github-actions]

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

• This PR does not change any pages in a way that would require a redirect.

[github-actions]

original	preview
content/250-postgres/300-database/550-local-development.mdx	content/250-postgres/300-database/550-local-development.mdx

[github-actions]

🍈 Lychee Link Check Report

Note: Links are cached for 5 minutes. Failed links (timeouts, rate limits) are retried in a second run with longer timeout.

📊 Results Overview

Status	Count
🔍 Total	2310
✅ Successful	2280
⏳ Timeouts	0
🔀 Redirected	4
👻 Excluded	24
❓ Unknown	0
🚫 Errors	1
⛔ Unsupported	1

Errors per input

Errors in 200-orm/050-overview/100-introduction/250-should-you-use-prisma.mdx

• [ERROR] https://nexusjs.org/docs/plugins/prisma/overview | Error (cached)

[cloudflare-workers-and-pages]

Deploying docs with    Cloudflare Pages

Latest commit:	5582a85
Status:	✅  Deploy successful!
Preview URL:	https://9dafe14b.docs-51g.pages.dev
Branch Preview URL:	https://dr-6846.docs-51g.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@content/250-postgres/300-database/550-local-development.mdx`:
- Around line 222-227: The example misstates the startPrismaDevServer "name"
option as required while the API table marks it optional with default 'default';
update the example to reflect that by making startLocalPrisma accept an optional
name and pass the default when omitted (adjust the startLocalPrisma signature
and the startPrismaDevServer call so name is optional and defaults to
'default'), referencing the startLocalPrisma function and the
startPrismaDevServer call so readers see the optionality matches the API table.

🧹 Nitpick comments (1)

content/250-postgres/300-database/550-local-development.mdx (1)

251-257: Consider a short note clarifying fixed defaults vs CLI ports.
Now that defaults are static (51213-51215), a short note can prevent confusion with the earlier CLI output that shows random ports.

💡 Suggested doc tweak

 Notes:
 
 - Allocate unique ports and `name` values when running tests concurrently.
+- The CLI (`prisma dev`) may choose random ports, while `startPrismaDevServer` defaults to 51213-51215 unless overridden.
 - Use `server.database.connectionString` to connect with Postgres clients or ORMs.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d27594a and 5582a85.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (1)

• content/250-postgres/300-database/550-local-development.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/250-postgres/300-database/550-local-development.mdx

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: Check internal links
• GitHub Check: Cloudflare Pages

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}