supabase / supabase-flutter / 39618919877

92%

Build Type

push

github

Committed by web-flow

Commit Message

feat(postgrest): count the rows of a to-many relation without aggregates (#2005)

## Summary

`PostgrestDerivedExpression.countAll()` and the column aggregates need
PostgREST's `db-aggregates-enabled`, which is off by default, so
counting related rows on the typed API failed on a default project.
PostgREST accepts an embed of `count` without that setting, and this
adds a typed way to send it.

`PostgrestToManyRelation.count()` returns a `PostgrestEmbeddedCount`
that:

* renders `"messages(count)":messages(count)`, under an alias of its own
so it never merges with other entries of the relation
(`messages(id),"messages(count)":messages(count)` is accepted and
returns both)
* keys an aliased relation by the alias,
`"child_orders(count)":orders!orders_parent_id_fkey(count)`
* reads as `int` straight from the `PostgrestPartialRow`

```dart
final channels = await client
    .table(Channels.table)
    .selectOnly([Channels.id, Channels.messages.count()]);
final int messageCount = channels.first.read(Channels.messages.count());
```

It is only on to-many relations, since a to-one embed has at most one
row.

## Testing

* Unit tests for rendering, aliasing, nesting and reading.
* An integration test against the local stack (aggregates disabled) that
counts messages per user alongside a column embed of the same relation,
including zero counts.

Resolves SDK-2312

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

<!-- coderabbit-ai-generated:v1 -->

## Summary by CodeRabbit

- **New Features**
- Added support for counting rows in embedded to-many relations without
selecting aggregate data.
- Relation counts can be aliased, nested within parent embeds, selected
alongside other relation fields, and decoded as integers.
- Counts accurately report zero for empty relations while preserving
embedded row data.

- **Documentation**
- Clarified that relation counts include embedded rows without
aggregates.

<!-- end of auto-generated comment: re... (continued)

Coverage Stats

18 of 19 new or added lines in 3 files covered. (94.74%)

24 existing lines in 3 files now uncovered.

10623 of 11566 relevant lines covered (91.85%)

5.37 hits per line