Skip to content

feat: revised pooling docs#7662

Merged
aidankmcalister merged 7 commits intomainfrom
feat/revised-pooling-docs
Mar 20, 2026
Merged

feat: revised pooling docs#7662
aidankmcalister merged 7 commits intomainfrom
feat/revised-pooling-docs

Conversation

@luanvdw
Copy link
Member

@luanvdw luanvdw commented Mar 17, 2026

Consolidate connection docs into two pages.

Merged three pages ("Connecting to your database," "Connection pooling," "Direct connections") into two. The split caused an unclear entry point for first-time setup and duplicated troubleshooting content across pages.

  • "Connecting to your database" is now the single entry point: explains the two-string split and why, adds a note on asymmetric failure modes, reorders sections by primary audience, trims troubleshooting to connection-setup problems only.
  • "Connection pooling" adds the routing diagram, leads with pooled connection limits, clarifies transactional mode behavior and its consequences, expands "too many connections" with specific root causes.
  • "Direct connections" is removed — content absorbed into the connecting page. Redirect to /docs/postgres/database/connecting-to-your-database.

Summary by CodeRabbit

  • Documentation

    • Reorganized connection guides with a new comprehensive page explaining pooled vs. direct connection strings, including setup examples for Prisma ORM, serverless runtimes, and PostgreSQL tools, plus troubleshooting guidance.
    • Updated connection pooling documentation with transactional mode details and plan-specific connection limits.
    • Updated internal documentation links across multiple guides to reference the new consolidated connection resource.
  • Chores

    • Added build artifact to gitignore.

@vercel
Copy link

vercel bot commented Mar 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
blog Ready Ready Preview, Comment Mar 20, 2026 0:03am
docs Ready Ready Preview, Comment Mar 20, 2026 0:03am
eclipse Ready Ready Preview, Comment Mar 20, 2026 0:03am
site Ready Ready Preview, Comment Mar 20, 2026 0:03am

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 2026

Walkthrough

This PR consolidates Prisma Postgres connection guidance by removing the direct-connections documentation page and creating a new connecting-to-your-database page that covers both pooled and direct connection strings. All internal documentation links across the site are updated to reference the new consolidated page. The .gitignore file is also updated to exclude the .codex directory.

Changes

Cohort / File(s) Summary
Configuration & Metadata
.gitignore
Added .codex directory to ignore list.
Connection Documentation Consolidation
apps/docs/content/docs/postgres/database/direct-connections.mdx, apps/docs/content/docs/postgres/database/connecting-to-your-database.mdx, apps/docs/content/docs/postgres/database/meta.json, apps/docs/content/docs/postgres/database/connection-pooling.mdx
Removed deprecated direct-connections page; created new comprehensive connecting-to-your-database page explaining pooled vs. direct connection strings with workload recommendations, troubleshooting, and setup examples. Updated sidebar metadata to reference new page. Rewrote connection-pooling to clarify transactional pooling mechanics, per-plan limits, session behavior, and when to use pooled vs. direct connections.
Documentation Link Migration
apps/docs/content/docs/(index)/prisma-postgres/import-from-existing-database-*.mdx, apps/docs/content/docs/guides/postgres/vercel.mdx, apps/docs/content/docs/guides/runtimes/bun.mdx, apps/docs/content/docs/guides/runtimes/deno.mdx, apps/docs/content/docs/guides/switch-to-prisma-postgres/from-*.mdx, apps/docs/content/docs/postgres/database/backups.mdx, apps/docs/content/docs/postgres/database/local-development.mdx, apps/docs/content/docs/postgres/faq.mdx, apps/docs/content/docs/postgres/index.mdx, apps/docs/content/docs/postgres/npx-create-db.mdx, apps/docs/content/docs/query-insights/index.mdx
Updated internal documentation links: replaced /postgres/database/direct-connections references with /postgres/database/connecting-to-your-database across 13 documentation pages. Consistent link migration with no procedural or instructional changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat: revised pooling docs' directly matches the PR's primary objective of revising documentation for pooling and connection management, accurately capturing the main change.
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.

📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

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

@argos-ci
Copy link

argos-ci bot commented Mar 17, 2026

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Mar 20, 2026, 12:08 PM

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
apps/docs/content/docs/postgres/database/connection-pooling.mdx (1)

49-49: Tighten the sentence for readability.

The last sentence is a fragment. Consider folding it into the previous sentence for smoother flow.

✏️ Suggested wording tweak
-Getting this wrong has asymmetric failure modes. Running migrations through the pooler produces clear errors (lock failures, session state errors). Running application traffic over direct connections works fine at low concurrency but causes silent connection exhaustion under load. The kind of issue that only surfaces in production.
+Getting this wrong has asymmetric failure modes. Running migrations through the pooler produces clear errors (lock failures, session state errors). Running application traffic over direct connections works fine at low concurrency but can cause silent connection exhaustion under load—the kind of issue that only surfaces in production.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@apps/docs/content/docs/postgres/database/connection-pooling.mdx` at line 49,
The last sentence fragment "The kind of issue that only surfaces in production."
should be folded into the previous sentence ("Running application traffic over
direct connections works fine at low concurrency but causes silent connection
exhaustion under load.") to improve flow; replace those two sentences with a
single tightened sentence such as: "Running application traffic over direct
connections works fine at low concurrency but causes silent connection
exhaustion under load, the kind of issue that only surfaces in production."
Locate and update that sentence pair in the paragraph.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@apps/docs/content/docs/postgres/database/connecting-to-your-database.mdx`:
- Line 113: Summary: Fix hyphenation by changing "built in" to "built-in" in the
user-facing sentence. Locate the sentence containing "serverless driver
(`@prisma/ppg`)" and replace the phrase "has built in connection pooling" with
"has built-in connection pooling" so the compound adjective is correctly
hyphenated (update the text near the sentence that reads "It communicates over
HTTP and WebSockets rather than TCP and has built in connection pooling.").

---

Nitpick comments:
In `@apps/docs/content/docs/postgres/database/connection-pooling.mdx`:
- Line 49: The last sentence fragment "The kind of issue that only surfaces in
production." should be folded into the previous sentence ("Running application
traffic over direct connections works fine at low concurrency but causes silent
connection exhaustion under load.") to improve flow; replace those two sentences
with a single tightened sentence such as: "Running application traffic over
direct connections works fine at low concurrency but causes silent connection
exhaustion under load, the kind of issue that only surfaces in production."
Locate and update that sentence pair in the paragraph.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8c2529b3-e305-4461-b4e7-d2687692af44

📥 Commits

Reviewing files that changed from the base of the PR and between 7cfc20d and 52523c8.

📒 Files selected for processing (18)
  • .gitignore
  • apps/docs/content/docs/(index)/prisma-postgres/import-from-existing-database-mysql.mdx
  • apps/docs/content/docs/(index)/prisma-postgres/import-from-existing-database-postgresql.mdx
  • apps/docs/content/docs/guides/postgres/vercel.mdx
  • apps/docs/content/docs/guides/runtimes/bun.mdx
  • apps/docs/content/docs/guides/runtimes/deno.mdx
  • apps/docs/content/docs/guides/switch-to-prisma-postgres/from-neon.mdx
  • apps/docs/content/docs/guides/switch-to-prisma-postgres/from-supabase.mdx
  • apps/docs/content/docs/postgres/database/backups.mdx
  • apps/docs/content/docs/postgres/database/connecting-to-your-database.mdx
  • apps/docs/content/docs/postgres/database/connection-pooling.mdx
  • apps/docs/content/docs/postgres/database/direct-connections.mdx
  • apps/docs/content/docs/postgres/database/local-development.mdx
  • apps/docs/content/docs/postgres/database/meta.json
  • apps/docs/content/docs/postgres/faq.mdx
  • apps/docs/content/docs/postgres/index.mdx
  • apps/docs/content/docs/postgres/npx-create-db.mdx
  • apps/docs/content/docs/query-insights/index.mdx
💤 Files with no reviewable changes (1)
  • apps/docs/content/docs/postgres/database/direct-connections.mdx

@aidankmcalister aidankmcalister self-assigned this Mar 20, 2026
@aidankmcalister aidankmcalister merged commit 09ea32f into main Mar 20, 2026
13 of 14 checks passed
@aidankmcalister aidankmcalister deleted the feat/revised-pooling-docs branch March 20, 2026 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants