1. class
  2. Illuminate
  3. \
  4. Database
  5. \
  6. Schema
  7. \
  8. Blueprint

Blueprint

class Blueprint (View source)

Traits

Macroable

Properties

static protected array $macros The registered string macros. from Macroable
protected string $table The table the blueprint describes.
protected Fluent[] $columns The columns that should be added to the table.
protected Fluent[] $commands The commands that should be run for the table.
string $engine The storage engine that should be used for the table.
$charset The default character set that should be used for the table.
$collation The collation that should be used for the table.
bool $temporary Whether to make the table temporary.

Methods

static void
macro(string $name, object|callable $macro)

Register a custom macro.

from Macroable
static void
mixin(object $mixin)

Mix another object into the class.

from Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable
void
__construct(string $table, Closure $callback = null)

Create a new schema blueprint.

void
build(Connection $connection, Grammar $grammar)

Execute the blueprint against the database.

array
toSql(Connection $connection, Grammar $grammar)

Get the raw SQL statements for the blueprint.

void
ensureCommandsAreValid(Connection $connection)

Ensure the commands on the blueprint are valid for the connection type.

Collection
commandsNamed(array $names)

Get all of the commands matching the given names.

void
addImpliedCommands(Grammar $grammar)

Add the commands that are implied by the blueprint's state.

void
addFluentIndexes()

Add the index commands fluently specified on columns.

void
addFluentCommands(Grammar $grammar)

Add the fluent commands specified on any columns.

bool
creating()

Determine if the blueprint has a create command.

Fluent
create()

Indicate that the table needs to be created.

void
temporary()

Indicate that the table needs to be temporary.

Fluent
drop()

Indicate that the table should be dropped.

Fluent
dropIfExists()

Indicate that the table should be dropped if it exists.

Fluent
dropColumn(array|mixed $columns)

Indicate that the given columns should be dropped.

Fluent
renameColumn(string $from, string $to)

Indicate that the given columns should be renamed.

Fluent
dropPrimary(string|array $index = null)

Indicate that the given primary key should be dropped.

Fluent
dropUnique(string|array $index)

Indicate that the given unique key should be dropped.

Fluent
dropIndex(string|array $index)

Indicate that the given index should be dropped.

Fluent
dropSpatialIndex(string|array $index)

Indicate that the given spatial index should be dropped.

Fluent
dropForeign(string|array $index)

Indicate that the given foreign key should be dropped.

Fluent
renameIndex(string $from, string $to)

Indicate that the given indexes should be renamed.

void
dropTimestamps()

Indicate that the timestamp columns should be dropped.

void
dropTimestampsTz()

Indicate that the timestamp columns should be dropped.

void
dropSoftDeletes()

Indicate that the soft delete column should be dropped.

void
dropSoftDeletesTz()

Indicate that the soft delete column should be dropped.

void
dropRememberToken()

Indicate that the remember token column should be dropped.

void
dropMorphs(string $name, string|null $indexName = null)

Indicate that the polymorphic columns should be dropped.

Fluent
rename(string $to)

Rename the table to a given name.

Fluent
primary(string|array $columns, string $name = null, string|null $algorithm = null)

Specify the primary key(s) for the table.

Fluent
unique(string|array $columns, string $name = null, string|null $algorithm = null)

Specify a unique index for the table.

Fluent
index(string|array $columns, string $name = null, string|null $algorithm = null)

Specify an index for the table.

Fluent
spatialIndex(string|array $columns, string $name = null)

Specify a spatial index for the table.

Fluent
foreign(string|array $columns, string $name = null)

Specify a foreign key for the table.

Fluent
increments(string $column)

Create a new auto-incrementing integer (4-byte) column on the table.

Fluent
tinyIncrements(string $column)

Create a new auto-incrementing tiny integer (1-byte) column on the table.

Fluent
smallIncrements(string $column)

Create a new auto-incrementing small integer (2-byte) column on the table.

Fluent
mediumIncrements(string $column)

Create a new auto-incrementing medium integer (3-byte) column on the table.

Fluent
bigIncrements(string $column)

Create a new auto-incrementing big integer (8-byte) column on the table.

Fluent
char(string $column, int $length = null)

Create a new char column on the table.

Fluent
string(string $column, int $length = null)

Create a new string column on the table.

Fluent
text(string $column)

Create a new text column on the table.

Fluent
mediumText(string $column)

Create a new medium text column on the table.

Fluent
longText(string $column)

Create a new long text column on the table.

Fluent
integer(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new integer (4-byte) column on the table.

Fluent
tinyInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new tiny integer (1-byte) column on the table.

Fluent
smallInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new small integer (2-byte) column on the table.

Fluent
mediumInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new medium integer (3-byte) column on the table.

Fluent
bigInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new big integer (8-byte) column on the table.

Fluent
unsignedInteger(string $column, bool $autoIncrement = false)

Create a new unsigned integer (4-byte) column on the table.

Fluent
unsignedTinyInteger(string $column, bool $autoIncrement = false)

Create a new unsigned tiny integer (1-byte) column on the table.

Fluent
unsignedSmallInteger(string $column, bool $autoIncrement = false)

Create a new unsigned small integer (2-byte) column on the table.

Fluent
unsignedMediumInteger(string $column, bool $autoIncrement = false)

Create a new unsigned medium integer (3-byte) column on the table.

Fluent
unsignedBigInteger(string $column, bool $autoIncrement = false)

Create a new unsigned big integer (8-byte) column on the table.

Fluent
float(string $column, int $total = 8, int $places = 2)

Create a new float column on the table.

Fluent
double(string $column, int|null $total = null, int|null $places = null)

Create a new double column on the table.

Fluent
decimal(string $column, int $total = 8, int $places = 2)

Create a new decimal column on the table.

Fluent
unsignedDecimal(string $column, int $total = 8, int $places = 2)

Create a new unsigned decimal column on the table.

Fluent
boolean(string $column)

Create a new boolean column on the table.

Fluent
enum(string $column, array $allowed)

Create a new enum column on the table.

Fluent
json(string $column)

Create a new json column on the table.

Fluent
jsonb(string $column)

Create a new jsonb column on the table.

Fluent
date(string $column)

Create a new date column on the table.

Fluent
dateTime(string $column, int $precision = 0)

Create a new date-time column on the table.

Fluent
dateTimeTz(string $column, int $precision = 0)

Create a new date-time column (with time zone) on the table.

Fluent
time(string $column, int $precision = 0)

Create a new time column on the table.

Fluent
timeTz(string $column, int $precision = 0)

Create a new time column (with time zone) on the table.

Fluent
timestamp(string $column, int $precision = 0)

Create a new timestamp column on the table.

Fluent
timestampTz(string $column, int $precision = 0)

Create a new timestamp (with time zone) column on the table.

void
timestamps(int $precision = 0)

Add nullable creation and update timestamps to the table.

void
nullableTimestamps(int $precision = 0)

Add nullable creation and update timestamps to the table.

void
timestampsTz(int $precision = 0)

Add creation and update timestampTz columns to the table.

Fluent
softDeletes(string $column = 'deleted_at', int $precision = 0)

Add a "deleted at" timestamp for the table.

Fluent
softDeletesTz(int $precision = 0)

Add a "deleted at" timestampTz for the table.

Fluent
year(string $column)

Create a new year column on the table.

Fluent
binary(string $column)

Create a new binary column on the table.

Fluent
uuid(string $column)

Create a new uuid column on the table.

Fluent
ipAddress(string $column)

Create a new IP address column on the table.

Fluent
macAddress(string $column)

Create a new MAC address column on the table.

Fluent
geometry(string $column)

Create a new geometry column on the table.

Fluent
point(string $column, int|null $srid = null)

Create a new point column on the table.

Fluent
lineString(string $column)

Create a new linestring column on the table.

Fluent
polygon(string $column)

Create a new polygon column on the table.

Fluent
geometryCollection(string $column)

Create a new geometrycollection column on the table.

Fluent
multiPoint(string $column)

Create a new multipoint column on the table.

Fluent
multiLineString(string $column)

Create a new multilinestring column on the table.

Fluent
multiPolygon(string $column)

Create a new multipolygon column on the table.

void
morphs(string $name, string|null $indexName = null)

Add the proper columns for a polymorphic table.

void
nullableMorphs(string $name, string|null $indexName = null)

Add nullable columns for a polymorphic table.

Fluent
rememberToken()

Adds the remember_token column to the table.

Fluent
indexCommand(string $type, string|array $columns, string $index, string|null $algorithm = null)

Add a new index command to the blueprint.

Fluent
dropIndexCommand(string $command, string $type, string|array $index)

Create a new drop index command on the blueprint.

string
createIndexName(string $type, array $columns)

Create a default index name for the table.

Fluent
addColumn(string $type, string $name, array $parameters = [])

Add a new column to the blueprint.

$this
removeColumn(string $name)

Remove a column from the schema blueprint.

Fluent
addCommand(string $name, array $parameters = [])

Add a new command to the blueprint.

Fluent
createCommand(string $name, array $parameters = [])

Create a new Fluent command.

string
getTable()

Get the table the blueprint describes.

Fluent[]
getColumns()

Get the columns on the blueprint.

Fluent[]
getCommands()

Get the commands on the blueprint.

Fluent[]
getAddedColumns()

Get the columns on the blueprint that should be added.

Fluent[]
getChangedColumns()

Get the columns on the blueprint that should be changed.

Details

in Macroable at line 27
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 39
static void mixin(object $mixin)

Mix another object into the class.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

in Macroable at line 58
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 96
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 69
void __construct(string $table, Closure $callback = null)

Create a new schema blueprint.

Parameters

string $table
Closure $callback

Return Value

void

at line 85
void build(Connection $connection, Grammar $grammar)

Execute the blueprint against the database.

Parameters

Connection $connection
Grammar $grammar

Return Value

void

at line 99
array toSql(Connection $connection, Grammar $grammar)

Get the raw SQL statements for the blueprint.

Parameters

Connection $connection
Grammar $grammar

Return Value

array

at line 129
protected void ensureCommandsAreValid(Connection $connection)

Ensure the commands on the blueprint are valid for the connection type.

Parameters

Connection $connection

Return Value

void

at line 145
protected Collection commandsNamed(array $names)

Get all of the commands matching the given names.

Parameters

array $names

Return Value

Collection

at line 158
protected void addImpliedCommands(Grammar $grammar)

Add the commands that are implied by the blueprint's state.

Parameters

Grammar $grammar

Return Value

void

at line 178
protected void addFluentIndexes()

Add the index commands fluently specified on columns.

Return Value

void

at line 209
void addFluentCommands(Grammar $grammar)

Add the fluent commands specified on any columns.

Parameters

Grammar $grammar

Return Value

void

at line 233
protected bool creating()

Determine if the blueprint has a create command.

Return Value

bool

at line 245
Fluent create()

Indicate that the table needs to be created.

Return Value

Fluent

at line 255
void temporary()

Indicate that the table needs to be temporary.

Return Value

void

at line 265
Fluent drop()

Indicate that the table should be dropped.

Return Value

Fluent

at line 275
Fluent dropIfExists()

Indicate that the table should be dropped if it exists.

Return Value

Fluent

at line 286
Fluent dropColumn(array|mixed $columns)

Indicate that the given columns should be dropped.

Parameters

array|mixed $columns

Return Value

Fluent

at line 300
Fluent renameColumn(string $from, string $to)

Indicate that the given columns should be renamed.

Parameters

string $from
string $to

Return Value

Fluent

at line 311
Fluent dropPrimary(string|array $index = null)

Indicate that the given primary key should be dropped.

Parameters

string|array $index

Return Value

Fluent

at line 322
Fluent dropUnique(string|array $index)

Indicate that the given unique key should be dropped.

Parameters

string|array $index

Return Value

Fluent

at line 333
Fluent dropIndex(string|array $index)

Indicate that the given index should be dropped.

Parameters

string|array $index

Return Value

Fluent

at line 344
Fluent dropSpatialIndex(string|array $index)

Indicate that the given spatial index should be dropped.

Parameters

string|array $index

Return Value

Fluent

at line 355
Fluent dropForeign(string|array $index)

Indicate that the given foreign key should be dropped.

Parameters

string|array $index

Return Value

Fluent

at line 367
Fluent renameIndex(string $from, string $to)

Indicate that the given indexes should be renamed.

Parameters

string $from
string $to

Return Value

Fluent

at line 377
void dropTimestamps()

Indicate that the timestamp columns should be dropped.

Return Value

void

at line 387
void dropTimestampsTz()

Indicate that the timestamp columns should be dropped.

Return Value

void

at line 397
void dropSoftDeletes()

Indicate that the soft delete column should be dropped.

Return Value

void

at line 407
void dropSoftDeletesTz()

Indicate that the soft delete column should be dropped.

Return Value

void

at line 417
void dropRememberToken()

Indicate that the remember token column should be dropped.

Return Value

void

at line 429
void dropMorphs(string $name, string|null $indexName = null)

Indicate that the polymorphic columns should be dropped.

Parameters

string $name
string|null $indexName

Return Value

void

at line 442
Fluent rename(string $to)

Rename the table to a given name.

Parameters

string $to

Return Value

Fluent

at line 455
Fluent primary(string|array $columns, string $name = null, string|null $algorithm = null)

Specify the primary key(s) for the table.

Parameters

string|array $columns
string $name
string|null $algorithm

Return Value

Fluent

at line 468
Fluent unique(string|array $columns, string $name = null, string|null $algorithm = null)

Specify a unique index for the table.

Parameters

string|array $columns
string $name
string|null $algorithm

Return Value

Fluent

at line 481
Fluent index(string|array $columns, string $name = null, string|null $algorithm = null)

Specify an index for the table.

Parameters

string|array $columns
string $name
string|null $algorithm

Return Value

Fluent

at line 493
Fluent spatialIndex(string|array $columns, string $name = null)

Specify a spatial index for the table.

Parameters

string|array $columns
string $name

Return Value

Fluent

at line 505
Fluent foreign(string|array $columns, string $name = null)

Specify a foreign key for the table.

Parameters

string|array $columns
string $name

Return Value

Fluent

at line 516
Fluent increments(string $column)

Create a new auto-incrementing integer (4-byte) column on the table.

Parameters

string $column

Return Value

Fluent

at line 527
Fluent tinyIncrements(string $column)

Create a new auto-incrementing tiny integer (1-byte) column on the table.

Parameters

string $column

Return Value

Fluent

at line 538
Fluent smallIncrements(string $column)

Create a new auto-incrementing small integer (2-byte) column on the table.

Parameters

string $column

Return Value

Fluent

at line 549
Fluent mediumIncrements(string $column)

Create a new auto-incrementing medium integer (3-byte) column on the table.

Parameters

string $column

Return Value

Fluent

at line 560
Fluent bigIncrements(string $column)

Create a new auto-incrementing big integer (8-byte) column on the table.

Parameters

string $column

Return Value

Fluent

at line 572
Fluent char(string $column, int $length = null)

Create a new char column on the table.

Parameters

string $column
int $length

Return Value

Fluent

at line 586
Fluent string(string $column, int $length = null)

Create a new string column on the table.

Parameters

string $column
int $length

Return Value

Fluent

at line 599
Fluent text(string $column)

Create a new text column on the table.

Parameters

string $column

Return Value

Fluent

at line 610
Fluent mediumText(string $column)

Create a new medium text column on the table.

Parameters

string $column

Return Value

Fluent

at line 621
Fluent longText(string $column)

Create a new long text column on the table.

Parameters

string $column

Return Value

Fluent

at line 634
Fluent integer(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new integer (4-byte) column on the table.

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

Fluent

at line 647
Fluent tinyInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new tiny integer (1-byte) column on the table.

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

Fluent

at line 660
Fluent smallInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new small integer (2-byte) column on the table.

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

Fluent

at line 673
Fluent mediumInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new medium integer (3-byte) column on the table.

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

Fluent

at line 686
Fluent bigInteger(string $column, bool $autoIncrement = false, bool $unsigned = false)

Create a new big integer (8-byte) column on the table.

Parameters

string $column
bool $autoIncrement
bool $unsigned

Return Value

Fluent

at line 698
Fluent unsignedInteger(string $column, bool $autoIncrement = false)

Create a new unsigned integer (4-byte) column on the table.

Parameters

string $column
bool $autoIncrement

Return Value

Fluent

at line 710
Fluent unsignedTinyInteger(string $column, bool $autoIncrement = false)

Create a new unsigned tiny integer (1-byte) column on the table.

Parameters

string $column
bool $autoIncrement

Return Value

Fluent

at line 722
Fluent unsignedSmallInteger(string $column, bool $autoIncrement = false)

Create a new unsigned small integer (2-byte) column on the table.

Parameters

string $column
bool $autoIncrement

Return Value

Fluent

at line 734
Fluent unsignedMediumInteger(string $column, bool $autoIncrement = false)

Create a new unsigned medium integer (3-byte) column on the table.

Parameters

string $column
bool $autoIncrement

Return Value

Fluent

at line 746
Fluent unsignedBigInteger(string $column, bool $autoIncrement = false)

Create a new unsigned big integer (8-byte) column on the table.

Parameters

string $column
bool $autoIncrement

Return Value

Fluent

at line 759
Fluent float(string $column, int $total = 8, int $places = 2)

Create a new float column on the table.

Parameters

string $column
int $total
int $places

Return Value

Fluent

at line 772
Fluent double(string $column, int|null $total = null, int|null $places = null)

Create a new double column on the table.

Parameters

string $column
int|null $total
int|null $places

Return Value

Fluent

at line 785
Fluent decimal(string $column, int $total = 8, int $places = 2)

Create a new decimal column on the table.

Parameters

string $column
int $total
int $places

Return Value

Fluent

at line 798
Fluent unsignedDecimal(string $column, int $total = 8, int $places = 2)

Create a new unsigned decimal column on the table.

Parameters

string $column
int $total
int $places

Return Value

Fluent

at line 811
Fluent boolean(string $column)

Create a new boolean column on the table.

Parameters

string $column

Return Value

Fluent

at line 823
Fluent enum(string $column, array $allowed)

Create a new enum column on the table.

Parameters

string $column
array $allowed

Return Value

Fluent

at line 834
Fluent json(string $column)

Create a new json column on the table.

Parameters

string $column

Return Value

Fluent

at line 845
Fluent jsonb(string $column)

Create a new jsonb column on the table.

Parameters

string $column

Return Value

Fluent

at line 856
Fluent date(string $column)

Create a new date column on the table.

Parameters

string $column

Return Value

Fluent

at line 868
Fluent dateTime(string $column, int $precision = 0)

Create a new date-time column on the table.

Parameters

string $column
int $precision

Return Value

Fluent

at line 880
Fluent dateTimeTz(string $column, int $precision = 0)

Create a new date-time column (with time zone) on the table.

Parameters

string $column
int $precision

Return Value

Fluent

at line 892
Fluent time(string $column, int $precision = 0)

Create a new time column on the table.

Parameters

string $column
int $precision

Return Value

Fluent

at line 904
Fluent timeTz(string $column, int $precision = 0)

Create a new time column (with time zone) on the table.

Parameters

string $column
int $precision

Return Value

Fluent

at line 916
Fluent timestamp(string $column, int $precision = 0)

Create a new timestamp column on the table.

Parameters

string $column
int $precision

Return Value

Fluent

at line 928
Fluent timestampTz(string $column, int $precision = 0)

Create a new timestamp (with time zone) column on the table.

Parameters

string $column
int $precision

Return Value

Fluent

at line 939
void timestamps(int $precision = 0)

Add nullable creation and update timestamps to the table.

Parameters

int $precision

Return Value

void

at line 954
void nullableTimestamps(int $precision = 0)

Add nullable creation and update timestamps to the table.

Alias for self::timestamps().

Parameters

int $precision

Return Value

void

at line 965
void timestampsTz(int $precision = 0)

Add creation and update timestampTz columns to the table.

Parameters

int $precision

Return Value

void

at line 979
Fluent softDeletes(string $column = 'deleted_at', int $precision = 0)

Add a "deleted at" timestamp for the table.

Parameters

string $column
int $precision

Return Value

Fluent

at line 990
Fluent softDeletesTz(int $precision = 0)

Add a "deleted at" timestampTz for the table.

Parameters

int $precision

Return Value

Fluent

at line 1001
Fluent year(string $column)

Create a new year column on the table.

Parameters

string $column

Return Value

Fluent

at line 1012
Fluent binary(string $column)

Create a new binary column on the table.

Parameters

string $column

Return Value

Fluent

at line 1023
Fluent uuid(string $column)

Create a new uuid column on the table.

Parameters

string $column

Return Value

Fluent

at line 1034
Fluent ipAddress(string $column)

Create a new IP address column on the table.

Parameters

string $column

Return Value

Fluent

at line 1045
Fluent macAddress(string $column)

Create a new MAC address column on the table.

Parameters

string $column

Return Value

Fluent

at line 1056
Fluent geometry(string $column)

Create a new geometry column on the table.

Parameters

string $column

Return Value

Fluent

at line 1068
Fluent point(string $column, int|null $srid = null)

Create a new point column on the table.

Parameters

string $column
int|null $srid

Return Value

Fluent

at line 1079
Fluent lineString(string $column)

Create a new linestring column on the table.

Parameters

string $column

Return Value

Fluent

at line 1090
Fluent polygon(string $column)

Create a new polygon column on the table.

Parameters

string $column

Return Value

Fluent

at line 1101
Fluent geometryCollection(string $column)

Create a new geometrycollection column on the table.

Parameters

string $column

Return Value

Fluent

at line 1112
Fluent multiPoint(string $column)

Create a new multipoint column on the table.

Parameters

string $column

Return Value

Fluent

at line 1123
Fluent multiLineString(string $column)

Create a new multilinestring column on the table.

Parameters

string $column

Return Value

Fluent

at line 1134
Fluent multiPolygon(string $column)

Create a new multipolygon column on the table.

Parameters

string $column

Return Value

Fluent

at line 1146
void morphs(string $name, string|null $indexName = null)

Add the proper columns for a polymorphic table.

Parameters

string $name
string|null $indexName

Return Value

void

at line 1162
void nullableMorphs(string $name, string|null $indexName = null)

Add nullable columns for a polymorphic table.

Parameters

string $name
string|null $indexName

Return Value

void

at line 1176
Fluent rememberToken()

Adds the remember_token column to the table.

Return Value

Fluent

at line 1190
protected Fluent indexCommand(string $type, string|array $columns, string $index, string|null $algorithm = null)

Add a new index command to the blueprint.

Parameters

string $type
string|array $columns
string $index
string|null $algorithm

Return Value

Fluent

at line 1212
protected Fluent dropIndexCommand(string $command, string $type, string|array $index)

Create a new drop index command on the blueprint.

Parameters

string $command
string $type
string|array $index

Return Value

Fluent

at line 1233
protected string createIndexName(string $type, array $columns)

Create a default index name for the table.

Parameters

string $type
array $columns

Return Value

string

at line 1248
Fluent addColumn(string $type, string $name, array $parameters = [])

Add a new column to the blueprint.

Parameters

string $type
string $name
array $parameters

Return Value

Fluent

at line 1263
$this removeColumn(string $name)

Remove a column from the schema blueprint.

Parameters

string $name

Return Value

$this

at line 1279
protected Fluent addCommand(string $name, array $parameters = [])

Add a new command to the blueprint.

Parameters

string $name
array $parameters

Return Value

Fluent

at line 1293
protected Fluent createCommand(string $name, array $parameters = [])

Create a new Fluent command.

Parameters

string $name
array $parameters

Return Value

Fluent

at line 1303
string getTable()

Get the table the blueprint describes.

Return Value

string

at line 1313
Fluent[] getColumns()

Get the columns on the blueprint.

Return Value

Fluent[]

at line 1323
Fluent[] getCommands()

Get the commands on the blueprint.

Return Value

Fluent[]

at line 1333
Fluent[] getAddedColumns()

Get the columns on the blueprint that should be added.

Return Value

Fluent[]

at line 1345
Fluent[] getChangedColumns()

Get the columns on the blueprint that should be changed.

Return Value

Fluent[]