Skip to content

docs: clarify database connection options shape - #4465

Merged
pi0 merged 1 commit into
nitrojs:mainfrom
vittorioexp:docs/database-config-options
Jul 22, 2026
Merged

docs: clarify database connection options shape#4465
pi0 merged 1 commit into
nitrojs:mainfrom
vittorioexp:docs/database-config-options

Conversation

@vittorioexp

Copy link
Copy Markdown
Contributor

Summary

Closes #2898.

Clarifies that database connector settings belong under options, not at the top level. Adds a mysql2 configuration example.

Test plan

  • Docs-only change

Document that connector settings belong under options and add a mysql2 example. Closes nitrojs#2898.
@vittorioexp
vittorioexp requested a review from pi0 as a code owner July 22, 2026 10:23
@vercel

vercel Bot commented Jul 22, 2026

Copy link
Copy Markdown

@vittorioexp is attempting to deploy a commit to the Nitro Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jul 22, 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e4f627ab-4941-42f2-adb1-017cf545a89f

📥 Commits

Reviewing files that changed from the base of the PR and between c1ff6ba and cc08e17.

📒 Files selected for processing (1)
  • docs/1.docs/50.database.md

📝 Walkthrough

Walkthrough

The database configuration documentation now describes DatabaseConnectionConfig entries with connector and optional options, updates the PostgreSQL example, adds a MySQL analytics connection, and links to connector-specific option documentation.

Changes

Database configuration documentation

Layer / File(s) Summary
Configuration shape and examples
docs/1.docs/50.database.md
Documents the connector and options structure, nests PostgreSQL settings under options, adds an analytics MySQL connection, and links to db0 connector options.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title follows conventional commits and accurately summarizes the docs change about database connection options.
Description check ✅ Passed The description is directly related to the documentation update and mysql2 example added in the PR.
Linked Issues check ✅ Passed The docs now match the declared type by moving connector-specific settings under options and showing a mysql2 example.
Out of Scope Changes check ✅ Passed The changes stay within the documented database configuration clarification and do not introduce unrelated scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@pi0
pi0 merged commit 0192bba into nitrojs:main Jul 22, 2026
3 of 4 checks passed
@pi0 pi0 mentioned this pull request Aug 21, 2026
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.

the SQL Database Configuration example in the documentation is inconsistent with the actual declared type

2 participants