SupaTable<B extends SupaCore, R extends SupaRecord<B> > class
Represents a table in the Supabase database.
- Mixed-in types
-
- SupaFilterMixin<
B> - SupaModifierMixin<
B, R> - SupaStreamFilterMixin<
B> - SupaStreamModifierMixin<
B, R>
- SupaFilterMixin<
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
primaryKey
→ List<
String> -
The primary key of the table.
final
-
recordFromJSON
→ R Function(Map<
String, dynamic> json) -
Converts a JSON map to a record.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- schema → String
-
The schema of the table. Defaults to
public.final - supabaseClient → SupabaseClient
-
The client instance used to interact with supabase.
final
- tableName → String
-
The name of the table.
final
Methods
-
all(
) → SupaAllModifier< B, R> -
A modifier that does not modify the query but returns all possible records.
inherited
-
containedByArray<
J> (SupaColumn< B, dynamic, List< column, List<J> ?>J> value) → SupaFilter<B> -
Array column contained by array value
inherited
-
containedByJSON(
SupaColumn< B, dynamic, Map< column, Map<String, dynamic> ?>String, dynamic> value) → SupaFilter<B> -
Jsonb column contained by json value
inherited
-
containedByRange<
J extends Object> (SupaColumn< B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B> -
Range column contained by range value
inherited
-
containsArray<
J> (SupaColumn< B, dynamic, List< column, List<J> ?>J> values) → SupaFilter<B> -
Array column contains every element in a value
inherited
-
containsJSON(
SupaColumn< B, dynamic, Map< column, Map<String, dynamic> ?>String, dynamic> json) → SupaFilter<B> -
Jsonb column contains every element in a value
inherited
-
containsRange<
J extends Object> (SupaColumn< B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B> -
Range column contains every element in a value
inherited
-
count(
[CountOption option = CountOption.exact]) → SupaCountModifier< B, R> -
Count the number of records
inherited
-
csv(
) → SupaCSVModifier< B, R> -
Retrieve as a CSV
inherited
-
delete<
T> ({required SupaFilter< B> filter, required SupaModifier<B, R, T, PostgrestBuilder, PostgrestBuilder> modifier, Set<SupaColumnBase< ? columns}) → Future<B> >T> - Deletes records from the Supabase table.
-
equal(
SupaValue< B, dynamic, dynamic> value) → SupaFilter<B> -
Column is equal to a value
inherited
-
fetch<
T> ({required SupaModifier< B, R, T, PostgrestBuilder, PostgrestBuilder> modifier, SupaFilter<B> ? filter, Set<SupaColumnBase< ? columns}) → Future<B> >T> - Fetches records from the Supabase table.
-
filter(
String column, String operator, Object? value) → SupaFilter< B> -
Match the filter
inherited
-
greater(
SupaValue< B, dynamic, Object?> value) → SupaFilter<B> -
Column is greater than a value
inherited
-
greaterOrEqual(
SupaValue< B, dynamic, Object?> value) → SupaFilter<B> -
Column is greater than or equal to a value
inherited
-
includedIn<
J> (SupaColumn< B, dynamic, J?> column, List<J> values) → SupaFilter<B> -
Column is in an array
inherited
-
insert<
T> ({required List< SupaInsert< records, required SupaModifier<B> >B, R, T, PostgrestBuilder, PostgrestBuilder> modifier, Set<SupaColumnBase< ? columns}) → Future<B> >T> - Inserts records into the Supabase table.
-
isNull(
SupaColumn< B, dynamic, Object?> column) → SupaFilter<B> -
Column is equal to null
inherited
-
less(
SupaValue< B, dynamic, Object?> value) → SupaFilter<B> -
Column is less than a value
inherited
-
lessOrEqual(
SupaValue< B, dynamic, Object?> value) → SupaFilter<B> -
Column is less than or equal to a value
inherited
-
like(
SupaColumn< B, dynamic, String?> column, String pattern, {bool isCaseSensitive = true}) → SupaFilter<B> -
Column matches a pattern
inherited
-
limit(
int count) → SupaLimitModifier< B, R> -
Limit the number of rows returned
inherited
-
match(
Set< SupaValue< values) → SupaFilter<B, dynamic, dynamic> >B> -
Match an associated value
inherited
-
maybeSingle(
) → SupaMaybeSingleModifier< B, R> -
Retrieve zero or one row of data
inherited
-
none(
) → SupaNoneModifier< B, R> -
A modifier that does not modify the query. Used for when no data needs to be
retrieved.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
not(
String column, String operator, Object? value) → SupaFilter< B> -
Don't match the filter
inherited
-
notEqual(
SupaValue< B, dynamic, dynamic> value) → SupaFilter<B> -
Column is not equal to a value
inherited
-
or(
String filter, {String? referencedTable}) → SupaFilter< B> -
Match at least one filter
inherited
-
order(
SupaColumn< B, dynamic, dynamic> column, {bool ascending = true, bool nullsFirst = false}) → SupaOrderModifier<B, R> -
Order the results
inherited
-
overlapsArray<
J> (SupaColumn< B, dynamic, List< column, List<J> ?>J> values) → SupaFilter<B> -
Array with a common element
inherited
-
overlapsRange<
J extends Object> (SupaColumn< B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B> -
Range with a common element
inherited
-
range(
int from, int to) → SupaRangeModifier< B, R> -
Limit the query to a range
inherited
-
rangeAdjacent<
J extends Object> (SupaColumn< B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B> -
Mutually exclusive to a range
inherited
-
rangeGreater<
J extends Object> (SupaColumn< B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B> -
Greater than a range
inherited
-
rangeGreaterOrEqual<
J extends Object> (SupaColumn< B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B> -
Greater than or equal to a range
inherited
-
rangeLess<
J extends Object> (SupaColumn< B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B> -
Less than a range
inherited
-
rangeLessOrEqual<
J extends Object> (SupaColumn< B, dynamic, dynamic> column, J lowerBound, J upperBound, {SupaRangeType rangeType = SupaRangeType.inclusiveInclusive}) → SupaFilter<B> -
Less than or equal to a range
inherited
-
sEqual(
SupaValue< B, dynamic, dynamic> value) → SupaStreamFilter<B> -
Column is equal to a value
inherited
-
sGreater(
SupaValue< B, dynamic, num?> value) → SupaStreamFilter<B> -
Column is greater than a value
inherited
-
sGreaterOrEqual(
SupaValue< B, dynamic, num?> value) → SupaStreamFilter<B> -
Column is greater than or equal to a value
inherited
-
sIncludedIn<
J> (SupaColumn< B, dynamic, List< column, List<J> ?>J> values) → SupaStreamFilter<B> -
Column is in an array
inherited
-
single(
) → SupaSingleModifier< B, R> -
Retrieve one row of data
inherited
-
sLess(
SupaValue< B, dynamic, num?> value) → SupaStreamFilter<B> -
Column is less than a value
inherited
-
sLessOrEqual(
SupaValue< B, dynamic, num?> value) → SupaStreamFilter<B> -
Column is less than or equal to a value
inherited
-
sLimit(
int count) → SupaLimitStreamModifier< B, R> -
Limit the number of rows returned
inherited
-
sNotEqual(
SupaValue< B, dynamic, dynamic> value) → SupaStreamFilter<B> -
Column is not equal to a value
inherited
-
sOrder(
SupaColumn< B, dynamic, dynamic> column, {bool ascending = true}) → SupaOrderStreamModifier<B, R> -
Order the results
inherited
-
stream(
{SupaStreamFilter< B> ? filter, SupaStreamModifier<B, R> ? modifier}) → Stream<List< R> > - Streams records from the Supabase table.
-
textSearch(
SupaValue< B, dynamic, String?> searchText, {String? config, TextSearchType? type}) → SupaFilter<B> -
Match a string
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update<
T> ({required Set< SupaValue< values, required SupaFilter<B, dynamic, dynamic> >B> filter, required SupaModifier<B, R, T, PostgrestBuilder, PostgrestBuilder> modifier, Set<SupaColumnBase< ? columns}) → Future<B> >T> - Updates records in the Supabase table.
-
upsert<
T> ({required List< SupaInsert< records, required SupaModifier<B> >B, R, T, PostgrestBuilder, PostgrestBuilder> modifier, SupaFilter<B> ? filter, Set<SupaColumnBase< ? columns}) → Future<B> >T> - Updates or inserts records in the Supabase table.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited