$UsersTable class - database library

Constructors

$UsersTable(GeneratedDatabase attachedDatabase, [String? _alias])

Properties

$columns → List<GeneratedColumn<Object>>: All columns from this table or view.
no setteroverride
$primaryKey → Set<GeneratedColumn<Object>>: The primary key of this table. Can be empty if no custom primary key has been specified.
no setteroverride
actualTableName → String: The name of the table in the database. Unlike aliasedName, this can not be aliased.
no setteroverride
aliasedName → String: The (potentially aliased) name of this table or view.
no setteroverride
asDslTable → $UsersTable: Type system sugar. Implementations are likely to inherit from both TableInfo and Tbl and can thus just return their instance.
no setterinherited
attachedDatabase → GeneratedDatabase: The generated database instance that this view or table is attached to.
final
avatarFilename → GeneratedColumn<String>: Filename of the user's avatar image stored locally.
latefinal
columnsByName → Map<String, GeneratedColumn<Object>>: Gets all $columns in this table or view, indexed by their (non-escaped) name.
no setterinherited
customConstraints → List<String>: Custom table constraints that should be added to the table.
no setterinherited
dateOfBirth → GeneratedColumn<DateTime>: Student's date of birth.
latefinal
departmentEn → GeneratedColumn<String>: Department name in English (e.g., "Electronic Engineering").
latefinal
departmentZh → GeneratedColumn<String>: Department name in Chinese (e.g., "電子工程系").
latefinal
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
email → GeneratedColumn<String>: User's email address.
latefinal
entityName → String: The (unalised) name of this entity in the database.
no setterinherited
fetchedAt → GeneratedColumn<DateTime>: Timestamp of when complete data was last fetched from the server.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id → GeneratedColumn<int>: Auto-incrementing primary key.
latefinal
isStrict → bool: Whether this table is STRICT.
no setterinherited
nameEn → GeneratedColumn<String>: Student's name in English.
latefinal
nameZh → GeneratedColumn<String>: Student's name in Chinese.
latefinal
passwordExpiresInDays → GeneratedColumn<int>: Number of days until the user's password expires.
latefinal
primaryKey → Set<Column<Object>>: Override this to specify custom primary keys:
no setterinherited
programEn → GeneratedColumn<String>: Program name in English (e.g., "4-Year Undergraduate Program").
latefinal
programZh → GeneratedColumn<String>: Program name in Chinese (e.g., "四技日間").
latefinal
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
semestersFetchedAt → GeneratedColumn<DateTime>: When the semester list was last fetched from the course system.
latefinal
studentId → GeneratedColumn<String>: Unique student ID (學號).
latefinal
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<GeneratedColumn<Object>>>: The unique key of this table. Can be empty if no custom primary key has been specified.
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
createAlias(String alias) → $UsersTable: Creates an alias of this table or view that will write the name alias when used in a query.
override
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
map(Map<String, dynamic> data, {String? tablePrefix}) → User: Maps the given row returned by the database into the fitting data class.
override
mapFromCompanion(Insertable<User> companion, DatabaseConnectionUser database) → Future<User>: Converts a companion to the real model class, D.
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
validateIntegrity(Insertable<User> instance, {bool isInserting = false}) → VerificationContext: Validates that the given entity can be inserted into this table, meaning that it respects all constraints (nullability, text length, etc.).
override

Operators

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

Constants

$name → const String