docs: Document the noReturn option on write operations#700
Open
marcelomendoncasoares wants to merge 2 commits into
Open
docs: Document the noReturn option on write operations#700marcelomendoncasoares wants to merge 2 commits into
noReturn option on write operations#700marcelomendoncasoares wants to merge 2 commits into
Conversation
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
marked this pull request as ready for review
July 21, 2026 18:42
marcelomendoncasoares
marked this pull request as draft
July 21, 2026 18:52
marcelomendoncasoares
marked this pull request as ready for review
July 21, 2026 18:58
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
noReturn: trueonupdateWhereand explain that the write still runs with the same filters, conflict handling, transaction, and atomicity guarantees.insert,update,updateWhere,upsert,delete, anddeleteWhere. The single-row variants always return their row.orderByandorderByListno longer affect the (empty) result, but still decide which rowslimitandoffsetselect.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,upsertis named here before it has a section of its own on the page.Reference
noReturnto all ORM methods that return a list serverpod#5371