docs(): update for the 6.19 release #7232
Conversation
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
WalkthroughThree Prisma docs were updated: the main Postgres pooling doc now presents pooling as built-in with plan-based pooled connection limits and updated configuration guidance; the direct-connections doc was revised for a dashboard-driven connection-string workflow and added pooling examples; the Accelerate page now points readers to the Postgres pooling docs. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Pre-merge checks❌ Failed checks (1 inconclusive)
✅ Passed checks (1 passed)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ 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). (3)
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 |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
🍈 Lychee Link Check Report
📊 Results Overview
Redirects per inputRedirects in 800-guides/370-bun.mdx
Redirects in 800-guides/380-vercel-app-deployment.mdx
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
content/250-postgres/300-database/400-connection-pooling.mdx(1 hunks)content/250-postgres/300-database/650-direct-connections.mdx(4 hunks)content/300-accelerate/250-connection-pooling.mdx(1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Documentation Checks
content/250-postgres/300-database/650-direct-connections.mdx
[error] 21-21: cspell: Unknown word 'datatbase'. Fix: 'database'.
content/250-postgres/300-database/400-connection-pooling.mdx
[error] 17-17: cspell: Unknown word 'depening'. Fix: 'depending' or 'deepening'.
[error] 41-41: cspell: Unknown word 'automatially'. Fix: 'automatically'.
🪛 LanguageTool
content/250-postgres/300-database/650-direct-connections.mdx
[grammar] ~21-~21: Ensure spelling is correct
Context: ...nstance. 1. Click the Connect to your datatbase button in your dashboard. 1. Click th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
content/250-postgres/300-database/400-connection-pooling.mdx
[style] ~11-~11: Consider a more concise word here.
Context: ...to further configure connection pooling in order to optimize the performance of your applic...
(IN_ORDER_TO_PREMIUM)
[grammar] ~17-~17: Ensure spelling is correct
Context: ...onnection limit starts at 10 and scales depening on your plan. | ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~41-~41: Ensure spelling is correct
Context: ...stgres, the connection limit is managed automatially for you. If you're **not using Prisma ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ 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: runner / linkspector
🔇 Additional comments (7)
content/300-accelerate/250-connection-pooling.mdx (1)
7-8: Redirect content is clear and appropriately structured.The file effectively communicates that connection pooling documentation has moved while providing context about what Accelerate offers. The redirect to the Postgres section is explicit and helpful.
content/250-postgres/300-database/650-direct-connections.mdx (2)
11-24: UI workflow steps are clear and well-organized.The updated connection flow properly guides users through the console steps for both standard and pooled connections. The sequence is intuitive and the toggle for pooling is explicitly documented.
46-52: New pooling section is well-positioned and practical.The addition of connection pooling guidance with a concrete example (
pool=trueparameter) aligns well with the broader documentation reorganization and helps users understand how to enable pooling via the connection string.content/250-postgres/300-database/400-connection-pooling.mdx (4)
14-36: Plan-based limits structure is clear and helpful.The reorganization into dedicated "Connection pooling in Prisma Postgres" section with separate tables for Postgres vs. "your own database" scenarios is well-structured and significantly improves clarity for users. The note at lines 32-34 appropriately contextualizes the Starter plan limits.
39-45: Configuration section clearly differentiates between scenarios.The restructured guidance properly separates automatic management (Prisma Postgres), manual ORM configuration, and Accelerate setup paths. This prevents confusion about which approach applies to each use case and aligns with related documentation changes.
65-127: Query limits documentation is comprehensive and well-structured.The plan-based tables for query timeouts, interactive transaction timeouts, and response sizes provide clear progression and guidance. The warnings appropriately recommend optimization before increasing limits, promoting best practices.
129-157: Autoscaling section scope and explanation are clear.The section correctly scopes autoscaling to Accelerate with non-Postgres databases, and the concrete example of distributing connections across Query Engine instances effectively explains the scaling mechanism. Plan-based limits table is helpful for users evaluating feature eligibility.
Deploying docs with
|
| Latest commit: |
adf0ee1
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e8eb000d.docs-51g.pages.dev |
| Branch Preview URL: | https://v6-19-0.docs-51g.pages.dev |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
🍈 Lychee Link Check Report
📊 Results Overview
Redirects per inputRedirects in 800-guides/070-cloudflare-d1.mdx
Redirects in 800-guides/090-nextjs.mdx
Redirects in 800-guides/170-react-router-7.mdx
Redirects in 800-guides/350-authjs-nextjs.mdx
Redirects in 800-guides/370-bun.mdx
Redirects in 800-guides/380-vercel-app-deployment.mdx
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
content/250-postgres/300-database/400-connection-pooling.mdx (1)
11-11: Minor style improvement: reduce verbosity.Line 11 uses "in order to" which is more verbose than necessary. Consider simplifying to just "to" for conciseness, as this is a common style guideline in technical documentation.
Apply this diff for a more concise phrasing:
-However, if you are using your own database with Prisma Accelerate, it may be beneficial to further configure connection pooling in order to optimize the performance of your application. +However, if you are using your own database with Prisma Accelerate, it may be beneficial to further configure connection pooling to optimize the performance of your application.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/250-postgres/300-database/400-connection-pooling.mdx(1 hunks)content/250-postgres/300-database/650-direct-connections.mdx(4 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-08T16:23:00.388Z
Learnt from: aidankmcalister
Repo: prisma/docs PR: 7165
File: content/800-guides/550-test-guide.mdx:85-90
Timestamp: 2025-10-08T16:23:00.388Z
Learning: For .mdx files in the prisma/docs repository: Only flag code snippets for (1) exposed secrets with real-looking values that should be placeholders (e.g., API keys, database passwords, AWS credentials), or (2) blatant syntax errors like missing parentheses, brackets, braces, or mismatched delimiters. Do not flag code quality issues, anti-patterns, security vulnerabilities, missing error handling, unused variables, or any other bad practices, as documentation intentionally shows problematic code.
Applied to files:
content/250-postgres/300-database/400-connection-pooling.mdx
🪛 LanguageTool
content/250-postgres/300-database/400-connection-pooling.mdx
[style] ~11-~11: Consider a more concise word here.
Context: ...to further configure connection pooling in order to optimize the performance of your applic...
(IN_ORDER_TO_PREMIUM)
[grammar] ~41-~41: Ensure spelling is correct
Context: ...stgres, the connection limit is managed automatially for you. If you're **not using Prisma ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
content/250-postgres/300-database/650-direct-connections.mdx
[grammar] ~21-~21: Ensure spelling is correct
Context: ...nstance. 1. Click the Connect to your datatbase button in your dashboard. 1. Click th...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ 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). (1)
- GitHub Check: runner / linkspector
🔇 Additional comments (1)
content/250-postgres/300-database/650-direct-connections.mdx (1)
46-52: Verify pooling parameter documentation.The new "Pooling connections" section documents
pool=trueas an optional parameter. The Accelerate documentation confirms that connection pooling documentation is now in the Prisma Postgres section, which aligns with this change. However, verify that the example includessslmode=requiresince SSL is required per line 44. The current example shows onlypool=truewithout the required SSL parameter—users should see the combined format.Consider updating the example to show both parameters together:
### Pooling connections If you want to enable connection pooling, you can append `pool=true` to your TCP connection string ```bash -DATABASE_URL="postgres://USER:[email protected]:5432/?pool=true" +DATABASE_URL="postgres://USER:[email protected]:5432/?sslmode=require&pool=true"</blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
🍈 Lychee Link Check Report
📊 Results Overview
Redirects per inputRedirects in 800-guides/370-bun.mdx
Redirects in 800-guides/380-vercel-app-deployment.mdx
|
Summary by CodeRabbit