TableInfo<TableDsl extends Table, D> mixin

Base class for generated table classes.

Drift generates a subclass of TableInfo for each table used in a database. This classes contains information about the table's schema (e.g. its primaryKey or $columns).

TableDsl is the original table class written by the user. For tables defined in drift files, this is the table implementation class itself. D is the type of the data class generated from the table.

To obtain an instance of this class, use a table getter from the database.

Superclass Constraints
Implemented types

Properties

$columns → List<GeneratedColumn>
All columns from this table or view.
no setterinherited
$primaryKey → Set<GeneratedColumn>
The primary key of this table. Can be empty if no custom primary key has been specified.
no setter
$tableName → String
The table name in the sql table. This can be an alias for the actual table name. See actualTableName for a table name that is not aliased.
no setter
actualTableName → String
The name of the table in the database. Unless $tableName, this can not be aliased.
no setter
aliasedName → String
The (potentially aliased) name of this table or view.
no setteroverride
asDslTable → TableDsl
Type system sugar. Implementations are likely to inherit from both TableInfo and Tbl and can thus just return their instance.
no setteroverride
attachedDatabase → DatabaseConnectionUser
The generated database instance that this view or table is attached to.
no setterinherited
columnsByName → Map<String, GeneratedColumn>
Gets all $columns in this table, indexed by their (non-escaped) name.
no setter
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
entityName → String
The (unalised) name of this entity in the database.
no setteroverride
hashCode → int
The hash code for this object.
no setteroverride
isStrict → bool
Whether this table is STRICT.
no setterinherited
primaryKey → Set<Column>
Override this to specify custom primary keys:
no setteroverride
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<GeneratedColumn>>
The unique key of this table. Can be empty if no custom primary key has been specified.
no setteroverride
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) → TableInfo<TableDsl, D>
Creates an alias of this table or view that will write the name alias when used in a query.
override
dateTime() → ColumnBuilder<DateTime>
Use this as the body of a getter to declare a column that holds date and time. Note that DateTime values are stored on a second-accuracy. Example (inside the body of a table class):
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>() → ColumnBuilder<int>
Creates a column to store an enum class T.
inherited
map(Map<String, dynamic> data, {String? tablePrefix}) → D
Maps the given row returned by the database into the fitting data class.
inherited
mapFromCompanion(Insertable<D> companion) → D
Converts a companion to the real model class, D.
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
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
toString() → String
A string representation of this object.
inherited
validateIntegrity(Insertable<D> 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.).

Operators

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