Builder

class Builder (View source)

Properties

protected Connection $connection The database connection instance.
protected Grammar $grammar The schema grammar instance.
protected Closure $resolver The Blueprint resolver callback.

Methods

void __construct(Connection $connection)

Create a new database Schema manager.
bool hasTable(string $table)

Determine if the given table exists.
bool hasColumn(string $table, string $column)

Determine if the given table has a given column.
bool hasColumns(string $table, array $columns)

Determine if the given table has given columns.
string getColumnType(string $table, string $column)

Get the data type for the given column name.
array getColumnListing(string $table)

Get the column listing for a given table.
void table(string $table, Closure $callback)

Modify a table on the schema.
void create(string $table, Closure $callback)

Create a new table on the schema.
void drop(string $table)

Drop a table from the schema.
void dropIfExists(string $table)

Drop a table from the schema if it exists.
void rename(string $from, string $to)

Rename a table on the schema.
bool enableForeignKeyConstraints()

Enable foreign key constraints.
bool disableForeignKeyConstraints()

Disable foreign key constraints.
void build(Blueprint $blueprint)

Execute the blueprint to build / modify the table.
Blueprint createBlueprint(string $table, Closure $callback = null)

Create a new command set with a Closure.
Connection getConnection()

Get the database connection instance.
$this setConnection(Connection $connection)

Set the database connection instance.
void blueprintResolver(Closure $resolver)

Set the Schema Blueprint resolver callback.

Details

void __construct(Connection $connection)

Create a new database Schema manager.

Parameters

Connection $connection

Return Value

void

bool hasTable(string $table)

Determine if the given table exists.

Parameters

string $table

Return Value

bool

bool hasColumn(string $table, string $column)

Determine if the given table has a given column.

Parameters

string $table
string $column

Return Value

bool

bool hasColumns(string $table, array $columns)

Determine if the given table has given columns.

Parameters

string $table
array $columns

Return Value

bool

string getColumnType(string $table, string $column)

Get the data type for the given column name.

Parameters

string $table
string $column

Return Value

string

array getColumnListing(string $table)

Get the column listing for a given table.

Parameters

string $table

Return Value

array

void table(string $table, Closure $callback)

Modify a table on the schema.

Parameters

string $table
Closure $callback

Return Value

void

void create(string $table, Closure $callback)

Create a new table on the schema.

Parameters

string $table
Closure $callback

Return Value

void

void drop(string $table)

Drop a table from the schema.

Parameters

string $table

Return Value

void

void dropIfExists(string $table)

Drop a table from the schema if it exists.

Parameters

string $table

Return Value

void

void rename(string $from, string $to)

Rename a table on the schema.

Parameters

string $from
string $to

Return Value

void

bool enableForeignKeyConstraints()

Enable foreign key constraints.

Return Value

bool

bool disableForeignKeyConstraints()

Disable foreign key constraints.

Return Value

bool

protected void build(Blueprint $blueprint)

Execute the blueprint to build / modify the table.

Parameters

Blueprint $blueprint

Return Value

void

protected Blueprint createBlueprint(string $table, Closure $callback = null)

Create a new command set with a Closure.

Parameters

string $table
Closure $callback

Return Value

Blueprint

Connection getConnection()

Get the database connection instance.

Return Value

Connection

$this setConnection(Connection $connection)

Set the database connection instance.

Parameters

Connection $connection

Return Value

$this

void blueprintResolver(Closure $resolver)

Set the Schema Blueprint resolver callback.

Parameters

Closure $resolver

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Database/Schema/Builder.html