typesafe_postgrest library

Classes

PgAsCSVModifier<TableType>
Retrieves the response as a CSV string.
PgAsRawModifier<TableType>
Retrieves the response as a List<Map<String, dynamic>>.
PgBigIntColumn<TableType>
Represents a column of type BigInt in a table.
PgBoolColumn<TableType>
Represents a column of type bool in a table.
PgColumn<TableType, ValueType, JsonValueType>
Represents a column in a table.
PgColumnHasDefault
An annotation that marks a column as having a default value.
PgContainedByArrayFilter<TableType, T>
Array column contained by array value.
PgContainedByJsonFilter<TableType>
Jsonb column contained by json value.
PgContainedByRangeFilter<TableType, T extends Object>
Range column contained by range value.
PgContainsArrayFilter<TableType, T>
Array column contains every element in a value.
PgContainsJsonFilter<TableType>
Jsonb column contains every element in a value.
PgContainsRangeFilter<TableType, T extends Object>
Range column contains every element in a value.
PgCountModifier<TableType>
Counts the number of records in the response.
PgDateTimeColumn<TableType>
Represents a column of type DateTime (timestamp without time zone) in a table.
PgDoubleColumn<TableType>
Represents a column of type double in a table.
PgEqualFilter<TableType, T>
Column is equal to a value.
PgFilter<TableType>
Represents a filter that can be applied to a postgrest query.
PgFilterColumn<TableType, ValueType, JsonValueType>
A helper class to only allow filtering with certain columns.
PgFilterFilter<TableType>
Match the filter.
PgGreaterFilter<TableType, T>
Column is greater than a value.
PgGreaterOrEqualFilter<TableType, T>
Column is greater than or equal to a value.
PgIncludedInFilter<TableType, T>
Column is in an array.
PgIntColumn<TableType>
Represents a column of type int in a table.
PgJoin<TableType, JoinedTableType>
Represents a join between two tables.
PgJoinToMany<TableType, JoinedTableType>
Represents a one-to-many or many-to-many join in a table.
PgJoinToOne<TableType, JoinedTableType>
Represents a many-to-one or one-to-one join in a table.
PgJsonColumn<TableType>
Represents a column of type Map<String, dynamic> in a table.
PgLessFilter<TableType, T>
Column is less than a value.
PgLessOrEqualFilter<TableType, T>
Column is less than or equal to a value
PgLikeFilter<TableType>
Column matches a pattern.
PgLimitModifier<TableType>
Limits the result with the specified count.
PgMaybeBigIntColumn<TableType>
Represents a column that can be null of type BigInt in a table.
PgMaybeBoolColumn<TableType>
Represents a column that can be null of type bool in a table.
PgMaybeDateTimeColumn<TableType>
Represents a column that can be null of type DateTime (timestamp without time zone) in a table.
PgMaybeDoubleColumn<TableType>
Represents a column that can be null of type double in a table.
PgMaybeIntColumn<TableType>
Represents a column that can be null of type int in a table.
PgMaybeJoinToOne<TableType, JoinedTableType>
Represents a many-to-one or one-to-one join in a table that could be null.
PgMaybeJsonColumn<TableType>
Represents a column that can be null of type Map<String, dynamic> in a table.
PgMaybeSingleModifier<TableType>
Retrieves only one row from the result if there is one.
PgMaybeStringColumn<TableType>
Represents a column that can be null of type String in a table.
PgMaybeUTCDateTimeColumn<TableType>
Represents a column that can be null of type DateTime (timestamp with time zone) in a table.
PgModel<TableType>
A custom return type for a query.
PgModelBuilder<TableType, ModelType extends PgModel<TableType>>
A helper class that contains all the necessary information to construct a custom PgModel of type ModelType from JSON.
PgModelHere
An annotation that marks a class as a PgModel for which an extension should be generated.
PgModifier<TableType, CurrentType, PreviousType>
Represents a modifier that can be applied to a postgrest query.
PgNoneModifier<TableType>
A modifier that does not modify the query. Used for when no data needs to be retrieved.
PgNotEqualFilter<TableType, T>
Column is not equal to a value.
PgNotFilter<TableType>
Don't match the filter.
PgNullable<T>
A nullable value.
PgOrderModifier<TableType>
Orders the result with the specified column.
PgOrFilter<TableType>
Match at least one filter.
PgOverlapsArrayFilter<TableType, T>
Array with a common element.
PgOverlapsRangeFilter<TableType, T extends Object>
Range column contains every element in a value.
PgQueryColumn<TableType, ValueType, JsonValueType>
A helper class to only allow querying certain columns.
PgRangeAdjacentFilter<TableType, T extends Object>
Mutually exclusive to a range.
PgRangeGreaterFilter<TableType, T extends Object>
Greater than a range.
PgRangeGreaterOrEqualFilter<TableType, T extends Object>
Greater than or equal to a range.
PgRangeLessFilter<TableType, T extends Object>
Less than a range.
PgRangeLessOrEqualFilter<TableType, T extends Object>
Less than or equal to a range.
PgRangeModifier<TableType>
Limits the result to rows within the specified range, inclusive.
PgSingleModifier<TableType>
Retrieves only one row from the result. Result must be one row (e.g. using limit), otherwise this will result in an error.
PgStringColumn<TableType>
Represents a column of type String in a table.
PgTable<TableType>
Represents a table in the postgres database.
PgTableHere
An annotation that marks a class as a PgTable for which an upsert should be generated.
PgTableName<TableType>
Represents the name of a table in the database.
PgTextSearchFilter<TableType>
Match a string.
PgUpsert<TableType>
Represents the data required to perform an insert or upsert operation.
PgUTCDateTimeColumn<TableType>
Represents a column of type DateTime (timestamp with time zone) in a table.
PgValue<TableType, ValueType, JsonValueType>
Represents the value of a column in a table.

Enums

CountOption
Returns count as part of the response when specified.
PgRangeType
Represents the type of a range.

Extensions

PgAllFilterColumnsX on PgFilterColumn<TableType, ValueType, JsonValueType>
Provides filters to all filter column types.
PgJsonFilterColumnX on PgFilterColumn<TableType, dynamic, PgJsonMap?>
Provides filters to json filter column types.
PgListFilterColumnX on PgFilterColumn<TableType, List<T>?, List?>
Provides filters to list filter column types.
PgListModifierX on PgModifier<TableType, PgJsonList, dynamic>
Provides modifiers that can be chained onto a list modifier.
PgMapModifierX on PgModifier<TableType, PgJsonMap, dynamic>
Provides modifiers that can be chained onto a map modifier.
PgMaybeMapModifierX on PgModifier<TableType, PgJsonMap?, dynamic>
Provides modifiers that can be chained onto a nullable map modifier.
PgStringFilterColumnX on PgFilterColumn<TableType, dynamic, String?>
Provides filters to string filter column types.
PgTableFilterX on PgTable<TableType>
Provides methods to start the filter chain.
PgTableModifierX on PgTable<TableType>
Provides modifiers that can start the modifier chain.

Functions

pgFilter<TableType>(String columnName, String operator, Object? value) → PgFilter<TableType>
Match the filter.
pgNot<TableType>(String columnName, String operator, Object? value) → PgFilter<TableType>
Don't match the filter.
pgOr<TableType>(String filters, {PgTableName? referencedTableName}) → PgFilter<TableType>

Typedefs

PgJsonList = PostgrestList
PgJsonMap = PostgrestMap
PgQueryColumnList<TableType> = List<PgQueryColumn<TableType, dynamic, dynamic>>
PgValuesList<TableType> = List<PgValue<TableType, dynamic, dynamic>>

Exceptions / Errors

PgMissingDataException
An exception thrown when a value that is missing in the JSON data is requested from a model.