class Builder (View source)
| Macroable |
| static protected array | $macros | The registered string macros. | from Macroable |
| protected Connection | $connection | The database connection instance. | |
| protected Grammar | $grammar | The schema grammar instance. | |
| protected Closure | $resolver | The Blueprint resolver callback. | |
| static int|null | $defaultStringLength | The default string length for migrations. | |
| static string | $defaultMorphKeyType | The default relationship morph key type. |
| static void | macro(string $name, object|callable $macro)
Register a custom macro. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Mix another object into the class. | from Macroable |
| static bool | hasMacro(string $name)
Checks if macro is registered. | from Macroable |
| static void | flushMacros()
Flush the existing macros. | 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(Connection $connection)
Create a new database Schema manager. | |
| static void | defaultStringLength(int $length)
Set the default string length for migrations. | |
| static void | defaultMorphKeyType(string $type)
Set the default morph key type for migrations. | |
| static void | morphUsingUuids()
Set the default morph key type for migrations to UUIDs. | |
| static void | morphUsingUlids()
Set the default morph key type for migrations to ULIDs. | |
| bool | createDatabase(string $name)
Create a database in the schema. | |
| bool | dropDatabaseIfExists(string $name)
Drop a database from the schema if the database exists. | |
| bool | hasTable(string $table)
Determine if the given table exists. | |
| bool | hasView(string $view)
Determine if the given view exists. | |
| array | getTables()
Get the tables that belong to the database. | |
| array | getTableListing()
Get the names of the tables that belong to the database. | |
| array | getViews()
Get the views that belong to the database. | |
| array | getTypes()
Get the user-defined types that belong to the database. | |
| 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. | |
| void | whenTableHasColumn(string $table, string $column, Closure $callback)
Execute a table builder callback if the given table has a given column. | |
| void | whenTableDoesntHaveColumn(string $table, string $column, Closure $callback)
Execute a table builder callback if the given table doesn't have a given column. | |
| string | getColumnType(string $table, string $column, bool $fullDefinition = false)
Get the data type for the given column name. | |
| array | getColumnListing(string $table)
Get the column listing for a given table. | |
| array | getColumns(string $table)
Get the columns for a given table. | |
| array | getIndexes(string $table)
Get the indexes for a given table. | |
| array | getIndexListing(string $table)
Get the names of the indexes for a given table. | |
| bool | hasIndex(string $table, string|array $index, string|null $type = null)
Determine if the given table has a given index. | |
| array | getForeignKeys(string $table)
Get the foreign keys 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 | dropColumns(string $table, string|array $columns)
Drop columns from a table schema. | |
| void | dropAllTables()
Drop all tables from the database. | |
| void | dropAllViews()
Drop all views from the database. | |
| void | dropAllTypes()
Drop all types from the database. | |
| void | rename(string $from, string $to)
Rename a table on the schema. | |
| bool | enableForeignKeyConstraints()
Enable foreign key constraints. | |
| bool | disableForeignKeyConstraints()
Disable foreign key constraints. | |
| mixed | withoutForeignKeyConstraints(Closure $callback)
Disable foreign key constraints during the execution of a callback. | |
| void | build(Blueprint $blueprint)
Execute the blueprint to build / modify the table. | |
| Blueprint | createBlueprint(string $table, Closure|null $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. |
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Flush the existing macros.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new database Schema manager.
Set the default string length for migrations.
Set the default morph key type for migrations.
Set the default morph key type for migrations to UUIDs.
Set the default morph key type for migrations to ULIDs.
Create a database in the schema.
Drop a database from the schema if the database exists.
Determine if the given table exists.
Determine if the given view exists.
Get the tables that belong to the database.
Get the names of the tables that belong to the database.
Get the views that belong to the database.
Get the user-defined types that belong to the database.
Determine if the given table has a given column.
Determine if the given table has given columns.
Execute a table builder callback if the given table has a given column.
Execute a table builder callback if the given table doesn't have a given column.
Get the data type for the given column name.
Get the column listing for a given table.
Get the columns for a given table.
Get the indexes for a given table.
Get the names of the indexes for a given table.
Determine if the given table has a given index.
Get the foreign keys for a given table.
Modify a table on the schema.
Create a new table on the schema.
Drop a table from the schema.
Drop a table from the schema if it exists.
Drop columns from a table schema.
Drop all tables from the database.
Drop all views from the database.
Drop all types from the database.
Rename a table on the schema.
Enable foreign key constraints.
Disable foreign key constraints.
Disable foreign key constraints during the execution of a callback.
Execute the blueprint to build / modify the table.
Create a new command set with a Closure.
Get the database connection instance.
Set the database connection instance.
Set the Schema Blueprint resolver callback.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Schema/Builder.html