Class Illuminate\Database\Schema\Blueprint

`uses`	`Macroable`


					
	public

__construct(Connection $connection, string $table, Closure|null $callback = null): void

Create a new schema blueprint.

#


					
	public

build(): void

Execute the blueprint against the database.

#


					
	public

toSql(): array

Get the raw SQL statements for the blueprint.

#


					
	protected

ensureCommandsAreValid(): void

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

Throws

BadMethodCallException

#


					
	protected

commandsNamed(array $names): Collection

Get all of the commands matching the given names.

Deprecated

Will be removed in a future Laravel version.

#


					
	protected

addImpliedCommands(): void

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

#


					
	protected

addFluentIndexes(): void

Add the index commands fluently specified on columns.

#


					
	public

addFluentCommands(): void

Add the fluent commands specified on any columns.

#


					
	public

addAlterCommands(): void

Add the alter commands if whenever needed.

#


					
	public

creating(): bool

Determine if the blueprint has a create command.

#


					
	public

create(): Fluent

Indicate that the table needs to be created.

#


					
	public

engine(string $engine): void

Specify the storage engine that should be used for the table.

#


					
	public

innoDb(): void

Specify that the InnoDB storage engine should be used for the table (MySQL only).

#


					
	public

charset(string $charset): void

Specify the character set that should be used for the table.

#


					
	public

collation(string $collation): void

Specify the collation that should be used for the table.

#


					
	public

temporary(): void

Indicate that the table needs to be temporary.

#


					
	public

drop(): Fluent

Indicate that the table should be dropped.

#


					
	public

dropIfExists(): Fluent

Indicate that the table should be dropped if it exists.

#


					
	public

dropColumn(array|mixed $columns): Fluent

Indicate that the given columns should be dropped.

#


					
	public

renameColumn(string $from, string $to): Fluent

Indicate that the given columns should be renamed.

#


					
	public

dropPrimary(string|array|null $index = null): Fluent

Indicate that the given primary key should be dropped.

#


					
	public

dropUnique(string|array $index): Fluent

Indicate that the given unique key should be dropped.

#


					
	public

dropIndex(string|array $index): Fluent

Indicate that the given index should be dropped.

#


					
	public

dropFullText(string|array $index): Fluent

Indicate that the given fulltext index should be dropped.

#


					
	public

dropSpatialIndex(string|array $index): Fluent

Indicate that the given spatial index should be dropped.

#


					
	public

dropForeign(string|array $index): Fluent

Indicate that the given foreign key should be dropped.

#


					
	public

dropConstrainedForeignId(string $column): Fluent

Indicate that the given column and foreign key should be dropped.

#


					
	public

dropForeignIdFor(Model|string $model, string|null $column = null): Fluent

Indicate that the given foreign key should be dropped.

#


					
	public

dropConstrainedForeignIdFor(Model|string $model, string|null $column = null): Fluent

Indicate that the given foreign key should be dropped.

#


					
	public

renameIndex(string $from, string $to): Fluent

Indicate that the given indexes should be renamed.

#


					
	public

dropTimestamps(): void

Indicate that the timestamp columns should be dropped.

#


					
	public

dropTimestampsTz(): void

Indicate that the timestamp columns should be dropped.

#


					
	public

dropSoftDeletes(string $column = 'deleted_at'): void

Indicate that the soft delete column should be dropped.

#


					
	public

dropSoftDeletesTz(string $column = 'deleted_at'): void

Indicate that the soft delete column should be dropped.

#


					
	public

dropRememberToken(): void

Indicate that the remember token column should be dropped.

#


					
	public

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

Indicate that the polymorphic columns should be dropped.

#


					
	public

rename(string $to): Fluent

Rename the table to a given name.

#


					
	public

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

Specify the primary key(s) for the table.

#


					
	public

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

Specify a unique index for the table.

#


					
	public

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

Specify an index for the table.

#


					
	public

fullText(string|array $columns, string|null $name = null, string|null $algorithm = null): IndexDefinition

Specify a fulltext index for the table.

#


					
	public

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

Specify a spatial index for the table.

#


					
	public

rawIndex(string $expression, string $name): IndexDefinition

Specify a raw index for the table.

#


					
	public

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

Specify a foreign key for the table.

#


					
	public

id(string $column = 'id'): ColumnDefinition

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

#


					
	public

increments(string $column): ColumnDefinition

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

#


					
	public

integerIncrements(string $column): ColumnDefinition

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

#


					
	public

tinyIncrements(string $column): ColumnDefinition

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

#


					
	public

smallIncrements(string $column): ColumnDefinition

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

#


					
	public

mediumIncrements(string $column): ColumnDefinition

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

#


					
	public

bigIncrements(string $column): ColumnDefinition

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

#


					
	public

char(string $column, int|null $length = null): ColumnDefinition

Create a new char column on the table.

#


					
	public

string(string $column, int|null $length = null): ColumnDefinition

Create a new string column on the table.

#


					
	public

tinyText(string $column): ColumnDefinition

Create a new tiny text column on the table.

#


					
	public

text(string $column): ColumnDefinition

Create a new text column on the table.

#


					
	public

mediumText(string $column): ColumnDefinition

Create a new medium text column on the table.

#


					
	public

longText(string $column): ColumnDefinition

Create a new long text column on the table.

#


					
	public

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

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

#


					
	public

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

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

#


					
	public

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

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

#


					
	public

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

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

#


					
	public

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

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

#


					
	public

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

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

#


					
	public

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

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

#


					
	public

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

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

#


					
	public

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

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

#


					
	public

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

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

#


					
	public

foreignId(string $column): ForeignIdColumnDefinition

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

#


					
	public

foreignIdFor(Model|string $model, string|null $column = null): ForeignIdColumnDefinition

Create a foreign ID column for the given model.

#


					
	public

float(string $column, int $precision = 53): ColumnDefinition

Create a new float column on the table.

#


					
	public

double(string $column): ColumnDefinition

Create a new double column on the table.

#


					
	public

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

Create a new decimal column on the table.

#


					
	public

boolean(string $column): ColumnDefinition

Create a new boolean column on the table.

#


					
	public

enum(string $column, array $allowed): ColumnDefinition

Create a new enum column on the table.

#


					
	public

set(string $column, array $allowed): ColumnDefinition

Create a new set column on the table.

#


					
	public

json(string $column): ColumnDefinition

Create a new json column on the table.

#


					
	public

jsonb(string $column): ColumnDefinition

Create a new jsonb column on the table.

#


					
	public

date(string $column): ColumnDefinition

Create a new date column on the table.

#


					
	public

dateTime(string $column, int|null $precision = null): ColumnDefinition

Create a new date-time column on the table.

#


					
	public

dateTimeTz(string $column, int|null $precision = null): ColumnDefinition

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

#


					
	public

time(string $column, int|null $precision = null): ColumnDefinition

Create a new time column on the table.

#


					
	public

timeTz(string $column, int|null $precision = null): ColumnDefinition

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

#


					
	public

timestamp(string $column, int|null $precision = null): ColumnDefinition

Create a new timestamp column on the table.

#


					
	public

timestampTz(string $column, int|null $precision = null): ColumnDefinition

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

#


					
	public

timestamps(int|null $precision = null): void

Add nullable creation and update timestamps to the table.

#


					
	public

nullableTimestamps(int|null $precision = null): void

Add nullable creation and update timestamps to the table.

Alias for self::timestamps().

#


					
	public

timestampsTz(int|null $precision = null): void

Add creation and update timestampTz columns to the table.

#


					
	public

datetimes(int|null $precision = null): void

Add creation and update datetime columns to the table.

#


					
	public

softDeletes(string $column = 'deleted_at', int|null $precision = null): ColumnDefinition

Add a "deleted at" timestamp for the table.

#


					
	public

softDeletesTz(string $column = 'deleted_at', int|null $precision = null): ColumnDefinition

Add a "deleted at" timestampTz for the table.

#


					
	public

softDeletesDatetime(string $column = 'deleted_at', int|null $precision = null): ColumnDefinition

Add a "deleted at" datetime column to the table.

#


					
	public

year(string $column): ColumnDefinition

Create a new year column on the table.

#


					
	public

binary(string $column, int|null $length = null, bool $fixed = false): ColumnDefinition

Create a new binary column on the table.

#


					
	public

uuid(string $column = 'uuid'): ColumnDefinition

Create a new UUID column on the table.

#


					
	public

foreignUuid(string $column): ForeignIdColumnDefinition

Create a new UUID column on the table with a foreign key constraint.

#


					
	public

ulid(string $column = 'ulid', int|null $length = 26): ColumnDefinition

Create a new ULID column on the table.

#


					
	public

foreignUlid(string $column, int|null $length = 26): ForeignIdColumnDefinition

Create a new ULID column on the table with a foreign key constraint.

#


					
	public

ipAddress(string $column = 'ip_address'): ColumnDefinition

Create a new IP address column on the table.

#


					
	public

macAddress(string $column = 'mac_address'): ColumnDefinition

Create a new MAC address column on the table.

#


					
	public

geometry(string $column, string|null $subtype = null, int $srid = 0): ColumnDefinition

Create a new geometry column on the table.

#


					
	public

geography(string $column, string|null $subtype = null, int $srid = 4326): ColumnDefinition

Create a new geography column on the table.

#


					
	public

computed(string $column, string $expression): ColumnDefinition

Create a new generated, computed column on the table.

#


					
	public

vector(string $column, int|null $dimensions = null): ColumnDefinition

Create a new vector column on the table.

#


					
	public

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

Add the proper columns for a polymorphic table.

#


					
	public

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

Add nullable columns for a polymorphic table.

#


					
	public

numericMorphs(string $name, string|null $indexName = null): void

Add the proper columns for a polymorphic table using numeric IDs (incremental).

#


					
	public

nullableNumericMorphs(string $name, string|null $indexName = null): void

Add nullable columns for a polymorphic table using numeric IDs (incremental).

#


					
	public

uuidMorphs(string $name, string|null $indexName = null): void

Add the proper columns for a polymorphic table using UUIDs.

#


					
	public

nullableUuidMorphs(string $name, string|null $indexName = null): void

Add nullable columns for a polymorphic table using UUIDs.

#


					
	public

ulidMorphs(string $name, string|null $indexName = null): void

Add the proper columns for a polymorphic table using ULIDs.

#


					
	public

nullableUlidMorphs(string $name, string|null $indexName = null): void

Add nullable columns for a polymorphic table using ULIDs.

#


					
	public

rememberToken(): ColumnDefinition

Add the `remember_token` column to the table.

Add the remember_token column to the table.

#


					
	public

rawColumn(string $column, string $definition): ColumnDefinition

Create a new custom column on the table.

#


					
	public

comment(string $comment): Fluent

Add a comment to the table.

#


					
	protected

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

Add a new index command to the blueprint.

#


					
	protected

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

Create a new drop index command on the blueprint.

#


					
	protected

createIndexName(string $type, array $columns): string

Create a default index name for the table.

#


					
	public

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

Add a new column to the blueprint.

#


					
	protected

addColumnDefinition(ColumnDefinition $definition): ColumnDefinition

Add a new column definition to the blueprint.

#


					
	public

after(string $column, Closure $callback): void

Add the columns from the callback after the given column.

#


					
	public

removeColumn(string $name): $this

Remove a column from the schema blueprint.

#


					
	protected

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

Add a new command to the blueprint.

#


					
	protected

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

Create a new Fluent command.

#


					
	public

getTable(): string

Get the table the blueprint describes.

#


					
	public

getPrefix(): string

Get the table prefix.

Deprecated

Use DB::getTablePrefix()

#


					
	public

getColumns(): ColumnDefinition[]

Get the columns on the blueprint.

#


					
	public

getCommands(): Fluent[]

Get the commands on the blueprint.

#


					
	public

getState(): BlueprintState

Get the state of the blueprint.

#


					
	public

getAddedColumns(): ColumnDefinition[]

Get the columns on the blueprint that should be added.

#


					
	public

getChangedColumns(): ColumnDefinition[]

Get the columns on the blueprint that should be changed.

Deprecated

Will be removed in a future Laravel version.

#


					
	protected

defaultTimePrecision(): ?int

Get the default time precision.

#

Properties
`protected`	`Connection`	`$connection` The database connection instance. The database connection instance.	#
`protected`	`Grammar`	`$grammar` The schema grammar instance. The schema grammar instance.	#
`protected`	`string`	`$table`	#
`protected`	`ColumnDefinition[]`	`$columns = []`	#
`protected`	`Fluent[]`	`$commands = []`	#
`public`	`string`	`$engine`	#
`public`	`string`	`$charset`	#
`public`	`string`	`$collation`	#
`public`	`bool`	`$temporary = false`	#
`public`	`string`	`$after`	#
`protected`	`BlueprintState\|null`	`$state`	#

Namespaces

Classes

Class Illuminate\Database\Schema\Blueprint

Throws

Deprecated

Deprecated

Deprecated