Blueprint class
Used to define the schema of a database table
Properties
-
columns
→ List<
ColumnDefinition> -
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
indexes
→ List<
IndexDefinition> -
final
- primaryKey ↔ IndexDefinition?
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- table → String
-
final
-
uniques
→ List<
IndexDefinition> -
final
Methods
-
array(
String name) → ColumnDefinition - Array (ARRAY)
-
bigIncrements(
[String name = 'id']) → ColumnDefinition - Auto-incrementing BIGINT primary key
-
bigInteger(
String name) → ColumnDefinition - Big Integer (BIGINT)
-
binary(
String name, {int length = 255}) → ColumnDefinition - Binary
-
blob(
String name) → ColumnDefinition - Blob
-
boolean(
String name) → ColumnDefinition - Boolean
-
char(
String name, {int length = 255}) → ColumnDefinition - Char (CHAR)
-
date(
String name) → ColumnDefinition - Date
-
dateTime(
String name) → ColumnDefinition - DateTime
-
decimal(
String name, {int? total, int? places}) → ColumnDefinition - Decimal (DECIMAL)
-
double(
String name, {int? total, int? places}) → ColumnDefinition - Double (DOUBLE)
-
enumColumn(
String name, List< String> values) → ColumnDefinition - ENUM column
-
float(
String name, {int? total, int? places}) → ColumnDefinition - Float (FLOAT)
-
foreignId(
String name) → ColumnDefinition - Foreign ID (unsigned BIGINT)
-
foreignIdFor(
String? column, String key = 'id'}) → ColumnDefinition - Foreign ID with constraint shortcut
-
foreignUuid(
String name) → ColumnDefinition - Foreign UUID (CHAR(36))
-
foreignUuidFor(
String? column, String key = 'uuid'}) → ColumnDefinition - Foreign UUID with constraint shortcut
-
id(
[String name = 'id']) → ColumnDefinition - Primary Auto-Increment ID
-
increments(
[String name = 'id']) → ColumnDefinition - Auto-incrementing INT primary key
-
index(
List< String> columns, {String? name}) → void - Add an index on columns
-
integer(
String name) → ColumnDefinition - Integer (INT)
-
json(
String name) → ColumnDefinition - JSON
-
jsonb(
String name) → ColumnDefinition - JSONB (alias to JSON)
-
longBlob(
String name) → ColumnDefinition - Long Blob
-
longText(
String name) → ColumnDefinition - Long Text (LONGTEXT)
-
mediumBlob(
String name) → ColumnDefinition - Medium Blob
-
mediumInteger(
String name) → ColumnDefinition - Medium Integer (MEDIUMINT)
-
mediumText(
String name) → ColumnDefinition - Medium Text (MEDIUMTEXT)
-
morphs(
String name) → void - Adds morphs (polymorphic relations)
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
nullableMorphs(
String name) → void - Adds nullable morphs (polymorphic relations)
-
primary(
List< String> columns, {String? name}) → void - Add a primary key for columns
-
raw(
ColumnDefinition column) → void - Adds custom column directly
-
smallInteger(
String name) → ColumnDefinition - Small Integer (SMALLINT)
-
softDeletes(
{String name = 'deleted_at'}) → void - Adds deleted_at timestamp (soft delete)
-
string(
String name, {int length = 255}) → ColumnDefinition - String (VARCHAR)
-
text(
String name) → ColumnDefinition - Text (TEXT)
-
time(
String name) → ColumnDefinition - Time
-
timestamp(
String name) → ColumnDefinition - Timestamp
-
timestamps(
{bool useCurrent = false, bool useCurrentOnUpdate = true}) → void - Adds created_at & updated_at timestamps
-
timestampsTz(
{bool useCurrent = false, bool useCurrentOnUpdate = true}) → void - Adds created_at & updated_at timestamps (alias)
-
timestampTz(
String name) → ColumnDefinition - Timestamp (alias)
-
tinyInteger(
String name) → ColumnDefinition - Tiny Integer (TINYINT)
-
tinyText(
String name) → ColumnDefinition - Tiny Text (TINYTEXT)
-
toString(
) → String -
A string representation of this object.
inherited
-
unique(
List< String> columns, {String? name}) → void - Add a unique index on columns
-
unsignedBigInteger(
String name) → ColumnDefinition - Unsigned Big Integer (BIGINT)
-
unsignedInteger(
String name) → ColumnDefinition - Unsigned Integer (INT)
-
uuid(
String name) → ColumnDefinition - UUID column (CHAR(36))
-
uuidPrimary(
[String name = 'uuid']) → ColumnDefinition - UUID primary key (CHAR(36))
-
varBinary(
String name, {int length = 255}) → ColumnDefinition - VarBinary
-
year(
String name) → ColumnDefinition - Year
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited