chore(docs): move to direct tcp for most things#7549
chore(docs): move to direct tcp for most things#7549mhartington wants to merge 3 commits intomainfrom
Conversation
WalkthroughRemoved references and content related to Prisma Accelerate across documentation: deleted Accelerate entries, subsections, examples, and a client-extension table row; simplified Cloudflare/edge deployment and TCP/tunnel guidance; trimmed error and troubleshooting wording while retaining Prisma Postgres and platform references. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
🍈 Lychee Link Check Report3665 links: ❌ Errors
Full Statistics Table
|
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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/console/index.mdx`:
- Around line 14-15: Update the Optimize bullet text in the docs console index
(the list item that currently reads "Provides you recommendations that can help
you make your database queries faster.") to read "Provides you with
recommendations that can help you make your database queries faster." — locate
the list item under the Optimize link in
apps/docs/content/docs/console/index.mdx and replace the phrase "Provides you
recommendations" with "Provides you with recommendations".
- Line 47: The sentence "An API key is required to authenticate requests from
your Prisma Client to products. API keys are generated and managed at the
resource level." is ambiguous; change it to explicitly state that API keys are
required only when Prisma Client connects through Prisma Data Platform resources
(e.g., Accelerate, Optimize, Prisma Postgres) and not for direct database
connections. Update that sentence in the docs to something like: "An API key is
required only when Prisma Client connects to Prisma Data Platform resources
(Accelerate, Optimize, Prisma Postgres); direct database connections do not use
API keys," ensuring the resource names (Accelerate, Optimize, Prisma Postgres)
remain listed for clarity.
In
`@apps/docs/content/docs/orm/prisma-client/deployment/edge/deploy-to-cloudflare.mdx`:
- Line 60: Update the sentence referencing "Prisma Postgres" to also link to and
call out the Prisma Postgres edge limitations section: keep the existing
statement but append a short parenthetical or sentence noting there are
documented edge constraints (connection limits, query timeouts, extension
availability, local dev caveats) and link the phrase "Prisma Postgres" or
"limitations" to the official Prisma Postgres edge limitations doc; ensure the
wording still says it is supported on edge but points readers to the limitations
page for operational details.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
apps/docs/content/docs/console/index.mdxapps/docs/content/docs/orm/more/comparisons/prisma-and-drizzle.mdxapps/docs/content/docs/orm/prisma-client/client-extensions/extension-examples.mdxapps/docs/content/docs/orm/prisma-client/deployment/edge/deploy-to-cloudflare.mdxapps/docs/content/docs/postgres/database/connection-pooling.mdxapps/docs/content/docs/postgres/database/direct-connections.mdx
💤 Files with no reviewable changes (3)
- apps/docs/content/docs/orm/more/comparisons/prisma-and-drizzle.mdx
- apps/docs/content/docs/postgres/database/connection-pooling.mdx
- apps/docs/content/docs/orm/prisma-client/client-extensions/extension-examples.mdx
apps/docs/content/docs/orm/prisma-client/deployment/edge/deploy-to-cloudflare.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/docs/content/docs/postgres/error-reference.mdx (1)
41-65:⚠️ Potential issue | 🟡 MinorAlign connection-limit guidance with Prisma Postgres (not Accelerate).
Line 57 references “setting up Accelerate,” but this is the Prisma Postgres error reference. That can misdirect users. Recommend updating the wording to Prisma Postgres–specific guidance.
Suggested edit
-**Suggested solution**: Review and possibly increase the `connection_limit` specified in the connection string parameter when setting up Accelerate in a platform environment. This limit should align with your database's maximum number of connections. +**Suggested solution**: Review and possibly increase the `connection_limit` specified in the connection string parameter when setting up Prisma Postgres in a platform environment. This limit should align with your database's maximum number of connections.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/docs/content/docs/postgres/error-reference.mdx` around lines 41 - 65, Update the guidance that currently references "setting up Accelerate" to explicitly target Prisma Postgres; change the wording in the "High traffic and insufficient connections" section to recommend adjusting the connection_limit parameter in the Prisma Postgres connection string (not Accelerate), mention the default connection_limit value as it applies to Prisma Postgres, and ensure references to the query timeout (P6004) and connection_limit are consistent and Prisma Postgres–specific throughout the paragraph.
🧹 Nitpick comments (3)
apps/docs/content/docs/accelerate/more/troubleshoot.mdx (2)
37-57: Optional: reduce intensifiers in P6004 causes.A couple of “very”s can be trimmed to make the guidance crisper.
Suggested edit
-If the application is receiving very high traffic... +If the application is receiving high traffic...-...if a very large amount of data is being fetched... +...if a large amount of data is being fetched...🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/docs/content/docs/accelerate/more/troubleshoot.mdx` around lines 37 - 57, In the P6004 section of apps/docs/content/docs/accelerate/more/troubleshoot.mdx (the "Possible causes for [`P6004`]" block) trim unnecessary intensifiers: change "very high traffic" to "high traffic" and "a very large amount of data" to "a large amount of data" (or similar concise wording) so the guidance reads crisper while retaining meaning; update the two cause paragraphs and any other occurrences of "very" in that section accordingly.
13-33: Optional: tighten phrasing in the P6009 guidance.Minor trims would improve readability without changing meaning.
Suggested edit
-...analytics outside of ETL contexts, it should generally be avoided. +...analytics outside ETL contexts, it should generally be avoided.-In certain cases, a large number of records or fields are unintentionally fetched... +In certain cases, many records or fields are unintentionally fetched...🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/docs/content/docs/accelerate/more/troubleshoot.mdx` around lines 13 - 33, The guidance for P6009 is wordy and repetitive—tighten the intro and consolidate repeated "Suggested solution" blocks into a single concise remediation paragraph, then add 1–2 short, distinct tips under each heading ("Transmitting images/files in response", "Over-fetching of data", "Fetching a large volume of data") that focus on the unique fix (e.g., move assets to BLOB store and store URLs; verify and limit your where/select and use pagination; batch ETL/CRON queries). Preserve the error code reference [`P6009`] and existing links, keep sentences short, remove duplicate recommendations, and ensure each section ends with a one-line actionable suggestion.apps/docs/content/docs/postgres/error-reference.mdx (1)
15-37: Optional: tighten wording in P6009 section.A couple of phrases are a bit wordy. Consider small trims for readability (e.g., “outside of” → “outside”, “a large number of” → “many”).
Suggested edit
-...analytics outside of ETL contexts, it should generally be avoided. +...analytics outside ETL contexts, it should generally be avoided.-In certain cases, a large number of records or fields are unintentionally fetched... +In certain cases, many records or fields are unintentionally fetched...🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/docs/content/docs/postgres/error-reference.mdx` around lines 15 - 37, The P6009 doc is wordy in several spots—tighten phrasing throughout (e.g., change “outside of” to “outside”, “a large number of” to “many”) and reduce repetition in suggested solutions; specifically edit the introductory paragraph that starts “Typically, transmitting more than `5MB`…” and the sections titled “Transmitting images/files in response”, “Over-fetching of data”, and “Fetching a large volume of data” to use shorter words/phrases, collapse duplicate guidance about increasing the query response size limit into a single concise instruction, and prefer active concise constructions in sentences that mention ETL/CRON and pagination/select usage (refer to the P6009 error identifier and the section headings to locate the text).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@apps/docs/content/docs/postgres/error-reference.mdx`:
- Around line 41-65: Update the guidance that currently references "setting up
Accelerate" to explicitly target Prisma Postgres; change the wording in the
"High traffic and insufficient connections" section to recommend adjusting the
connection_limit parameter in the Prisma Postgres connection string (not
Accelerate), mention the default connection_limit value as it applies to Prisma
Postgres, and ensure references to the query timeout (P6004) and
connection_limit are consistent and Prisma Postgres–specific throughout the
paragraph.
---
Nitpick comments:
In `@apps/docs/content/docs/accelerate/more/troubleshoot.mdx`:
- Around line 37-57: In the P6004 section of
apps/docs/content/docs/accelerate/more/troubleshoot.mdx (the "Possible causes
for [`P6004`]" block) trim unnecessary intensifiers: change "very high traffic"
to "high traffic" and "a very large amount of data" to "a large amount of data"
(or similar concise wording) so the guidance reads crisper while retaining
meaning; update the two cause paragraphs and any other occurrences of "very" in
that section accordingly.
- Around line 13-33: The guidance for P6009 is wordy and repetitive—tighten the
intro and consolidate repeated "Suggested solution" blocks into a single concise
remediation paragraph, then add 1–2 short, distinct tips under each heading
("Transmitting images/files in response", "Over-fetching of data", "Fetching a
large volume of data") that focus on the unique fix (e.g., move assets to BLOB
store and store URLs; verify and limit your where/select and use pagination;
batch ETL/CRON queries). Preserve the error code reference [`P6009`] and
existing links, keep sentences short, remove duplicate recommendations, and
ensure each section ends with a one-line actionable suggestion.
In `@apps/docs/content/docs/postgres/error-reference.mdx`:
- Around line 15-37: The P6009 doc is wordy in several spots—tighten phrasing
throughout (e.g., change “outside of” to “outside”, “a large number of” to
“many”) and reduce repetition in suggested solutions; specifically edit the
introductory paragraph that starts “Typically, transmitting more than `5MB`…”
and the sections titled “Transmitting images/files in response”, “Over-fetching
of data”, and “Fetching a large volume of data” to use shorter words/phrases,
collapse duplicate guidance about increasing the query response size limit into
a single concise instruction, and prefer active concise constructions in
sentences that mention ETL/CRON and pagination/select usage (refer to the P6009
error identifier and the section headings to locate the text).
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
apps/docs/content/docs/accelerate/more/troubleshoot.mdxapps/docs/content/docs/orm/reference/error-reference.mdxapps/docs/content/docs/postgres/database/direct-connections.mdxapps/docs/content/docs/postgres/error-reference.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- apps/docs/content/docs/postgres/database/direct-connections.mdx
Prefer using direct tcp for most examples over accelerate
Summary by CodeRabbit