Fetchable mixin

Mixin for tables that support incremental data fetching.

NTUT pages often provide partial information about related entities. For example, the course schedule table shows teacher names and IDs, but not their complete profile information.

This mixin enables a two-stage fetch pattern:

  1. Initial fetch: Insert row with basic info, fetchedAt = null (partial data)
  2. Detail fetch: Update row with complete info, set fetchedAt = now() (full data)

The fetchedAt field serves dual purposes:

  • Completeness indicator: null = partial data, non-null = complete data
  • Cache invalidation: timestamp indicates when complete data was last fetched
Superclass constraints
Mixin applications

Properties

customConstraints → List<String>
Custom table constraints that should be added to the table.
no setterinherited
dontWriteConstraints → bool
Drift will write some table constraints automatically, for instance when you override primaryKey. You can turn this behavior off if you want to. This is intended to be used by generated code only.
no setterinherited
fetchedAt → Column<DateTime>
Timestamp of when complete data was last fetched from the server.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
isStrict → bool
Whether this table is STRICT.
no setterinherited
primaryKey → Set<Column<Object>>?
Override this to specify custom primary keys:
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tableName → String?
The sql table name to be used. By default, drift will use the snake_case representation of your class name as the sql table name. For instance, a Table class named LocalSettings will be called local_settings by default. You can change that behavior by overriding this method to use a custom name. Please note that you must directly return a string literal by using a getter. For instance @override String get tableName => 'my_table'; is valid, whereas @override final String tableName = 'my_table'; or @override String get tableName => createMyTableName(); is not.
no setterinherited
uniqueKeys → List<Set<Column<Object>>>?
Unique constraints in this table.
no setterinherited
withoutRowId → bool
Whether to append a WITHOUT ROWID clause in the CREATE TABLE statement. This is intended to be used by generated code only.
no setterinherited

Methods

blob() → ColumnBuilder<Uint8List>
Use this as the body of a getter to declare a column that holds arbitrary data blobs, stored as an Uint8List. Example:
inherited
boolean() → ColumnBuilder<bool>
Use this as the body of a getter to declare a column that holds bools. Example (inside the body of a table class):
inherited
customType<T extends Object>(UserDefinedSqlType<T> type) → ColumnBuilder<T>
Defines a column with a custom type when used as a getter.
inherited
dateTime() → ColumnBuilder<DateTime>
Use this as the body of a getter to declare a column that holds date and time values.
inherited
int64() → ColumnBuilder<BigInt>
Use this as the body of a getter to declare a column that holds a 64-big integer as a BigInt.
inherited
integer() → ColumnBuilder<int>
Use this as the body of a getter to declare a column that holds integers.
inherited
intEnum<T extends Enum>() → ColumnBuilder<int>
Creates a column to store an enum class T.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
real() → ColumnBuilder<double>
Use this as the body of a getter to declare a column that holds floating point numbers. Example
inherited
sqliteAny() → ColumnBuilder<DriftAny>
Use this as a the body of a getter to declare a column that holds arbitrary values not modified by drift at runtime.
inherited
text() → ColumnBuilder<String>
Use this as the body of a getter to declare a column that holds strings. Example (inside the body of a table class):
inherited
textEnum<T extends Enum>() → ColumnBuilder<String>
Creates a column to store an enum class T.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited