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

Blueprint

class Blueprint

Traits

Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected string $table

The table the blueprint describes.
protected array $columns

The columns that should be added to the table.
protected array $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, callable $macro)

Register a custom macro.

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
addImpliedCommands()

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

void
addFluentIndexes()

Add the index commands fluently specified on 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
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.

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
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)

Create a new date-time column on the table.

Fluent
dateTimeTz(string $column)

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

Fluent
time(string $column)

Create a new time column on the table.

Fluent
timeTz(string $column)

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

Fluent
timestamp(string $column)

Create a new timestamp column on the table.

Fluent
timestampTz(string $column)

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

void
timestamps()

Add nullable creation and update timestamps to the table.

void
nullableTimestamps()

Add nullable creation and update timestamps to the table.

void
timestampsTz()

Add creation and update timestampTz columns to the table.

Fluent
softDeletes(string $column = 'deleted_at')

Add a "deleted at" timestamp for the table.

Fluent
softDeletesTz()

Add a "deleted at" timestampTz for 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.

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.

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

in Macroable at line 24
static void macro(string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

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

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 49
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 71
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Create a new schema blueprint.

Parameters

string $table
Closure $callback

Return Value

void

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

Execute the blueprint against the database.

Parameters

Connection $connection
Grammar $grammar

Return Value

void

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

Get the raw SQL statements for the blueprint.

Parameters

Connection $connection
Grammar $grammar

Return Value

array

at line 124
protected void addImpliedCommands()

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

Return Value

void

at line 142
protected void addFluentIndexes()

Add the index commands fluently specified on columns.

Return Value

void

at line 172
protected bool creating()

Determine if the blueprint has a create command.

Return Value

bool

at line 184
Fluent create()

Indicate that the table needs to be created.

Return Value

Fluent

at line 194
void temporary()

Indicate that the table needs to be temporary.

Return Value

void

at line 204
Fluent drop()

Indicate that the table should be dropped.

Return Value

Fluent

at line 214
Fluent dropIfExists()

Indicate that the table should be dropped if it exists.

Return Value

Fluent

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

Indicate that the given columns should be dropped.

Parameters

array|mixed $columns

Return Value

Fluent

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

Indicate that the given columns should be renamed.

Parameters

string $from
string $to

Return Value

Fluent

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

Indicate that the given primary key should be dropped.

Parameters

string|array $index

Return Value

Fluent

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

Indicate that the given unique key should be dropped.

Parameters

string|array $index

Return Value

Fluent

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

Indicate that the given index should be dropped.

Parameters

string|array $index

Return Value

Fluent

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

Indicate that the given foreign key should be dropped.

Parameters

string|array $index

Return Value

Fluent

at line 293
void dropTimestamps()

Indicate that the timestamp columns should be dropped.

Return Value

void

at line 303
void dropTimestampsTz()

Indicate that the timestamp columns should be dropped.

Return Value

void

at line 313
void dropSoftDeletes()

Indicate that the soft delete column should be dropped.

Return Value

void

at line 323
void dropSoftDeletesTz()

Indicate that the soft delete column should be dropped.

Return Value

void

at line 333
void dropRememberToken()

Indicate that the remember token column should be dropped.

Return Value

void

at line 344
Fluent rename(string $to)

Rename the table to a given name.

Parameters

string $to

Return Value

Fluent

at line 357
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 370
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 383
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 395
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 406
Fluent increments(string $column)

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

Parameters

string $column

Return Value

Fluent

at line 417
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 428
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 439
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 450
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 462
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 476
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 489
Fluent text(string $column)

Create a new text column on the table.

Parameters

string $column

Return Value

Fluent

at line 500
Fluent mediumText(string $column)

Create a new medium text column on the table.

Parameters

string $column

Return Value

Fluent

at line 511
Fluent longText(string $column)

Create a new long text column on the table.

Parameters

string $column

Return Value

Fluent

at line 524
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 537
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 550
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 563
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 576
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 588
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 600
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 612
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 624
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 636
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 649
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 662
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 675
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 688
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 701
Fluent boolean(string $column)

Create a new boolean column on the table.

Parameters

string $column

Return Value

Fluent

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

Create a new enum column on the table.

Parameters

string $column
array $allowed

Return Value

Fluent

at line 724
Fluent json(string $column)

Create a new json column on the table.

Parameters

string $column

Return Value

Fluent

at line 735
Fluent jsonb(string $column)

Create a new jsonb column on the table.

Parameters

string $column

Return Value

Fluent

at line 746
Fluent date(string $column)

Create a new date column on the table.

Parameters

string $column

Return Value

Fluent

at line 757
Fluent dateTime(string $column)

Create a new date-time column on the table.

Parameters

string $column

Return Value

Fluent

at line 768
Fluent dateTimeTz(string $column)

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

Parameters

string $column

Return Value

Fluent

at line 779
Fluent time(string $column)

Create a new time column on the table.

Parameters

string $column

Return Value

Fluent

at line 790
Fluent timeTz(string $column)

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

Parameters

string $column

Return Value

Fluent

at line 801
Fluent timestamp(string $column)

Create a new timestamp column on the table.

Parameters

string $column

Return Value

Fluent

at line 812
Fluent timestampTz(string $column)

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

Parameters

string $column

Return Value

Fluent

at line 822
void timestamps()

Add nullable creation and update timestamps to the table.

Return Value

void

at line 836
void nullableTimestamps()

Add nullable creation and update timestamps to the table.

Alias for self::timestamps().

Return Value

void

at line 846
void timestampsTz()

Add creation and update timestampTz columns to the table.

Return Value

void

at line 859
Fluent softDeletes(string $column = 'deleted_at')

Add a "deleted at" timestamp for the table.

Parameters

string $column

Return Value

Fluent

at line 869
Fluent softDeletesTz()

Add a "deleted at" timestampTz for the table.

Return Value

Fluent

at line 880
Fluent binary(string $column)

Create a new binary column on the table.

Parameters

string $column

Return Value

Fluent

at line 891
Fluent uuid(string $column)

Create a new uuid column on the table.

Parameters

string $column

Return Value

Fluent

at line 902
Fluent ipAddress(string $column)

Create a new IP address column on the table.

Parameters

string $column

Return Value

Fluent

at line 913
Fluent macAddress(string $column)

Create a new MAC address column on the table.

Parameters

string $column

Return Value

Fluent

at line 925
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 941
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 955
Fluent rememberToken()

Adds the remember_token column to the table.

Return Value

Fluent

at line 969
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 991
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 1012
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 1027
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 1042
$this removeColumn(string $name)

Remove a column from the schema blueprint.

Parameters

string $name

Return Value

$this

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

Add a new command to the blueprint.

Parameters

string $name
array $parameters

Return Value

Fluent

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

Create a new Fluent command.

Parameters

string $name
array $parameters

Return Value

Fluent

at line 1082
string getTable()

Get the table the blueprint describes.

Return Value

string

at line 1092
array getColumns()

Get the columns on the blueprint.

Return Value

array

at line 1102
array getCommands()

Get the commands on the blueprint.

Return Value

array

at line 1112
array getAddedColumns()

Get the columns on the blueprint that should be added.

Return Value

array

at line 1124
array getChangedColumns()

Get the columns on the blueprint that should be changed.

Return Value

array