GeneratedColumn<T> class

Implementation for a Column declared on a table.

Inheritance
Implementers
Available Extensions

Constructors

GeneratedColumn(String $name, String tableName, bool $nullable, {T clientDefault()?, required SqlType type, String? defaultConstraints, String? $customConstraints, Expression<T>? defaultValue, VerificationResult additionalChecks(T, VerificationMeta)?, bool requiredDuringInsert = false, GeneratedAs? generatedAs, Expression<bool?> check()?})
Used by generated code.

Properties

$customConstraints → String?
Custom constraints that have been specified for this column.
final
$name → String
The sql name of this column.
final
$nullable → bool
Whether null values are allowed for this column.
final
additionalChecks → (VerificationResult Function(T, VerificationMeta)?)
Additional checks performed on values before inserts or updates.
final
check → (Expression<bool?> Function()?)
A CHECK column constraint present on this column.
final
clientDefault → (T Function()?)
A function that yields a default column for inserts if no value has been set. This is different to defaultValue since the function is written in Dart, not SQL. It's a compile-time error to declare columns where both defaultValue and clientDefault are non-null.
final
defaultValue → Expression<T>?
The default expression to be used during inserts when no value has been specified. Can be null if no default value is set.
final
escapedName → String
name, but escaped if it's an sql keyword.
no setterinherited
generatedAs → GeneratedAs?
If this column is generated (that is, it is a SQL expression of other) columns, contains information about how to generate this column.
final
hasAutoIncrement → bool
Whether this column has an AUTOINCREMENT primary key constraint that was created by drift.
no setter
hashCode → int
The hash code for this object.
no setteroverride
isLiteral → bool
Whether this expression is a literal. Some use-sites need to put parentheses around non-literals.
no setterinherited
name → String
The (unescaped) name of this column.
no setteroverride
precedence → Precedence
The precedence of this expression. This can be used to automatically put parentheses around expressions as needed.
finalinherited
requiredDuringInsert → bool
Whether a value is required for this column when inserting a new row.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tableName → String
The name of the table that contains this column
final
type → SqlType
The sql type, such as StringType for texts.
final
typeName → String
The sql type name, such as TEXT for texts.
no setter

Methods

caseMatch<T>({required Map<Expression<T>, Expression<T?>> when, Expression<T?>? orElse}) → Expression<T?>
A CASE WHEN construct using the current expression as a base.
inherited
cast<D2>() → Expression<D2>
Generates a CAST(expression AS TYPE) expression.
inherited
dartCast<D2>() → Expression<D2>
Casts this expression to an expression of D.
inherited
equals(T compare) → Expression<bool>
Whether this column is equal to the given value, which must have a fitting type. The compare value will be written as a variable using prepared statements, so there is no risk of an SQL-injection.
inherited
equalsExp(Expression<T> compare) → Expression<bool>
Whether this expression is equal to the given expression.
inherited
findType(SqlTypeSystem types) → SqlType<T>
Finds the runtime implementation of D in the provided types.
inherited
isAcceptableOrUnknown(Expression value, VerificationMeta meta) → VerificationResult
A more general version of isAcceptableValue that supports any sql expression.
isAcceptableValue(T value, VerificationMeta meta) → VerificationResult
Checks whether the given value fits into this column. The default implementation only checks for nullability, but subclasses might enforce additional checks. For instance, a text column might verify that a text has a certain length.
isIn(Iterable<T> values) → Expression<bool?>
An expression that is true if this resolves to any of the values in values.
inherited
isInQuery(BaseSelectStatement select) → Expression<bool?>
An expression checking whether this is included in any row of the provided select statement.
inherited
isNotIn(Iterable<T> values) → Expression<bool?>
An expression that is true if this does not resolve to any of the values in values.
inherited
isNotInQuery(BaseSelectStatement select) → Expression<bool?>
An expression checking whether this is not included in any row of the provided select statement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
withConverter<D>(TypeConverter<D, T> converter) → GeneratedColumnWithTypeConverter<D, T>
Applies a type converter to this column.
writeAroundPrecedence(GenerationContext context, Precedence precedence) → void
Writes this expression into the GenerationContext, assuming that there's an outer expression with precedence. If the Expression.precedence of this expression is lower, it will be wrap}ped in
inherited
writeColumnDefinition(GenerationContext into) → void
Writes the definition of this column, as defined here, into the given buffer.
writeInner(GenerationContext ctx, Expression inner) → void
If this Expression wraps an inner expression, this utility method can be used inside writeInto to write that inner expression while wrapping it in parentheses if necessary.
inherited
writeInto(GenerationContext context, {bool ignoreEscape = false}) → void
Writes this component into the context by writing to its GenerationContext.buffer or by introducing bound variables. When writing into the buffer, no whitespace around the this component should be introduced. When a component consists of multiple composed component, it's responsible for introducing whitespace between its child components.
override

Operators

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

Static Methods

checkTextLength({int? minTextLength, int? maxTextLength}) → VerificationResult Function(String?, VerificationMeta)
A value for additionalChecks validating allowed text lengths.