Schema class
- Available extensions
Constructors
Properties
-
foreignKeys
→ List<
String> -
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
-
indexes
→ List<
String> -
no setter
- primaryAlgorithm → String
-
no setter
- primaryField → String
-
no setter
-
queries
→ List<
String> -
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- tableName → String
-
no setter
Methods
-
addColumn(
String name, String type, {bool nullable = false, dynamic length, bool unsigned = false, bool zeroFill = false, dynamic defaultValue, String? comment, String? collation, String? expression, String? virtuality, bool increment = false, bool unique = false}) → void -
addCompositeIndex(
String indexName, String columnName, ColumnIndex type) → void -
addCompositeUniqueConstraint(
String constraintName, List< String> columns) → void -
bigIncrements(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Add a big auto-incrementing column -
bigInt(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a big integer column -
binary(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a binary column -
bit(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a bit column -
blob(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a blob column -
boolean(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a boolean column -
char(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a char column -
date(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a date column -
dateTime(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a datetime column -
decimal(
String name, {int? precision, int? scale}) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a decimal column -
double(
String name, {int? precision, int? scale}) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a double column -
enumType(
String name, List< String> values) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create an enum column -
float(
String name, {int? precision, int? scale}) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a float column -
foreign(
String columnName, String referencesTable, String referencesColumn, {bool constrained = true, String onUpdate = 'CASCADE', String onDelete = 'CASCADE'}) → void -
generateCreateAlterSql(
String tableName, {bool ifNotExists = false, String beforeColumn = '', String afterColumn = ''}) → String -
generateCreateTableSql(
String tableName, {bool ifNotExists = false}) → String -
generateDropTableSql(
String tableName, {bool ifExists = false}) → String -
geometry(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a geometry column -
geometryCollection(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a geometry collection column -
id(
[String name = 'id']) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Add an auto-incrementing primary key column -
index(
ColumnIndex type, String name, List< String> columns) → void -
integer(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create an integer column -
json(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a JSON column -
lineString(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a line string geometry column -
longBlob(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a long blob column -
longText(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a long text column -
mediumBlob(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a medium blob column -
mediumInt(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a medium integer column -
mediumText(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a medium text column -
multiLineString(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a multi-line string geometry column -
multiPoint(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a multi-point geometry column -
multiPolygon(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a multi-polygon geometry column -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
point(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a point geometry column -
polygon(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a polygon geometry column -
primary(
String columnName, [String algorithm = 'BTREE']) → void -
registerColumnDefinition(
dynamic columnDefinition) → void -
reset(
) → void -
setTableName(
String tableName) → void -
setType(
String name, List< String> values) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a set column -
smallInt(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a small integer column -
softDeletes(
[String name = 'deleted_at']) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create soft delete timestamp -
string(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a string/varchar column -
text(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a text column -
time(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a time column -
timeStamp(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a timestamp column -
timeStamps(
) → void -
Available on Schema, provided by the ColumnTypes extension
Create standard timestamps (created_at, updated_at) -
tinyBlob(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a tiny blob column -
tinyInt(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a tiny integer column -
tinyText(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a tiny text column -
toString(
) → String -
A string representation of this object.
inherited
-
uuid(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a UUID column -
varBinary(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a variable binary column -
year(
String name) → ColumnDefinition -
Available on Schema, provided by the ColumnTypes extension
Create a year column
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited