docs: add Prisma Next API reference section#8033
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…rence # Conflicts: # .claude/launch.json
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🍈 Lychee Link Check Report77 links: ✅ All links are working!Full Statistics Table
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughThis PR adds a new Prisma Next “Reference” docs section, wires it into ORM navigation, and adds reference pages for the ORM client, SQL query builder, pipeline builder, raw queries, and transactions/runtime. ChangesReference Documentation Addition
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/docs/content/docs/orm/next/reference/sql-query-builder.mdx`:
- Line 718: The `build()` links in the mutation/query-builder docs are pointing
to the wrong anchor, so update both references in the affected prose to use the
correct slug for the combined `build()` and `aggregate()` heading. Locate the
Markdown in the `sql-query-builder.mdx` reference section where `returning()`,
`build()`, `insert()`, `update()`, and `delete()` are mentioned, and replace
each `#build` link with `#build-and-aggregate` so the in-page navigation
resolves correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 95d8c1b4-e366-4814-9284-a75005c76537
📒 Files selected for processing (8)
apps/docs/content/docs/orm/next/meta.jsonapps/docs/content/docs/orm/next/reference/index.mdxapps/docs/content/docs/orm/next/reference/meta.jsonapps/docs/content/docs/orm/next/reference/orm-client.mdxapps/docs/content/docs/orm/next/reference/pipeline-builder.mdxapps/docs/content/docs/orm/next/reference/raw-queries.mdxapps/docs/content/docs/orm/next/reference/sql-query-builder.mdxapps/docs/content/docs/orm/next/reference/transactions-and-runtime.mdx
|
@coderabbitai approve |
✅ Action performedComments resolved. Approval is disabled; enable |
1 similar comment
✅ Action performedComments resolved. Approval is disabled; enable |
What this adds
A complete API reference for Prisma Next under
/orm/next/reference, joining the existing Data Modeling / Fundamentals / Middleware / Extensions sections:where,include,orderBy, mutations, aggregates, filters, Mongo field operations), schema-first like the classic Prisma Client reference, with PostgreSQL/MongoDB tabs where usage differs and "For Prisma 7 users" migration diffs on the core methods.db.sql.public.<table>entry points, SELECT/joins (incl. lateral), grouped queries, mutations withreturning, expressions,param(),build()+ execution, capability gating.db.querysurface: stages, all 19 accumulators, expression-helper tables, read/write terminals,rawCommand().How it was validated
Every code example is transcribed from a passing test in a local validation harness inside the prisma-next monorepo (kept out of git there): 294 vitest tests running against real databases — ephemeral Postgres via
withDevDatabase, MongoDB viamongodb-memory-server. Every availability claim traces to a per-method manifest generated from those test results; claims that could not be executed (Atlas-only stages, unshipped Mongo transactions) are explicitly labeled instead of implied.The validation surfaced real product behavior now documented as verified warnings rather than happy-path assumptions, including: pipeline
match()_idequality filters never matching, PostgreSQL raw bare-scalar interpolation being broken (param(...)is mandatory), type-only vs runtimewhere()guards differing per database, and raw results bypassing codec decoding. Upstream reports for the confirmed bugs are being filed separately against prisma-next.Notes for reviewers
db.orm.public.User/db.orm.users/db.sql.public.<table>accessors,tab=code fences, example schema up front) — the accessor style itself was empirically validated before adoption.pnpm --filter docs lint:linksis clean (0 errors); the docs build compiles all MDX (the/api/searchMXBAI_API_KEYfailure is pre-existing and unrelated).fundamentals/reading-data.mdxunderstates MongoDBwhere()filter capabilities relative to the verified reference.🤖 Generated with Claude Code
Summary by CodeRabbit