Illuminate\Database\Schema\Blueprint

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.

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

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

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

Create a new char column on the table.

Fluent

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

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

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

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

Create a new unsigned integer (4-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

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

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.

Fluent

softDeletes()

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

Fluent

rememberToken()

Adds the remember_token column to the table.

Fluent

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 dropRememberToken()`

Indicate that the remember token column should be dropped.

Return Value

void

at line line 335
`Fluent rename( string $to)`

Rename the table to a given name.

Parameters

string

$to

Return Value

Fluent

at line line 348
`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 361
`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 374
`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 386
`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 397
`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 408
`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 419
`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 430
`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 442
`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 454
`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 465
`Fluent text( string $column)`

Create a new text column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 476
`Fluent mediumText( string $column)`

Create a new medium text column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 487
`Fluent longText( string $column)`

Create a new long text column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 500
`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 513
`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 526
`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 539
`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 552
`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 564
`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 576
`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 588
`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 600
`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 612
`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 625
`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 638
`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 651
`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 662
`Fluent boolean( string $column)`

Create a new boolean column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 674
`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 685
`Fluent json( string $column)`

Create a new json column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 696
`Fluent jsonb( string $column)`

Create a new jsonb column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 707
`Fluent date( string $column)`

Create a new date column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 718
`Fluent dateTime( string $column)`

Create a new date-time column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 729
`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 740
`Fluent time( string $column)`

Create a new time column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 751
`Fluent timeTz( string $column)`

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

Parameters

string

$column

Return Value

Fluent

at line line 762
`Fluent timestamp( string $column)`

Create a new timestamp column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 773
`Fluent timestampTz( string $column)`

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

Parameters

string

$column

Return Value

Fluent

at line line 785
`void nullableTimestamps()`

Add nullable creation and update timestamps to the table.

Alias for self::timestamps().

Return Value

void

at line line 795
`void timestamps()`

Add nullable creation and update timestamps to the table.

Return Value

void

at line line 807
`void timestampsTz()`

Add creation and update timestampTz columns to the table.

Return Value

void

at line line 819
`Fluent softDeletes()`

Add a "deleted at" timestamp for the table.

Return Value

Fluent

at line line 830
`Fluent binary( string $column)`

Create a new binary column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 841
`Fluent uuid( string $column)`

Create a new uuid column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 852
`Fluent ipAddress( string $column)`

Create a new IP address column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 863
`Fluent macAddress( string $column)`

Create a new MAC address column on the table.

Parameters

string

$column

Return Value

Fluent

at line line 875
`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 889
`Fluent rememberToken()`

Adds the remember_token column to the table.

Return Value

Fluent

at line line 963
`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 978
`$this removeColumn( string $name)`

Remove a column from the schema blueprint.

Parameters

string

$name

Return Value

$this

at line line 1018
`string getTable()`

Get the table the blueprint describes.

Return Value

string

at line line 1028
`array getColumns()`

Get the columns on the blueprint.

Return Value

array

at line line 1038
`array getCommands()`

Get the commands on the blueprint.

Return Value

array

at line line 1048
`array getAddedColumns()`

Get the columns on the blueprint that should be added.

Return Value

array

at line line 1060
`array getChangedColumns()`

Get the columns on the blueprint that should be changed.

Return Value

array

Blueprint

Properties

Methods

Details

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

at line line 185 Fluent create()

Return Value

at line line 195 void temporary()

Return Value

at line line 205 Fluent drop()

Return Value

at line line 215 Fluent dropIfExists()

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

at line line 294 void dropTimestamps()

Return Value

at line line 304 void dropTimestampsTz()

Return Value

at line line 314 void dropSoftDeletes()

Return Value

at line line 324 void dropRememberToken()

Return Value

at line line 335 Fluent rename( string $to)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

at line line 397 Fluent increments( string $column)

Parameters

Return Value

at line line 408 Fluent smallIncrements( string $column)

Parameters

Return Value

at line line 419 Fluent mediumIncrements( string $column)

Parameters

Return Value

at line line 430 Fluent bigIncrements( string $column)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

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

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

at line line 185
`Fluent create()`

at line line 195
`void temporary()`

at line line 205
`Fluent drop()`

at line line 215
`Fluent dropIfExists()`

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

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

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

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

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

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

at line line 294
`void dropTimestamps()`

at line line 304
`void dropTimestampsTz()`

at line line 314
`void dropSoftDeletes()`

at line line 324
`void dropRememberToken()`

at line line 335
`Fluent rename( string $to)`

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

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

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

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

at line line 397
`Fluent increments( string $column)`

at line line 408
`Fluent smallIncrements( string $column)`

at line line 419
`Fluent mediumIncrements( string $column)`

at line line 430
`Fluent bigIncrements( string $column)`

at line line 442
`Fluent char( string $column, int $length = 255)`

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

at line line 465
`Fluent text( string $column)`

at line line 476
`Fluent mediumText( string $column)`

at line line 487
`Fluent longText( string $column)`

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

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

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

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

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

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

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

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

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

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

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

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

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

at line line 662
`Fluent boolean( string $column)`

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

at line line 685
`Fluent json( string $column)`

at line line 696
`Fluent jsonb( string $column)`

at line line 707
`Fluent date( string $column)`

at line line 718
`Fluent dateTime( string $column)`

at line line 729
`Fluent dateTimeTz( string $column)`

at line line 740
`Fluent time( string $column)`