-
Notifications
You must be signed in to change notification settings - Fork 856
Add usage instructions for using Rust free ORM with Prisma Postgres/Accelerate #7137
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
… Accelerate and Postgres
WalkthroughAdds a new documentation section on using Prisma ORM without Rust engines (with Prisma Accelerate or Prisma Postgres) and duplicates the same section within the file. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. Comment |
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
|
Implements #DC-5433 |
Deploying docs with
|
| Latest commit: |
9473230
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ea3f8b79.docs-51g.pages.dev |
| Branch Preview URL: | https://feat-rust-free-orm-with-ppg.docs-51g.pages.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
content/200-orm/200-prisma-client/000-setup-and-configuration/300-no-rust-engine.mdx (2)
28-30: Align prerequisites with GA version (v6.16.0+).GA for the Rust‑free ORM is v6.16.0; requiring v6.15.0 risks users hitting pre‑GA behavior. Update the prerequisite accordingly. (prisma.io)
Apply this diff:
-### Prerequisites - -- Prisma ORM v6.15.0 (or later) +### Prerequisites + +- Prisma ORM v6.16.0 (or later)
270-275: Preview section: import path vs. generator output is inconsistent.The Preview generator sets
output = "../generated/prisma", but some samples import from@prisma/client. Either dropoutputor switch those imports to the output path. Easiest fix: keep the output line and change the three imports. Users will otherwise copy/paste broken code.-import { PrismaClient } from '@prisma/client' +import { PrismaClient } from './generated/prisma'Apply to:
- D1 sample (Line 357)
- PlanetScale sample (Line 395)
- Neon Serverless sample (Line 437)
Also applies to: 357-372, 392-399, 436-446
🧹 Nitpick comments (6)
content/200-orm/200-prisma-client/000-setup-and-configuration/300-no-rust-engine.mdx (6)
15-19: Clarify driver adapter requirement (not used with Accelerate or Prisma Postgres).The blanket “required” statement conflicts with the section below for Accelerate/Prisma Postgres. Tighten the wording here. (prisma.io)
- required usage of [driver adapters](/orm/overview/databases/database-drivers#driver-adapters) for database connection management + - [driver adapters](/orm/overview/databases/database-drivers#driver-adapters) are required for direct database connections (not when using Prisma Accelerate or Prisma Postgres)
42-46: Grammar: “need to re‑generate.”Minor wording fix.
-To make the configuration take effect, you need re-generate Prisma Client: +To make the configuration take effect, you need to re-generate Prisma Client:
233-237: Grammar: “need to re‑generate.”Same nit as above.
-To make the configuration take effect, you need re-generate Prisma Client: +To make the configuration take effect, you need to re-generate Prisma Client:
279-283: Grammar: “need to re‑generate.”Same nit in Preview section.
-To make the feature flags take effect, you need re-generate Prisma Client: +To make the feature flags take effect, you need to re-generate Prisma Client:
231-237: Optional: mention “--no-engine” for serverless/edge with Accelerate.Docs recommend generating without engines when using Accelerate in serverless/edge. Adding a one‑line tip here helps. (prisma.io)
```terminal npx prisma generate+Tip: For serverless or edge runtimes, generate without engines:
+terminal +npx prisma generate --no-engine +--- `325-329`: **Typo: “Serverles” → “Serverless”.** Fix tab label. ```diff -<TabItem value="Neon Serverles"> +<TabItem value="Neon Serverless">
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/200-orm/200-prisma-client/000-setup-and-configuration/300-no-rust-engine.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-11T09:40:55.237Z
Learnt from: ankur-arch
PR: prisma/docs#7066
File: content/200-orm/200-prisma-client/700-debugging-and-troubleshooting/245-troubleshooting-binary-size-issues.mdx:8-22
Timestamp: 2025-08-11T09:40:55.237Z
Learning: When the queryCompiler preview feature is enabled in Prisma ORM (v6.7.0+), it does not require Rust engines for CLI tools like `prisma migrate` or `prisma db pull`. The previous understanding that CLI tools would still need Rust binaries even with queryCompiler enabled is incorrect.
Applied to files:
content/200-orm/200-prisma-client/000-setup-and-configuration/300-no-rust-engine.mdx
⏰ 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)
- GitHub Check: Check internal links
- GitHub Check: runner / linkspector
- GitHub Check: Lost Pixel
🔇 Additional comments (2)
content/200-orm/200-prisma-client/000-setup-and-configuration/300-no-rust-engine.mdx (2)
217-252: Accelerate/Prisma Postgres guidance looks correct—links/requirements OK.The “no adapters; use withAccelerate()” guidance matches current docs; Prisma Postgres requires applying the Accelerate extension. Consider verifying final slugs (/accelerate and /postgres) before merge. (prisma.io)
33-38: Note on engineType and generators (FYI).engineType = "client" is now valid for both
prisma-clientandprisma-client-js, so keeping the “orprisma-client-js” comment is OK. (prisma.io)Also applies to: 221-229
Summary by CodeRabbit