Repository navigation
feat(postgrest)!: order and limit inside a to-many embed on the typed surface - #1960
Merged
Merged
Conversation
… surface
Adds `embedded()` to the typed transform builder. It takes a to-many
relation and a callback that receives a scope typed against the embedded
table, offering `order`, `limit`, `range` and nested `embedded` calls:
.embedded(
Authors.books,
(books) => books.order(Books.createdAt.desc()).limit(1),
)
// books.order=created_at.desc&books.limit=1
The typed `limit()` and `range()` drop their untyped `referencedTable`
parameter in favor of the scope.
Fixes SDK-1758
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation |
|---|---|---|
| Description Check |  |
Check skipped - CodeRabbit’s high-level summary is enabled. |
| Title check | |
The title clearly and concisely describes the main change: adding typed-surface support to order and limit rows inside to-many embeds. The breaking-change marker is also appropriate because typed limi… |
| Docstring Coverage | |
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
| Linked Issues check | |
Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | |
Check skipped because no linked issues were found for this pull request. |
✨ Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
Comment @coderabbitai help to get the list of available commands.
spydon
added a commit
that referenced
this pull request
Oct 15, 2026
…select list (#1962) ## Summary Follow-up to #1960, from a review of that PR. A relation with a foreign key hint and no alias, such as a hand-written `PostgrestToOneRelation('users!messages_username_fkey', ...)`, was addressed by its hinted name everywhere outside the `select` list. PostgREST matches those paths against the alias or the table name only. Checked against the local stack: | Request | Result | |---|---| | `messages.limit=1` | applied, 1 row | | `messages!username.limit=1` | silently ignored, every row | | `order=users(username).desc` | applied | | `order=users!username(username).desc` | PGRST100 parse error | Outside the `select` list, the embed is now addressed by its alias, or by the table name without the hint. This fixes `embedded()` scopes, and also the to-one `order` keys and `embeddedFilterName`, which had the same bug before #1960. Typegen always pairs a hint with an alias, so generated tables were not affected. ## Other changes - The `embedded()` dartdoc now says exactly what a repeated call does: a later limit replaces only the limit, and a later range replaces both the offset and the limit. - The untyped `order()` merges its key through `appendOrderKey` instead of duplicating the merge logic. - In `MIGRATION.md`, the foreign key paragraph is back next to the relation text it explains, and the snippet is wrapped to 80 characters. ## Testing - New unit tests cover a hinted embed with no alias in a scope, in an order key and in a filter name. - The full postgrest suite passes against the local stack (623 tests). `melos analyze` and `dcm analyze` are clean. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Bug Fixes** * Embedded ordering and filters now correctly use the referenced table name when a foreign-key hint is present without an alias, while preserving the hint in the select expression. * **Documentation** * Clarified how to address embedded relations when multiple foreign keys point to the same table. * Updated guidance on how repeated embedded sort keys, limits, and ranges are applied. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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
1 participant
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 typed
order()had no way to address an embed, and the typedlimit()andrange()still took an untypedString? referencedTable. Sorting the rows inside a to-many embed was therefore impossible on the typed surface, solimit(1, referencedTable: 'books')trimmed an unsorted embed and returned an arbitrary row.This adds
embedded()to the typed transform builder, following the scope Swift shipped in supabase/supabase-swift#1458:embedded()takes aPostgrestToManyRelation<Row, Target>. The callback receives aPostgrestEmbeddedScope<Target>, so ordering by a column of another table does not compile.order,limit,rangeandembedded. Nested scopes render dotted paths, such asbooks.reviews.limit=3.Breaking
The typed
limit()andrange()no longer takereferencedTable. The typed surface is experimental, so the change is covered in the "Moving fromfrom()to the typed table API" section ofMIGRATION.mdand not as its own breaking section.Out of scope
Filtering inside an embed and the
requiring(!inner) counterpart will ship together in a follow-up. An embedded filter withoutrequiringsilently keeps every parent row.Other changes
PostgrestTableRequestis now@internal. It was already hidden from the package export, and the annotation keeps its fields out of the compliance symbol check.PostgrestEmbeddedPage. It was internal, and the scope replaces it.database.using_modifiers.relationship_embedinsdk-compliance.yaml.Testing
typed_query_test.dartcover rendering, nesting, aliases, repeated scopes and mutations.resource_embedding_test.dartchecks ordering, limit and range against the local stack.melos analyze,dcm analyzeand the local compliance symbol check are clean.Summary by CodeRabbit
New Features
PostgrestEmbeddedPageis now available through the public library exports.Changes
limit()andrange()now apply to top-level results only; use embedded options to paginate embedded rows.