Skip to content

docs: add a database connections guide for tasks#3881

Merged
ericallam merged 3 commits into
mainfrom
docs/database-connections
Jun 9, 2026
Merged

docs: add a database connections guide for tasks#3881
ericallam merged 3 commits into
mainfrom
docs/database-connections

Conversation

@ericallam

Copy link
Copy Markdown
Member

Summary

A new guide for connecting a database to your tasks: where to create the client, how to size the connection pool against your provider's limit, when to reach for a pooler, and how to release connections at waits so you don't hit "too many connections" or crash on resume.

It covers node-postgres, Prisma, Drizzle, and MongoDB, with researched direct and pooled connection limits for the common Postgres providers (Supabase, Neon, RDS, PlanetScale) and MongoDB Atlas. The page lives under Documentation, Troubleshooting, and is linked from the chat agent docs (overview, lifecycle hooks, chat.local, and the database persistence pattern).

Where to create the client, how to size the pool against each provider's connection limit, when to use a pooler, and how to release connections at waits. Covers node-postgres, Prisma, Drizzle, and MongoDB, and is linked from the chat agent docs.
@changeset-bot

changeset-bot Bot commented Jun 9, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 8e7b1b4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: f4d242b0-8b41-4da9-9bb1-2e928a221315

📥 Commits

Reviewing files that changed from the base of the PR and between 2150d88 and 8e7b1b4.

📒 Files selected for processing (1)
  • docs/database-connections.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/database-connections.mdx
📜 Recent review details
⏰ 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: Analyze (javascript-typescript)

Walkthrough

This PR adds a new database-connections.mdx guide with recommendations for module-scoped clients/pools, pool sizing, pooler usage, private DB connectivity, provider notes, releasing connections during waits, chat-agent patterns, examples, and troubleshooting. It registers the page in docs.json, adds a "Database connections" card to the AI chat overview, and updates onBoot/chat-local/database-persistence docs to reference the new guide. All edits are documentation-only.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is missing required sections from the template: Closes #, Checklist, Testing, and Changelog sections are not included. Add the missing checklist items, testing description, and changelog entry following the repository template to ensure compliance with contribution guidelines.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a new database connections guide for tasks, which is supported by the raw summary showing a new comprehensive database-connections.mdx file and related documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/database-connections

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.

@ericallam ericallam marked this pull request as ready for review June 9, 2026 17:59
@mintlify

mintlify Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
trigger 🟢 Ready View Preview Jun 9, 2026, 6:01 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

coderabbitai[bot]

This comment was marked as resolved.

@ericallam ericallam merged commit d973359 into main Jun 9, 2026
21 checks passed
@ericallam ericallam deleted the docs/database-connections branch June 9, 2026 21:24
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