feat(realtime): add realtime filter builder - #1380
Open
jan-tennert wants to merge 4 commits into
Open
Conversation
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.
What kind of change does this PR introduce?
Feature (closes #1343)
This pull request adds a new fluent builder API for constructing Postgres changes filter strings in Realtime channels, aligning filter support with PostgREST and improving developer experience. It introduces the
RealtimePostgresFilterBuilderclass and related types, expands filter operator support, and updates compliance documentation. Comprehensive tests are included to ensure correct behavior.Realtime Postgres filter builder API:
RealtimePostgresFilterBuilderclass, which provides a fluent DSL for building filter strings for Postgres changes subscriptions in Realtime, mirroring thepostgrest-ktfilter API. This includes methods for all supported operators, automatic value escaping, and support for combining multiple conditions.PostgresChangeFilter, allowing users to construct filters using the new DSL.Filter operator support and mapping:
Introduced the
RealtimePostgresChangesFilterOperatorenum to enumerate all supported filter operators for Realtime Postgres changes, and provided a mapping toFilterOperator.Added support for the
ISDISTINCToperator in bothFilterOperatorand the filter value escaping logic.Testing and compliance:
Added comprehensive tests for the new builder and operators in
RealtimePostgresFilterBuilderTestand extended tests forISDISTINCTinPostgrestFilterBuilderTest.Updated
sdk-compliance.yamlto markrealtime.subscriptions.postgres_changes_filteras fully implemented and list all new API symbols.