class Blueprint (View source)

Properties

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

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.

create()

Indicate that the table needs to be created.

void
temporary()

Indicate that the table needs to be temporary.

drop()

Indicate that the table should be dropped.

dropIfExists()

Indicate that the table should be dropped if it exists.

dropColumn(array|mixed $columns)

Indicate that the given columns should be dropped.

renameColumn(string $from, string $to)

Indicate that the given columns should be renamed.

dropPrimary(string|array $index = null)

Indicate that the given primary key should be dropped.

dropUnique(string|array $index)

Indicate that the given unique key should be dropped.

dropIndex(string|array $index)

Indicate that the given index should be dropped.

dropForeign(string|array $index)

Indicate that the given foreign key should be dropped.

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.

rename(string $to)

Rename the table to a given name.

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

Specify the primary key(s) for the table.

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

Specify a unique index for the table.

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

Specify an index for the table.

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

Specify a foreign key for the table.

increments(string $column)

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

smallIncrements(string $column)

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

mediumIncrements(string $column)

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

bigIncrements(string $column)

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

char(string $column, int $length = 255)

Create a new char column on the table.

string(string $column, int $length = 255)

Create a new string column on the table.

text(string $column)

Create a new text column on the table.

mediumText(string $column)

Create a new medium text column on the table.

longText(string $column)

Create a new long text column on the table.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Create a new float column on the table.

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

Create a new double column on the table.

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

Create a new decimal column on the table.

boolean(string $column)

Create a new boolean column on the table.

enum(string $column, array $allowed)

Create a new enum column on the table.

json(string $column)

Create a new json column on the table.

jsonb(string $column)

Create a new jsonb column on the table.

date(string $column)

Create a new date column on the table.

dateTime(string $column)

Create a new date-time column on the table.

dateTimeTz(string $column)

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

time(string $column)

Create a new time column on the table.

timeTz(string $column)

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

timestamp(string $column)

Create a new timestamp column on the table.

timestampTz(string $column)

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

void
nullableTimestamps()

Add nullable creation and update timestamps to the table.

void
timestamps()

Add nullable creation and update timestamps to the table.

void
timestampsTz()

Add creation and update timestampTz columns to the table.

softDeletes()

Add a "deleted at" timestamp for the table.

softDeletesTz()

Add a "deleted at" timestampTz for the table.

binary(string $column)

Create a new binary column on the table.

uuid(string $column)

Create a new uuid column on the table.

ipAddress(string $column)

Create a new IP address column on the table.

macAddress(string $column)

Create a new MAC address 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.

rememberToken()

Adds the remember_token column to the table.

addColumn(string $type, string $name, array $parameters = array())

Add a new column to the blueprint.

$this
removeColumn(string $name)

Remove a column from the schema blueprint.

string
getTable()

Get the table the blueprint describes.

array
getColumns()

Get the columns on the blueprint.

array
getCommands()

Get the commands on the blueprint.

array
getAddedColumns()

Get the columns on the blueprint that should be added.

array
getChangedColumns()

Get the columns on the blueprint that should be changed.

Details

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

Create a new schema blueprint.

Parameters

string $table
Closure $callback

Return Value

void

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

Execute the blueprint against the database.

Parameters

Connection $connection
Grammar $grammar

Return Value

void

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

Get the raw SQL statements for the blueprint.

Parameters

Connection $connection
Grammar $grammar

Return Value

array

at line line 185
Fluent create()

Indicate that the table needs to be created.

Return Value

Fluent

at line line 195
void temporary()

Indicate that the table needs to be temporary.

Return Value

void

at line line 205
Fluent drop()

Indicate that the table should be dropped.

Return Value

Fluent

at line line 215
Fluent dropIfExists()

Indicate that the table should be dropped if it exists.

Return Value

Fluent

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

Indicate that the given columns should be dropped.

Parameters

array|mixed $columns

Return Value

Fluent

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

Indicate that the given columns should be renamed.

Parameters

string $from
string $to

Return Value

Fluent

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

Indicate that the given primary key should be dropped.

Parameters

string|array $index

Return Value

Fluent

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

Indicate that the given unique key should be dropped.

Parameters

string|array $index

Return Value

Fluent

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

Indicate that the given index should be dropped.

Parameters

string|array $index

Return Value

Fluent

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

Indicate that the given foreign key should be dropped.

Parameters

string|array $index

Return Value

Fluent

at line line 294
void dropTimestamps()

Indicate that the timestamp columns should be dropped.

Return Value

void

at line line 304
void dropTimestampsTz()

Indicate that the timestamp columns should be dropped.

Return Value

void

at line line 314
void dropSoftDeletes()

Indicate that the soft delete column should be dropped.

Return Value

void

at line line 324
void dropSoftDeletesTz()

Indicate that the soft delete column should be dropped.

Return Value

void

at line line 334
void dropRememberToken()

Indicate that the remember token column should be dropped.

Return Value

void

at line line 345
Fluent rename(string $to)

Rename the table to a given name.

Parameters

string $to

Return Value

Fluent

at line line 358
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 line 371
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 line 384
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 line 396
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 line 407
Fluent increments(string $column)

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

Parameters

string $column

Return Value

Fluent

at line line 418
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 line 429
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 line 440
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 line 452
Fluent char(string $column, int $length = 255)

Create a new char column on the table.

Parameters

string $column
int $length

Return Value

Fluent

at line line 464
Fluent string(string $column, int $length = 255)

Create a new string column on the table.

Parameters

string $column
int $length

Return Value

Fluent

at line line 475
Fluent text(string $column)

Create a new text column on the table.

Parameters

string $column

Return Value

Fluent

at line line 486
Fluent mediumText(string $column)

Create a new medium text column on the table.

Parameters

string $column

Return Value

Fluent

at line line 497
Fluent longText(string $column)

Create a new long text column on the table.

Parameters

string $column

Return Value

Fluent

at line line 510
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 line 523
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 line 536
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 line 549
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 line 562
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 line 574
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 line 586
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 line 598
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 line 610
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 line 622
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 line 635
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 line 648
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 line 661
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 line 672
Fluent boolean(string $column)

Create a new boolean column on the table.

Parameters

string $column

Return Value

Fluent

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

Create a new enum column on the table.

Parameters

string $column
array $allowed

Return Value

Fluent

at line line 695
Fluent json(string $column)

Create a new json column on the table.

Parameters

string $column

Return Value

Fluent

at line line 706
Fluent jsonb(string $column)

Create a new jsonb column on the table.

Parameters

string $column

Return Value

Fluent

at line line 717
Fluent date(string $column)

Create a new date column on the table.

Parameters

string $column

Return Value

Fluent

at line line 728
Fluent dateTime(string $column)

Create a new date-time column on the table.

Parameters

string $column

Return Value

Fluent

at line line 739
Fluent dateTimeTz(string $column)

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

Parameters

string $column

Return Value

Fluent

at line line 750
Fluent time(string $column)

Create a new time column on the table.

Parameters

string $column

Return Value

Fluent

at line line 761
Fluent timeTz(string $column)

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

Parameters

string $column

Return Value

Fluent

at line line 772
Fluent timestamp(string $column)

Create a new timestamp column on the table.

Parameters

string $column

Return Value

Fluent

at line line 783
Fluent timestampTz(string $column)

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

Parameters

string $column

Return Value

Fluent

at line line 795
void nullableTimestamps()

Add nullable creation and update timestamps to the table.

Alias for self::timestamps().

Return Value

void

at line line 805
void timestamps()

Add nullable creation and update timestamps to the table.

Return Value

void

at line line 817
void timestampsTz()

Add creation and update timestampTz columns to the table.

Return Value

void

at line line 829
Fluent softDeletes()

Add a "deleted at" timestamp for the table.

Return Value

Fluent

at line line 839
Fluent softDeletesTz()

Add a "deleted at" timestampTz for the table.

Return Value

Fluent

at line line 850
Fluent binary(string $column)

Create a new binary column on the table.

Parameters

string $column

Return Value

Fluent

at line line 861
Fluent uuid(string $column)

Create a new uuid column on the table.

Parameters

string $column

Return Value

Fluent

at line line 872
Fluent ipAddress(string $column)

Create a new IP address column on the table.

Parameters

string $column

Return Value

Fluent

at line line 883
Fluent macAddress(string $column)

Create a new MAC address column on the table.

Parameters

string $column

Return Value

Fluent

at line line 895
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 line 911
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 line 925
Fluent rememberToken()

Adds the remember_token column to the table.

Return Value

Fluent

at line line 999
Fluent addColumn(string $type, string $name, array $parameters = array())

Add a new column to the blueprint.

Parameters

string $type
string $name
array $parameters

Return Value

Fluent

at line line 1014
$this removeColumn(string $name)

Remove a column from the schema blueprint.

Parameters

string $name

Return Value

$this

at line line 1054
string getTable()

Get the table the blueprint describes.

Return Value

string

at line line 1064
array getColumns()

Get the columns on the blueprint.

Return Value

array

at line line 1074
array getCommands()

Get the commands on the blueprint.

Return Value

array

at line line 1084
array getAddedColumns()

Get the columns on the blueprint that should be added.

Return Value

array

at line line 1096
array getChangedColumns()

Get the columns on the blueprint that should be changed.

Return Value

array