supabase / supabase-flutter / 33399042926

89%

push

github

feat(postgrest): add an isUnknown filter method (#1788)

## What

`PostgrestFilterBuilder.isFilter` takes a `bool?`, so it covers
`is.null`, `is.true` and `is.false`, but not PostgREST's fourth `is`
value, `unknown`.

Rather than replacing the `bool?` with an enum (a breaking change), this
adds a dedicated method for the rarely used state, as suggested in
https://github.com/supabase/supabase-flutter/issues/1609#issuecomment-5000621975:

```dart
await supabase.from('users').select().isUnknown('confirmed');
```

## Changes

- `PostgrestFilterBuilder.isUnknown(String column)` appends
`is.unknown`, with a cross-reference from the `isFilter` docs.
- Test asserting the generated query parameter is `is.unknown` and that
PostgREST accepts the filter.
- Registered the new symbol under `database.using_filters.is` in
`sdk-compliance.yaml`.

## Notes

`isUnknown` was deliberately not added to `SupabaseStreamFilterBuilder`.
Realtime validates filter values by casting them to the column type
server-side, and `unknown` is not castable to boolean, so exposing it
there could not be verified to work. On a boolean column `is unknown` is
also equivalent to `is null`, which streams already support.

Closes #1609

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

## Summary by CodeRabbit

* **New Features**
* Added an `isUnknown` filter for querying rows where a SQL boolean
value is `UNKNOWN`.
  * Updated filter guidance to clarify when to use this option.

* **Documentation**
* Updated compliance documentation to include the new filter capability.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2 of 2 new or added lines in 1 file covered. (100.0%)

6100 of 6879 relevant lines covered (88.68%)

4.56 hits per line