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

Builder

class Builder (View source)

Traits

Macroable

Properties

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 $defaultTimePrecision

The default time precision for migrations.
static string $defaultMorphKeyType

The default relationship morph key type.

Methods

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
__construct(Connection $connection)

Create a new database Schema manager.

static void
defaultStringLength(int $length)

Set the default string length for migrations.

static void
defaultTimePrecision(int|null $precision)

Set the default time precision 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.

array
getSchemas()

Get the schemas that belong to the connection.

bool
hasTable(string $table)

Determine if the given table exists.

bool
hasView(string $view)

Determine if the given view exists.

array
getTables(string|string[]|null $schema = null)

Get the tables that belong to the connection.

array
getTableListing(string|string[]|null $schema = null, bool $schemaQualified = true)

Get the names of the tables that belong to the connection.

array
getViews(string|string[]|null $schema = null)

Get the views that belong to the connection.

array
getTypes(string|string[]|null $schema = null)

Get the user-defined types that belong to the connection.

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.

string[]|null
getCurrentSchemaListing()

Get the names of the current schemas for the connection.

string|null
getCurrentSchemaName()

Get the default schema name for the connection.

array
parseSchemaAndTable(string $reference, string|bool|null $withDefaultSchema = null)

Parse the given database object reference and extract the schema and table.

Connection
getConnection()

Get the database connection instance.

void
blueprintResolver(Closure $resolver)

Set the Schema Blueprint resolver callback.

Details

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

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

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 61
__construct(Connection $connection)

Create a new database Schema manager.

Parameters

Connection $connection

at line 73
static void defaultStringLength(int $length)

Set the default string length for migrations.

Parameters

int $length

Return Value

void

at line 81
static void defaultTimePrecision(int|null $precision)

Set the default time precision for migrations.

Parameters

int|null $precision

Return Value

void

at line 94
static void defaultMorphKeyType(string $type)

Set the default morph key type for migrations.

Parameters

string $type

Return Value

void

Exceptions

InvalidArgumentException

at line 108
static void morphUsingUuids()

Set the default morph key type for migrations to UUIDs.

Return Value

void

at line 118
static void morphUsingUlids()

Set the default morph key type for migrations to ULIDs.

Return Value

void

at line 129
bool createDatabase(string $name)

Create a database in the schema.

Parameters

string $name

Return Value

bool

at line 142
bool dropDatabaseIfExists(string $name)

Drop a database from the schema if the database exists.

Parameters

string $name

Return Value

bool

at line 154
array getSchemas()

Get the schemas that belong to the connection.

Return Value

array

at line 167
bool hasTable(string $table)

Determine if the given table exists.

Parameters

string $table

Return Value

bool

at line 192
bool hasView(string $view)

Determine if the given view exists.

Parameters

string $view

Return Value

bool

at line 213
array getTables(string|string[]|null $schema = null)

Get the tables that belong to the connection.

Parameters

string|string[]|null $schema

Return Value

array

at line 227
array getTableListing(string|string[]|null $schema = null, bool $schemaQualified = true)

Get the names of the tables that belong to the connection.

Parameters

string|string[]|null $schema
bool $schemaQualified

Return Value

array

at line 241
array getViews(string|string[]|null $schema = null)

Get the views that belong to the connection.

Parameters

string|string[]|null $schema

Return Value

array

at line 254
array getTypes(string|string[]|null $schema = null)

Get the user-defined types that belong to the connection.

Parameters

string|string[]|null $schema

Return Value

array

at line 268
bool hasColumn(string $table, string $column)

Determine if the given table has a given column.

Parameters

string $table
string $column

Return Value

bool

at line 282
bool hasColumns(string $table, array $columns)

Determine if the given table has given columns.

Parameters

string $table
array $columns

Return Value

bool

at line 303
void whenTableHasColumn(string $table, string $column, Closure $callback)

Execute a table builder callback if the given table has a given column.

Parameters

string $table
string $column
Closure $callback

Return Value

void

at line 318
void whenTableDoesntHaveColumn(string $table, string $column, Closure $callback)

Execute a table builder callback if the given table doesn't have a given column.

Parameters

string $table
string $column
Closure $callback

Return Value

void

at line 333
string getColumnType(string $table, string $column, bool $fullDefinition = false)

Get the data type for the given column name.

Parameters

string $table
string $column
bool $fullDefinition

Return Value

string

at line 352
array getColumnListing(string $table)

Get the column listing for a given table.

Parameters

string $table

Return Value

array

at line 363
array getColumns(string $table)

Get the columns for a given table.

Parameters

string $table

Return Value

array

at line 382
array getIndexes(string $table)

Get the indexes for a given table.

Parameters

string $table

Return Value

array

at line 401
array getIndexListing(string $table)

Get the names of the indexes for a given table.

Parameters

string $table

Return Value

array

at line 414
bool hasIndex(string $table, string|array $index, string|null $type = null)

Determine if the given table has a given index.

Parameters

string $table
string|array $index
string|null $type

Return Value

bool

at line 438
array getForeignKeys(string $table)

Get the foreign keys for a given table.

Parameters

string $table

Return Value

array

at line 458
void table(string $table, Closure $callback)

Modify a table on the schema.

Parameters

string $table
Closure $callback

Return Value

void

at line 470
void create(string $table, Closure $callback)

Create a new table on the schema.

Parameters

string $table
Closure $callback

Return Value

void

at line 485
void drop(string $table)

Drop a table from the schema.

Parameters

string $table

Return Value

void

at line 498
void dropIfExists(string $table)

Drop a table from the schema if it exists.

Parameters

string $table

Return Value

void

at line 512
void dropColumns(string $table, string|array $columns)

Drop columns from a table schema.

Parameters

string $table
string|array $columns

Return Value

void

at line 526
void dropAllTables()

Drop all tables from the database.

Return Value

void

Exceptions

LogicException

at line 538
void dropAllViews()

Drop all views from the database.

Return Value

void

Exceptions

LogicException

at line 550
void dropAllTypes()

Drop all types from the database.

Return Value

void

Exceptions

LogicException

at line 562
void rename(string $from, string $to)

Rename a table on the schema.

Parameters

string $from
string $to

Return Value

void

at line 574
bool enableForeignKeyConstraints()

Enable foreign key constraints.

Return Value

bool

at line 586
bool disableForeignKeyConstraints()

Disable foreign key constraints.

Return Value

bool

at line 599
mixed withoutForeignKeyConstraints(Closure $callback)

Disable foreign key constraints during the execution of a callback.

Parameters

Closure $callback

Return Value

mixed

at line 616
protected void build(Blueprint $blueprint)

Execute the blueprint to build / modify the table.

Parameters

Blueprint $blueprint

Return Value

void

at line 628
protected Blueprint createBlueprint(string $table, Closure|null $callback = null)

Create a new command set with a Closure.

Parameters

string $table
Closure|null $callback

Return Value

Blueprint

at line 644
string[]|null getCurrentSchemaListing()

Get the names of the current schemas for the connection.

Return Value

string[]|null

at line 654
string|null getCurrentSchemaName()

Get the default schema name for the connection.

Return Value

string|null

at line 666
array parseSchemaAndTable(string $reference, string|bool|null $withDefaultSchema = null)

Parse the given database object reference and extract the schema and table.

Parameters

string $reference
string|bool|null $withDefaultSchema

Return Value

array

at line 693
Connection getConnection()

Get the database connection instance.

Return Value

Connection

at line 704
void blueprintResolver(Closure $resolver)

Set the Schema Blueprint resolver callback.

Parameters

Closure $resolver

Return Value

void