typesafe_supabase library

The Supabase client library extracted in order to enable mocking and testing in other packages.

Classes

SupaAllModifier<B extends SupaCore, R extends SupaRecord<B>>

A modifier that does not modify the query but returns all possible records.

SupaColumn<B extends SupaCore, T, J>

An annotation to let the generator know that the field is a column of a Supabase table.

SupaColumnBase<B extends SupaCore>

The base class for all SupaColumn and SupaTableJoin classes.

SupaColumnHere<T>

An annotation to let the generator know that the field is a column of a Supabase table.

SupaContainedByArrayFilter<B extends SupaCore, T, J>

Array column contained by array value

SupaContainedByJSONFilter<B extends SupaCore>

Jsonb column contained by json value

SupaContainedByRangeFilter<B extends SupaCore, J extends Object>

Range column contained by range value

SupaContainsArrayFilter<B extends SupaCore, J>

Array column contains every element in a value

SupaContainsJSONFilter<B extends SupaCore>

Jsonb column contains every element in a value

SupaContainsRangeFilter<B extends SupaCore, J extends Object>

Range column contains every element in a value

SupaCore

The base class that links all classes for one table together to create full type safety.

SupaCountModifier<B extends SupaCore, R extends SupaRecord<B>>

Count the number of records

SupaCountResponse<B extends SupaCore, R extends SupaRecord<B>>

A response from a SupaCountModifier containing the number of records in the response and the records themselves.

SupaCSVModifier<B extends SupaCore, R extends SupaRecord<B>>

Retrieve as a CSV

SupaEqualFilter<B extends SupaCore>

Column is equal to a value

SupaEqualStreamFilter<B extends SupaCore>

Column is equal to a value

SupaFilter<B extends SupaCore>

Represents a filter that can be applied to a Supabase query.

SupaFilterFilter<B extends SupaCore>

Match the filter

SupaGreaterFilter<B extends SupaCore>

Column is greater than a value

SupaGreaterOrEqualFilter<B extends SupaCore>

Column is greater than or equal to a value

SupaGreaterOrEqualStreamFilter<B extends SupaCore>

Column is greater than or equal to a value

SupaGreaterStreamFilter<B extends SupaCore>

Column is greater than a value

SupaIncludedInFilter<B extends SupaCore, J>

Column is in an array

SupaIncludedInStreamFilter<B extends SupaCore, J>

Column is in an array

SupaInsert<B extends SupaCore>

Represents an insert operation on a Supabase table.

SupaIsNullFilter<B extends SupaCore>

Column is equal to null

SupaLessFilter<B extends SupaCore>

Column is less than a value

SupaLessOrEqualFilter<B extends SupaCore>

Column is less than or equal to a value

SupaLessOrEqualStreamFilter<B extends SupaCore>

Column is less than or equal to a value

SupaLessStreamFilter<B extends SupaCore>

Column is less than a value

SupaLikeFilter<B extends SupaCore>

Column matches a pattern

SupaLimitModifier<B extends SupaCore, R extends SupaRecord<B>>

Limit the number of rows returned

SupaLimitStreamModifier<B extends SupaCore, R extends SupaRecord<B>>

Limit the number of rows returned

SupaMatchFilter<B extends SupaCore>

Match an associated value

SupaMaybeSingleModifier<B extends SupaCore, R extends SupaRecord<B>>

Retrieve zero or one row of data

SupaModifier<B extends SupaCore, R extends SupaRecord<B>, T, O extends PostgrestBuilder, I extends PostgrestBuilder>

Represents a modifier that can be applied to a Supabase query.

SupaNoneModifier<B extends SupaCore, R extends SupaRecord<B>>

A modifier that does not modify the query. Used for when no data needs to be retrieved.

SupaNotEqualFilter<B extends SupaCore>

Column is not equal to a value

SupaNotEqualStreamFilter<B extends SupaCore>

Column is not equal to a value

SupaNotFilter<B extends SupaCore>

Don't match the filter

SupaOrderModifier<B extends SupaCore, R extends SupaRecord<B>>

Order the results

SupaOrderStreamModifier<B extends SupaCore, R extends SupaRecord<B>>

Order the results

SupaOrFilter<B extends SupaCore>

Match at least one filter

SupaOverlapsArrayFilter<B extends SupaCore, J>

Array with a common element

SupaOverlapsRangeFilter<B extends SupaCore, J extends Object>

Range with a common element

SupaRangeAdjacentFilter<B extends SupaCore, J extends Object>

Mutually exclusive to a range

SupaRangeGreaterFilter<B extends SupaCore, J extends Object>

Greater than a range

SupaRangeGreaterOrEqualFilter<B extends SupaCore, J extends Object>

Greater than or equal to a range

SupaRangeLessFilter<B extends SupaCore, J extends Object>

Less than a range

SupaRangeLessOrEqualFilter<B extends SupaCore, J extends Object>

Less than or equal to a range

SupaRangeModifier<B extends SupaCore, R extends SupaRecord<B>>

Limit the query to a range

SupaRecord<B extends SupaCore>

Represents a record fetched from a Supabase table.

SupaSingleModifier<B extends SupaCore, R extends SupaRecord<B>>

Retrieve one row of data

SupaStreamFilter<B extends SupaCore>

Represents a filter that can be applied to a Supabase stream query.

SupaStreamModifier<B extends SupaCore, R extends SupaRecord<B>>

Represents a modifier that can be applied to a Supabase stream query.

SupaTable<B extends SupaCore, R extends SupaRecord<B>>

Represents a table in the Supabase database.

SupaTableHere

Represents a table in the Supabase database.

SupaTableJoin<B extends SupaCore, A extends SupaCore>

Represents a join between two tables in the Supabase database.

SupaTableJoinHere<A extends SupaTable>

An annotation to let the generator know that the field is a join between two tables in the Supabase database.

SupaTextSearchFilter<B extends SupaCore>

Match a string

SupaValue<B extends SupaCore, T, J>

Represents a value that is stored within a record from a Supabase table.

Enums

SupaJoinType

Represents the possible ways in which two tables can be joined.

SupaRangeType

Represents the type of range.

Mixins

SupaFilterMixin<B extends SupaCore>

A mixin that provides filters.

SupaModifierMixin<B extends SupaCore, R extends SupaRecord<B>>

A mixin that provides modifiers.

SupaStreamFilterMixin<B extends SupaCore>

A mixin that provides stream filters.

SupaStreamModifierMixin<B extends SupaCore, R extends SupaRecord<B>>

A mixin that provides modifiers.

Extensions

SupaListModifierExtension on SupaModifier<B, R, dynamic, PostgrestTransformBuilder<List<Map<String, dynamic>>>, PostgrestTransformBuilder<List<Map<String, dynamic>>>>

An extension on SupaModifiers that return a list of records.

SupaRecordModifierExtension on SupaModifier<B, R, dynamic, PostgrestTransformBuilder<Map<String, dynamic>>, PostgrestTransformBuilder>

An extension on SupaModifiers that return a single record.

SupaStreamModifierExtension on SupaStreamModifier<B, R>

An extension on a SupaStreamModifier.

Exceptions / Errors

SupaException

Represents an exception that occurred within the Supabase package.