Skip to content

docs: Document the noReturn option on write operations#700

Open
marcelomendoncasoares wants to merge 2 commits into
serverpod:mainfrom
marcelomendoncasoares:docs/orm-no-return
Open

docs: Document the noReturn option on write operations#700
marcelomendoncasoares wants to merge 2 commits into
serverpod:mainfrom
marcelomendoncasoares:docs/orm-no-return

Conversation

@marcelomendoncasoares

@marcelomendoncasoares marcelomendoncasoares commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Summary

The batch and filtered write methods accept noReturn: true, which runs the write without reading the affected rows back. The CRUD page had no mention of it.

Changes

  • Add a "Skipping returned rows" section to the CRUD page.
  • Show noReturn: true on updateWhere and explain that the write still runs with the same filters, conflict handling, transaction, and atomicity guarantees.
  • Describe the performance tradeoff and when it is worth taking.
  • List the methods that accept it: insert, update, updateWhere, upsert, delete, and deleteWhere. The single-row variants always return their row.
  • Note that orderBy and orderByList no longer affect the (empty) result, but still decide which rows limit and offset select.

Note on merge order

The method list includes upsert, which is documented in the companion PR for the upsert methods. If this PR merges first, upsert is named here before it has a section of its own on the page.

Reference

Use a section title in line with the other CRUD headings, fold the method
list into a sentence instead of one-word bullets, name orderBy explicitly,
and match the filter used by the surrounding examples.
@marcelomendoncasoares
marcelomendoncasoares marked this pull request as ready for review July 21, 2026 18:42
@marcelomendoncasoares
marcelomendoncasoares requested a review from a team July 21, 2026 18:42
@marcelomendoncasoares
marcelomendoncasoares marked this pull request as draft July 21, 2026 18:52
@marcelomendoncasoares
marcelomendoncasoares marked this pull request as ready for review July 21, 2026 18:58
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.

1 participant