ForeignIdDefinition class final

A foreignId() column that can be constrained().

Inheritance

• Object
• ColumnDefinition
• ForeignIdDefinition

Constructors

ForeignIdDefinition(String name, ColumnType type, Blueprint _blueprint)

Properties

allowed → List<String>

Allowed values for ColumnType.enumeration.

final, inherited

commentText → String?

no setter, inherited

defaultValue → Object?

no setter, inherited

hasDefault → bool

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hasIndex → bool

no setter, inherited

isAutoIncrement → bool

no setter, inherited

isChange → bool

no setter, inherited

isNullable → bool

no setter, inherited

isPrimary → bool

no setter, inherited

isUnique → bool

no setter, inherited

isUnsigned → bool

no setter, inherited

length → int?

final, inherited

name → String

final, inherited

precision → int?

final, inherited

rawDefault → String?

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scale → int?

final, inherited

type → ColumnType

final, inherited

usesCurrent → bool

no setter, inherited

Methods

change() → ColumnDefinition

Marks the column as a modification of an existing column (Schema.table only).

inherited

comment(String text) → ColumnDefinition

inherited

constrained([String? table, String column = 'id']) → ForeignKeyDefinition

Adds a foreign key to table (guessed from the column name: user_id → users) referencing column.

defaultRaw(String expression) → ColumnDefinition

Raw SQL default (defaultRaw('CURRENT_TIMESTAMP')).

inherited

defaultTo(Object? value) → ColumnDefinition

inherited

index() → ColumnDefinition

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

nullable([bool value = true]) → ForeignIdDefinition

override

primary() → ColumnDefinition

inherited

toString() → String

A string representation of this object.

inherited

unique() → ColumnDefinition

inherited

unsigned() → ColumnDefinition

inherited

useCurrent() → ColumnDefinition

DEFAULT CURRENT_TIMESTAMP for timestamp columns.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

guessTable(String column) → String

user_id → users, category_id → categories.