docs: parameterized computed fields

[evgenovalov]

What

Documents the parameterized @computed fields feature on the ORM Computed Fields page.

Adds a Parameterized Computed Fields section covering:

• the ZModel parameter syntax — recentPostCount(since: DateTime) Int @computed
• the implementation signature (a third args argument, typed from the declared parameters)
• supplying args across every read context: orderBy, where (and having), select / include, aggregate (_count / _sum / _avg / _min / _max), and groupBy by
• that a parameterized field isn't auto-returned (must be requested via select / include)
• a note that grouping by a correlated-subquery computed field is subject to the database's own correlated-GROUP BY rules

Related

• Feature — orderBy support: feat: support parameterized computed fields zenstack#2744
• Follow-up — where / select / include / aggregate / groupBy: feat: parameterized computed fields in where / select / include / aggregate / groupBy zenstack#2762

This documents the API as of those PRs. Happy to adjust if the API shape changes during review — the page can merge alongside the v3.9 release.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added guidance for using parameterized computed fields.
  • Documented typed schema parameters and callback argument handling.
  • Explained how to supply parameters in filtering, sorting, selection, aggregation, and grouping queries.
  • Clarified that parameterized computed fields are not returned by default.

[vercel]

Someone is attempting to deploy a commit to the ZenStack Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

Warning

Review limit reached

@evgenovalov, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 55 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: b9989e08-5be4-4160-912f-740db2d506d1

📥 Commits

Reviewing files that changed from the base of the PR and between 1aa7b4d and beca7ac.

📒 Files selected for processing (1)

• docs/orm/computed-fields.md

Walkthrough

Adds documentation for declaring, implementing, and querying parameterized computed fields, including explicit argument passing and selection requirements.

Changes

Parameterized Computed Fields

Layer / File(s)	Summary
Parameterized field declaration and query usage docs/orm/computed-fields.md	Documents typed schema parameters, the callback’s third args parameter, explicit query-time argument passing, and selection requirements across ordering, filtering, selection, and aggregation.

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

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: documentation for parameterized computed fields.
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.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

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 `@docs/orm/computed-fields.md`:
- Around line 83-85: Update the “Parameterized Computed Fields” section in
computed-fields.md by importing AvailableSince from the relative
_components/AvailableSince path and placing an <AvailableSince version="v3.9.0"
/> component immediately below that heading.

🪄 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: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: e47bf9d5-1228-49e0-aea8-01f162909d0c

📥 Commits

Reviewing files that changed from the base of the PR and between bf4c80d and 1aa7b4d.

📒 Files selected for processing (1)

• docs/orm/computed-fields.md