Blueprint
in package
Uses
Macroable
Table of Contents
- $charset : mixed
- The default character set that should be used for the table.
- $collation : mixed
- The collation that should be used for the table.
- $engine : string
- The storage engine that should be used for the table.
- $temporary : bool
- Whether to make the table temporary.
- $columns : array<string|int, Fluent>
- The columns that should be added to the table.
- $commands : array<string|int, Fluent>
- The commands that should be run for the table.
- $macros : array<string|int, mixed>
- The registered string macros.
- $table : string
- The table the blueprint describes.
- __call() : mixed
- Dynamically handle calls to the class.
- __callStatic() : mixed
- Dynamically handle calls to the class.
- __construct() : void
- Create a new schema blueprint.
- addColumn() : Fluent
- Add a new column to the blueprint.
- bigIncrements() : Fluent
- Create a new auto-incrementing big integer (8-byte) column on the table.
- bigInteger() : Fluent
- Create a new big integer (8-byte) column on the table.
- binary() : Fluent
- Create a new binary column on the table.
- boolean() : Fluent
- Create a new boolean column on the table.
- build() : void
- Execute the blueprint against the database.
- char() : Fluent
- Create a new char column on the table.
- create() : Fluent
- Indicate that the table needs to be created.
- date() : Fluent
- Create a new date column on the table.
- dateTime() : Fluent
- Create a new date-time column on the table.
- dateTimeTz() : Fluent
- Create a new date-time column (with time zone) on the table.
- decimal() : Fluent
- Create a new decimal column on the table.
- double() : Fluent
- Create a new double column on the table.
- drop() : Fluent
- Indicate that the table should be dropped.
- dropColumn() : Fluent
- Indicate that the given columns should be dropped.
- dropForeign() : Fluent
- Indicate that the given foreign key should be dropped.
- dropIfExists() : Fluent
- Indicate that the table should be dropped if it exists.
- dropIndex() : Fluent
- Indicate that the given index should be dropped.
- dropPrimary() : Fluent
- Indicate that the given primary key should be dropped.
- dropRememberToken() : void
- Indicate that the remember token column should be dropped.
- dropSoftDeletes() : void
- Indicate that the soft delete column should be dropped.
- dropSoftDeletesTz() : void
- Indicate that the soft delete column should be dropped.
- dropSpatialIndex() : Fluent
- Indicate that the given spatial index should be dropped.
- dropTimestamps() : void
- Indicate that the timestamp columns should be dropped.
- dropTimestampsTz() : void
- Indicate that the timestamp columns should be dropped.
- dropUnique() : Fluent
- Indicate that the given unique key should be dropped.
- enum() : Fluent
- Create a new enum column on the table.
- float() : Fluent
- Create a new float column on the table.
- foreign() : Fluent
- Specify a foreign key for the table.
- geometry() : Fluent
- Create a new geometry column on the table.
- geometryCollection() : Fluent
- Create a new geometrycollection column on the table.
- getAddedColumns() : array<string|int, Fluent>
- Get the columns on the blueprint that should be added.
- getChangedColumns() : array<string|int, Fluent>
- Get the columns on the blueprint that should be changed.
- getColumns() : array<string|int, Fluent>
- Get the columns on the blueprint.
- getCommands() : array<string|int, Fluent>
- Get the commands on the blueprint.
- getTable() : string
- Get the table the blueprint describes.
- hasMacro() : bool
- Checks if macro is registered.
- increments() : Fluent
- Create a new auto-incrementing integer (4-byte) column on the table.
- index() : Fluent
- Specify an index for the table.
- integer() : Fluent
- Create a new integer (4-byte) column on the table.
- ipAddress() : Fluent
- Create a new IP address column on the table.
- json() : Fluent
- Create a new json column on the table.
- jsonb() : Fluent
- Create a new jsonb column on the table.
- lineString() : Fluent
- Create a new linestring column on the table.
- longText() : Fluent
- Create a new long text column on the table.
- macAddress() : Fluent
- Create a new MAC address column on the table.
- macro() : void
- Register a custom macro.
- mediumIncrements() : Fluent
- Create a new auto-incrementing medium integer (3-byte) column on the table.
- mediumInteger() : Fluent
- Create a new medium integer (3-byte) column on the table.
- mediumText() : Fluent
- Create a new medium text column on the table.
- mixin() : void
- Mix another object into the class.
- morphs() : void
- Add the proper columns for a polymorphic table.
- multiLineString() : Fluent
- Create a new multilinestring column on the table.
- multiPoint() : Fluent
- Create a new multipoint column on the table.
- multiPolygon() : Fluent
- Create a new multipolygon column on the table.
- nullableMorphs() : void
- Add nullable columns for a polymorphic table.
- nullableTimestamps() : void
- Add nullable creation and update timestamps to the table.
- point() : Fluent
- Create a new point column on the table.
- polygon() : Fluent
- Create a new polygon column on the table.
- primary() : Fluent
- Specify the primary key(s) for the table.
- rememberToken() : Fluent
- Adds the `remember_token` column to the table.
- removeColumn() : $this
- Remove a column from the schema blueprint.
- rename() : Fluent
- Rename the table to a given name.
- renameColumn() : Fluent
- Indicate that the given columns should be renamed.
- smallIncrements() : Fluent
- Create a new auto-incrementing small integer (2-byte) column on the table.
- smallInteger() : Fluent
- Create a new small integer (2-byte) column on the table.
- softDeletes() : Fluent
- Add a "deleted at" timestamp for the table.
- softDeletesTz() : Fluent
- Add a "deleted at" timestampTz for the table.
- spatialIndex() : Fluent
- Specify a spatial index for the table.
- string() : Fluent
- Create a new string column on the table.
- temporary() : void
- Indicate that the table needs to be temporary.
- text() : Fluent
- Create a new text column on the table.
- time() : Fluent
- Create a new time column on the table.
- timestamp() : Fluent
- Create a new timestamp column on the table.
- timestamps() : void
- Add nullable creation and update timestamps to the table.
- timestampsTz() : void
- Add creation and update timestampTz columns to the table.
- timestampTz() : Fluent
- Create a new timestamp (with time zone) column on the table.
- timeTz() : Fluent
- Create a new time column (with time zone) on the table.
- tinyIncrements() : Fluent
- Create a new auto-incrementing tiny integer (1-byte) column on the table.
- tinyInteger() : Fluent
- Create a new tiny integer (1-byte) column on the table.
- toSql() : array<string|int, mixed>
- Get the raw SQL statements for the blueprint.
- unique() : Fluent
- Specify a unique index for the table.
- unsignedBigInteger() : Fluent
- Create a new unsigned big integer (8-byte) column on the table.
- unsignedDecimal() : Fluent
- Create a new unsigned decimal column on the table.
- unsignedInteger() : Fluent
- Create a new unsigned integer (4-byte) column on the table.
- unsignedMediumInteger() : Fluent
- Create a new unsigned medium integer (3-byte) column on the table.
- unsignedSmallInteger() : Fluent
- Create a new unsigned small integer (2-byte) column on the table.
- unsignedTinyInteger() : Fluent
- Create a new unsigned tiny integer (1-byte) column on the table.
- uuid() : Fluent
- Create a new uuid column on the table.
- year() : Fluent
- Create a new year column on the table.
- addCommand() : Fluent
- Add a new command to the blueprint.
- addFluentIndexes() : void
- Add the index commands fluently specified on columns.
- addImpliedCommands() : void
- Add the commands that are implied by the blueprint's state.
- createCommand() : Fluent
- Create a new Fluent command.
- createIndexName() : string
- Create a default index name for the table.
- creating() : bool
- Determine if the blueprint has a create command.
- dropIndexCommand() : Fluent
- Create a new drop index command on the blueprint.
- indexCommand() : Fluent
- Add a new index command to the blueprint.
Properties
$charset
The default character set that should be used for the table.
public
mixed
$charset
$collation
The collation that should be used for the table.
public
mixed
$collation
$engine
The storage engine that should be used for the table.
public
string
$engine
$temporary
Whether to make the table temporary.
public
bool
$temporary
= false
$columns
The columns that should be added to the table.
protected
array<string|int, Fluent>
$columns
= []
$commands
The commands that should be run for the table.
protected
array<string|int, Fluent>
$commands
= []
$macros
The registered string macros.
protected
static array<string|int, mixed>
$macros
= []
$table
The table the blueprint describes.
protected
string
$table
Methods
__call()
Dynamically handle calls to the class.
public
__call(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Tags
Return values
mixed —__callStatic()
Dynamically handle calls to the class.
public
static __callStatic(string $method, array<string|int, mixed> $parameters) : mixed
Parameters
- $method : string
- $parameters : array<string|int, mixed>
Tags
Return values
mixed —__construct()
Create a new schema blueprint.
public
__construct(string $table[, Closure|null $callback = null ]) : void
Parameters
- $table : string
- $callback : Closure|null = null
Return values
void —addColumn()
Add a new column to the blueprint.
public
addColumn(string $type, string $name[, array<string|int, mixed> $parameters = [] ]) : Fluent
Parameters
- $type : string
- $name : string
- $parameters : array<string|int, mixed> = []
Return values
Fluent —bigIncrements()
Create a new auto-incrementing big integer (8-byte) column on the table.
public
bigIncrements(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —bigInteger()
Create a new big integer (8-byte) column on the table.
public
bigInteger(string $column[, bool $autoIncrement = false ][, bool $unsigned = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
- $unsigned : bool = false
Return values
Fluent —binary()
Create a new binary column on the table.
public
binary(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —boolean()
Create a new boolean column on the table.
public
boolean(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —build()
Execute the blueprint against the database.
public
build(Connection $connection, Grammar $grammar) : void
Parameters
- $connection : Connection
- $grammar : Grammar
Return values
void —char()
Create a new char column on the table.
public
char(string $column[, int $length = null ]) : Fluent
Parameters
- $column : string
- $length : int = null
Return values
Fluent —create()
Indicate that the table needs to be created.
public
create() : Fluent
Return values
Fluent —date()
Create a new date column on the table.
public
date(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —dateTime()
Create a new date-time column on the table.
public
dateTime(string $column, int $precision) : Fluent
Parameters
- $column : string
- $precision : int
Return values
Fluent —dateTimeTz()
Create a new date-time column (with time zone) on the table.
public
dateTimeTz(string $column, int $precision) : Fluent
Parameters
- $column : string
- $precision : int
Return values
Fluent —decimal()
Create a new decimal column on the table.
public
decimal(string $column[, int $total = 8 ][, int $places = 2 ]) : Fluent
Parameters
- $column : string
- $total : int = 8
- $places : int = 2
Return values
Fluent —double()
Create a new double column on the table.
public
double(string $column[, int|null $total = null ][, int|null $places = null ]) : Fluent
Parameters
- $column : string
- $total : int|null = null
- $places : int|null = null
Return values
Fluent —drop()
Indicate that the table should be dropped.
public
drop() : Fluent
Return values
Fluent —dropColumn()
Indicate that the given columns should be dropped.
public
dropColumn(array<string|int, mixed>|mixed $columns) : Fluent
Parameters
- $columns : array<string|int, mixed>|mixed
Return values
Fluent —dropForeign()
Indicate that the given foreign key should be dropped.
public
dropForeign(string|array<string|int, mixed> $index) : Fluent
Parameters
- $index : string|array<string|int, mixed>
Return values
Fluent —dropIfExists()
Indicate that the table should be dropped if it exists.
public
dropIfExists() : Fluent
Return values
Fluent —dropIndex()
Indicate that the given index should be dropped.
public
dropIndex(string|array<string|int, mixed> $index) : Fluent
Parameters
- $index : string|array<string|int, mixed>
Return values
Fluent —dropPrimary()
Indicate that the given primary key should be dropped.
public
dropPrimary([string|array<string|int, mixed> $index = null ]) : Fluent
Parameters
- $index : string|array<string|int, mixed> = null
Return values
Fluent —dropRememberToken()
Indicate that the remember token column should be dropped.
public
dropRememberToken() : void
Return values
void —dropSoftDeletes()
Indicate that the soft delete column should be dropped.
public
dropSoftDeletes() : void
Return values
void —dropSoftDeletesTz()
Indicate that the soft delete column should be dropped.
public
dropSoftDeletesTz() : void
Return values
void —dropSpatialIndex()
Indicate that the given spatial index should be dropped.
public
dropSpatialIndex(string|array<string|int, mixed> $index) : Fluent
Parameters
- $index : string|array<string|int, mixed>
Return values
Fluent —dropTimestamps()
Indicate that the timestamp columns should be dropped.
public
dropTimestamps() : void
Return values
void —dropTimestampsTz()
Indicate that the timestamp columns should be dropped.
public
dropTimestampsTz() : void
Return values
void —dropUnique()
Indicate that the given unique key should be dropped.
public
dropUnique(string|array<string|int, mixed> $index) : Fluent
Parameters
- $index : string|array<string|int, mixed>
Return values
Fluent —enum()
Create a new enum column on the table.
public
enum(string $column, array<string|int, mixed> $allowed) : Fluent
Parameters
- $column : string
- $allowed : array<string|int, mixed>
Return values
Fluent —float()
Create a new float column on the table.
public
float(string $column[, int $total = 8 ][, int $places = 2 ]) : Fluent
Parameters
- $column : string
- $total : int = 8
- $places : int = 2
Return values
Fluent —foreign()
Specify a foreign key for the table.
public
foreign(string|array<string|int, mixed> $columns[, string $name = null ]) : Fluent
Parameters
- $columns : string|array<string|int, mixed>
- $name : string = null
Return values
Fluent —geometry()
Create a new geometry column on the table.
public
geometry(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —geometryCollection()
Create a new geometrycollection column on the table.
public
geometryCollection(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —getAddedColumns()
Get the columns on the blueprint that should be added.
public
getAddedColumns() : array<string|int, Fluent>
Return values
array<string|int, Fluent> —getChangedColumns()
Get the columns on the blueprint that should be changed.
public
getChangedColumns() : array<string|int, Fluent>
Return values
array<string|int, Fluent> —getColumns()
Get the columns on the blueprint.
public
getColumns() : array<string|int, Fluent>
Return values
array<string|int, Fluent> —getCommands()
Get the commands on the blueprint.
public
getCommands() : array<string|int, Fluent>
Return values
array<string|int, Fluent> —getTable()
Get the table the blueprint describes.
public
getTable() : string
Return values
string —hasMacro()
Checks if macro is registered.
public
static hasMacro(string $name) : bool
Parameters
- $name : string
Return values
bool —increments()
Create a new auto-incrementing integer (4-byte) column on the table.
public
increments(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —index()
Specify an index for the table.
public
index(string|array<string|int, mixed> $columns[, string $name = null ][, string|null $algorithm = null ]) : Fluent
Parameters
- $columns : string|array<string|int, mixed>
- $name : string = null
- $algorithm : string|null = null
Return values
Fluent —integer()
Create a new integer (4-byte) column on the table.
public
integer(string $column[, bool $autoIncrement = false ][, bool $unsigned = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
- $unsigned : bool = false
Return values
Fluent —ipAddress()
Create a new IP address column on the table.
public
ipAddress(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —json()
Create a new json column on the table.
public
json(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —jsonb()
Create a new jsonb column on the table.
public
jsonb(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —lineString()
Create a new linestring column on the table.
public
lineString(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —longText()
Create a new long text column on the table.
public
longText(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —macAddress()
Create a new MAC address column on the table.
public
macAddress(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —macro()
Register a custom macro.
public
static macro(string $name, object|callable $macro) : void
Parameters
- $name : string
- $macro : object|callable
Return values
void —mediumIncrements()
Create a new auto-incrementing medium integer (3-byte) column on the table.
public
mediumIncrements(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —mediumInteger()
Create a new medium integer (3-byte) column on the table.
public
mediumInteger(string $column[, bool $autoIncrement = false ][, bool $unsigned = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
- $unsigned : bool = false
Return values
Fluent —mediumText()
Create a new medium text column on the table.
public
mediumText(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —mixin()
Mix another object into the class.
public
static mixin(object $mixin) : void
Parameters
- $mixin : object
Return values
void —morphs()
Add the proper columns for a polymorphic table.
public
morphs(string $name[, string|null $indexName = null ]) : void
Parameters
- $name : string
- $indexName : string|null = null
Return values
void —multiLineString()
Create a new multilinestring column on the table.
public
multiLineString(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —multiPoint()
Create a new multipoint column on the table.
public
multiPoint(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —multiPolygon()
Create a new multipolygon column on the table.
public
multiPolygon(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —nullableMorphs()
Add nullable columns for a polymorphic table.
public
nullableMorphs(string $name[, string|null $indexName = null ]) : void
Parameters
- $name : string
- $indexName : string|null = null
Return values
void —nullableTimestamps()
Add nullable creation and update timestamps to the table.
public
nullableTimestamps(int $precision) : void
Alias for self::timestamps().
Parameters
- $precision : int
Return values
void —point()
Create a new point column on the table.
public
point(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —polygon()
Create a new polygon column on the table.
public
polygon(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —primary()
Specify the primary key(s) for the table.
public
primary(string|array<string|int, mixed> $columns[, string $name = null ][, string|null $algorithm = null ]) : Fluent
Parameters
- $columns : string|array<string|int, mixed>
- $name : string = null
- $algorithm : string|null = null
Return values
Fluent —rememberToken()
Adds the `remember_token` column to the table.
public
rememberToken() : Fluent
Return values
Fluent —removeColumn()
Remove a column from the schema blueprint.
public
removeColumn(string $name) : $this
Parameters
- $name : string
Return values
$this —rename()
Rename the table to a given name.
public
rename(string $to) : Fluent
Parameters
- $to : string
Return values
Fluent —renameColumn()
Indicate that the given columns should be renamed.
public
renameColumn(string $from, string $to) : Fluent
Parameters
- $from : string
- $to : string
Return values
Fluent —smallIncrements()
Create a new auto-incrementing small integer (2-byte) column on the table.
public
smallIncrements(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —smallInteger()
Create a new small integer (2-byte) column on the table.
public
smallInteger(string $column[, bool $autoIncrement = false ][, bool $unsigned = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
- $unsigned : bool = false
Return values
Fluent —softDeletes()
Add a "deleted at" timestamp for the table.
public
softDeletes([string $column = 'deleted_at' ], int $precision) : Fluent
Parameters
- $column : string = 'deleted_at'
- $precision : int
Return values
Fluent —softDeletesTz()
Add a "deleted at" timestampTz for the table.
public
softDeletesTz(int $precision) : Fluent
Parameters
- $precision : int
Return values
Fluent —spatialIndex()
Specify a spatial index for the table.
public
spatialIndex(string|array<string|int, mixed> $columns[, string $name = null ]) : Fluent
Parameters
- $columns : string|array<string|int, mixed>
- $name : string = null
Return values
Fluent —string()
Create a new string column on the table.
public
string(string $column[, int $length = null ]) : Fluent
Parameters
- $column : string
- $length : int = null
Return values
Fluent —temporary()
Indicate that the table needs to be temporary.
public
temporary() : void
Return values
void —text()
Create a new text column on the table.
public
text(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —time()
Create a new time column on the table.
public
time(string $column, int $precision) : Fluent
Parameters
- $column : string
- $precision : int
Return values
Fluent —timestamp()
Create a new timestamp column on the table.
public
timestamp(string $column, int $precision) : Fluent
Parameters
- $column : string
- $precision : int
Return values
Fluent —timestamps()
Add nullable creation and update timestamps to the table.
public
timestamps(int $precision) : void
Parameters
- $precision : int
Return values
void —timestampsTz()
Add creation and update timestampTz columns to the table.
public
timestampsTz(int $precision) : void
Parameters
- $precision : int
Return values
void —timestampTz()
Create a new timestamp (with time zone) column on the table.
public
timestampTz(string $column, int $precision) : Fluent
Parameters
- $column : string
- $precision : int
Return values
Fluent —timeTz()
Create a new time column (with time zone) on the table.
public
timeTz(string $column, int $precision) : Fluent
Parameters
- $column : string
- $precision : int
Return values
Fluent —tinyIncrements()
Create a new auto-incrementing tiny integer (1-byte) column on the table.
public
tinyIncrements(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —tinyInteger()
Create a new tiny integer (1-byte) column on the table.
public
tinyInteger(string $column[, bool $autoIncrement = false ][, bool $unsigned = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
- $unsigned : bool = false
Return values
Fluent —toSql()
Get the raw SQL statements for the blueprint.
public
toSql(Connection $connection, Grammar $grammar) : array<string|int, mixed>
Parameters
- $connection : Connection
- $grammar : Grammar
Return values
array<string|int, mixed> —unique()
Specify a unique index for the table.
public
unique(string|array<string|int, mixed> $columns[, string $name = null ][, string|null $algorithm = null ]) : Fluent
Parameters
- $columns : string|array<string|int, mixed>
- $name : string = null
- $algorithm : string|null = null
Return values
Fluent —unsignedBigInteger()
Create a new unsigned big integer (8-byte) column on the table.
public
unsignedBigInteger(string $column[, bool $autoIncrement = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
Return values
Fluent —unsignedDecimal()
Create a new unsigned decimal column on the table.
public
unsignedDecimal(string $column[, int $total = 8 ][, int $places = 2 ]) : Fluent
Parameters
- $column : string
- $total : int = 8
- $places : int = 2
Return values
Fluent —unsignedInteger()
Create a new unsigned integer (4-byte) column on the table.
public
unsignedInteger(string $column[, bool $autoIncrement = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
Return values
Fluent —unsignedMediumInteger()
Create a new unsigned medium integer (3-byte) column on the table.
public
unsignedMediumInteger(string $column[, bool $autoIncrement = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
Return values
Fluent —unsignedSmallInteger()
Create a new unsigned small integer (2-byte) column on the table.
public
unsignedSmallInteger(string $column[, bool $autoIncrement = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
Return values
Fluent —unsignedTinyInteger()
Create a new unsigned tiny integer (1-byte) column on the table.
public
unsignedTinyInteger(string $column[, bool $autoIncrement = false ]) : Fluent
Parameters
- $column : string
- $autoIncrement : bool = false
Return values
Fluent —uuid()
Create a new uuid column on the table.
public
uuid(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —year()
Create a new year column on the table.
public
year(string $column) : Fluent
Parameters
- $column : string
Return values
Fluent —addCommand()
Add a new command to the blueprint.
protected
addCommand(string $name[, array<string|int, mixed> $parameters = [] ]) : Fluent
Parameters
- $name : string
- $parameters : array<string|int, mixed> = []
Return values
Fluent —addFluentIndexes()
Add the index commands fluently specified on columns.
protected
addFluentIndexes() : void
Return values
void —addImpliedCommands()
Add the commands that are implied by the blueprint's state.
protected
addImpliedCommands() : void
Return values
void —createCommand()
Create a new Fluent command.
protected
createCommand(string $name[, array<string|int, mixed> $parameters = [] ]) : Fluent
Parameters
- $name : string
- $parameters : array<string|int, mixed> = []
Return values
Fluent —createIndexName()
Create a default index name for the table.
protected
createIndexName(string $type, array<string|int, mixed> $columns) : string
Parameters
- $type : string
- $columns : array<string|int, mixed>
Return values
string —creating()
Determine if the blueprint has a create command.
protected
creating() : bool
Return values
bool —dropIndexCommand()
Create a new drop index command on the blueprint.
protected
dropIndexCommand(string $command, string $type, string|array<string|int, mixed> $index) : Fluent
Parameters
- $command : string
- $type : string
- $index : string|array<string|int, mixed>
Return values
Fluent —indexCommand()
Add a new index command to the blueprint.
protected
indexCommand(string $type, string|array<string|int, mixed> $columns, string $index[, string|null $algorithm = null ]) : Fluent
Parameters
- $type : string
- $columns : string|array<string|int, mixed>
- $index : string
- $algorithm : string|null = null