1. class
  2. Illuminate
  3. \
  4. Database
  5. \
  6. Schema
  7. \
  8. Grammars
  9. \
  10. MySqlGrammar

MySqlGrammar

class MySqlGrammar extends Grammar (View source)

Traits

CompilesJsonPaths
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected Connection $connection

The connection used for escaping values.

 from  Grammar
protected string[] $modifiers

The possible column modifiers.
protected bool $transactions

If this Grammar supports schema changes wrapped in a transaction.

 from  Grammar
protected string[] $fluentCommands

The commands to be executed outside of create or alter commands.
protected string[] $serials

The possible column serials.

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 grammar instance.

from  Grammar
array
wrapArray(array $values)

Wrap an array of values.

from  Grammar
string
wrapTable(Expression|string $table, string|null $prefix = null)

Wrap a table in keyword identifiers.

from  Grammar
string
wrap(Expression|string $value)

Wrap a value in keyword identifiers.

from  Grammar
string
wrapAliasedValue(string $value)

Wrap a value that has an alias.

from  Grammar
string
wrapAliasedTable(string $value, string|null $prefix = null)

Wrap a table that has an alias.

from  Grammar
string
wrapSegments(array $segments)

Wrap the given value segments.

from  Grammar
string
wrapValue(string $value)

Wrap a single string in keyword identifiers.

string
wrapJsonSelector(string $value)

Wrap the given JSON selector.

bool
isJsonSelector(string $value)

Determine if the given string is a JSON selector.

from  Grammar
string
columnize(array $columns)

Convert an array of column names into a delimited string.

from  Grammar
string
parameterize(array $values)

Create query parameter place-holders for an array.

from  Grammar
string
parameter(mixed $value)

Get the appropriate query parameter place-holder for a value.

from  Grammar
string
quoteString(string|array $value)

Quote the given string literal.

from  Grammar
string
escape(string|float|int|bool|null $value, bool $binary = false)

Escapes a value for safe SQL embedding.

from  Grammar
bool
isExpression(mixed $value)

Determine if the given value is a raw expression.

from  Grammar
string|int|float
getValue(Expression|string|int|float $expression)

Transforms expressions to their scalar types.

from  Grammar
string
getDateFormat()

Get the format for database stored dates.

from  Grammar
string
getTablePrefix() deprecated

Get the grammar's table prefix.

from  Grammar
$this
setTablePrefix(string $prefix) deprecated

Set the grammar's table prefix.

from  Grammar
array
wrapJsonFieldAndPath(string $column)

Split the given JSON selector into the field and the optional path and wrap them separately.

from  CompilesJsonPaths
string
wrapJsonPath(string $value, string $delimiter = '->')

Wrap the given JSON path.

from  CompilesJsonPaths
string
wrapJsonPathSegment(string $segment)

Wrap the given JSON path segment.

from  CompilesJsonPaths
string
compileCreateDatabase(string $name)

Compile a create database command.

string
compileDropDatabaseIfExists(string $name)

Compile a drop database if exists command.

from  Grammar
string
compileSchemas()

Compile the query to determine the schemas.

string|null
compileTableExists(string|null $schema, string $table)

Compile the query to determine if the given table exists.

string
compileTables(string|string[]|null $schema)

Compile the query to determine the tables.

string
compileViews(string|string[]|null $schema)

Compile the query to determine the views.

string
compileTypes(string|string[]|null $schema)

Compile the query to determine the user-defined types.

from  Grammar
string
compileColumns(string|null $schema, string $table)

Compile the query to determine the columns.

string
compileIndexes(string|null $schema, string $table)

Compile the query to determine the indexes.

string
compileForeignKeys(string|null $schema, string $table)

Compile the query to determine the foreign keys.

array|string
compileRenameColumn(Blueprint $blueprint, Fluent $command)

Compile a rename column command.

array|string
compileChange(Blueprint $blueprint, Fluent $command)

Compile a change column command into a series of SQL statements.

string
compileFulltext(Blueprint $blueprint, Fluent $command)

Compile a fulltext index key command.

from  Grammar
string
compileDropFullText(Blueprint $blueprint, Fluent $command)

Compile a drop fulltext index command.

string
compileForeign(Blueprint $blueprint, Fluent $command)

Compile a foreign key command.

from  Grammar
string
compileDropForeign(Blueprint $blueprint, Fluent $command)

Compile a drop foreign key command.

array
getColumns(Blueprint $blueprint)

Compile the blueprint's added column definitions.

from  Grammar
string
getColumn(Blueprint $blueprint, ColumnDefinition $column)

Compile the column definition.

from  Grammar
string
getType(Fluent $column)

Get the SQL for the column data type.

from  Grammar
void
typeComputed(Fluent $column)

Create the column definition for a generated, computed column type.

string
typeVector(Fluent $column)

Create the column definition for a vector type.

string
typeRaw(Fluent $column)

Create the column definition for a raw column type.

from  Grammar
string
addModifiers(string $sql, Blueprint $blueprint, Fluent $column)

Add the column modifiers to the definition.

from  Grammar
Fluent|null
getCommandByName(Blueprint $blueprint, string $name)

Get the command with a given name if it exists on the blueprint.

from  Grammar
array
getCommandsByName(Blueprint $blueprint, string $name)

Get all of the commands with a given name.

from  Grammar
hasCommand(Blueprint $blueprint, $name)

No description

from  Grammar
array
prefixArray(string $prefix, array $values)

Add a prefix to an array of values.

from  Grammar
string
getDefaultValue(mixed $value)

Format a value so that it can be used in "default" clauses.

from  Grammar
array
getFluentCommands()

Get the fluent commands for the grammar.

from  Grammar
bool
supportsSchemaTransactions()

Check if this Grammar supports schema changes wrapped in a transaction.

from  Grammar
string
compileSchemaWhereClause(string|string[]|null $schema, string $column)

Compile the query to compare the schema.

string
compileCreate(Blueprint $blueprint, Fluent $command)

Compile a create table command.

string
compileCreateTable(Blueprint $blueprint, Fluent $command)

Create the main create table clause.

string
compileCreateEncoding(string $sql, Blueprint $blueprint)

Append the character set specifications to a command.

string
compileCreateEngine(string $sql, Blueprint $blueprint)

Append the engine specifications to a command.

string
compileAdd(Blueprint $blueprint, Fluent $command)

Compile an add column command.

string
compileAutoIncrementStartingValues(Blueprint $blueprint, Fluent $command)

Compile the auto-incrementing column starting values.

string
compileLegacyRenameColumn(Blueprint $blueprint, Fluent $command)

Compile a rename column command for legacy versions of MySQL.

string
compilePrimary(Blueprint $blueprint, Fluent $command)

Compile a primary key command.

string
compileUnique(Blueprint $blueprint, Fluent $command)

Compile a unique key command.

string
compileIndex(Blueprint $blueprint, Fluent $command)

Compile a plain index key command.

string
compileFullText(Blueprint $blueprint, Fluent $command)

Compile a fulltext index key command.

string
compileSpatialIndex(Blueprint $blueprint, Fluent $command)

Compile a spatial index key command.

string
compileKey(Blueprint $blueprint, Fluent $command, string $type)

Compile an index creation command.

string
compileDrop(Blueprint $blueprint, Fluent $command)

Compile a drop table command.

string
compileDropIfExists(Blueprint $blueprint, Fluent $command)

Compile a drop table (if exists) command.

string
compileDropColumn(Blueprint $blueprint, Fluent $command)

Compile a drop column command.

string
compileDropPrimary(Blueprint $blueprint, Fluent $command)

Compile a drop primary key command.

string
compileDropUnique(Blueprint $blueprint, Fluent $command)

Compile a drop unique key command.

string
compileDropIndex(Blueprint $blueprint, Fluent $command)

Compile a drop index command.

string
compileDropSpatialIndex(Blueprint $blueprint, Fluent $command)

Compile a drop spatial index command.

string
compileRename(Blueprint $blueprint, Fluent $command)

Compile a rename table command.

string
compileRenameIndex(Blueprint $blueprint, Fluent $command)

Compile a rename index command.

string
compileDropAllTables(array $tables)

Compile the SQL needed to drop all tables.

string
compileDropAllViews(array $views)

Compile the SQL needed to drop all views.

string
compileEnableForeignKeyConstraints()

Compile the command to enable foreign key constraints.

string
compileDisableForeignKeyConstraints()

Compile the command to disable foreign key constraints.

string
compileTableComment(Blueprint $blueprint, Fluent $command)

Compile a table comment command.

array
escapeNames(array $names)

Quote-escape the given tables, views, or types.

string
typeChar(Fluent $column)

Create the column definition for a char type.

string
typeString(Fluent $column)

Create the column definition for a string type.

string
typeTinyText(Fluent $column)

Create the column definition for a tiny text type.

string
typeText(Fluent $column)

Create the column definition for a text type.

string
typeMediumText(Fluent $column)

Create the column definition for a medium text type.

string
typeLongText(Fluent $column)

Create the column definition for a long text type.

string
typeBigInteger(Fluent $column)

Create the column definition for a big integer type.

string
typeInteger(Fluent $column)

Create the column definition for an integer type.

string
typeMediumInteger(Fluent $column)

Create the column definition for a medium integer type.

string
typeTinyInteger(Fluent $column)

Create the column definition for a tiny integer type.

string
typeSmallInteger(Fluent $column)

Create the column definition for a small integer type.

string
typeFloat(Fluent $column)

Create the column definition for a float type.

string
typeDouble(Fluent $column)

Create the column definition for a double type.

string
typeDecimal(Fluent $column)

Create the column definition for a decimal type.

string
typeBoolean(Fluent $column)

Create the column definition for a boolean type.

string
typeEnum(Fluent $column)

Create the column definition for an enumeration type.

string
typeSet(Fluent $column)

Create the column definition for a set enumeration type.

string
typeJson(Fluent $column)

Create the column definition for a json type.

string
typeJsonb(Fluent $column)

Create the column definition for a jsonb type.

string
typeDate(Fluent $column)

Create the column definition for a date type.

string
typeDateTime(Fluent $column)

Create the column definition for a date-time type.

string
typeDateTimeTz(Fluent $column)

Create the column definition for a date-time (with time zone) type.

string
typeTime(Fluent $column)

Create the column definition for a time type.

string
typeTimeTz(Fluent $column)

Create the column definition for a time (with time zone) type.

string
typeTimestamp(Fluent $column)

Create the column definition for a timestamp type.

string
typeTimestampTz(Fluent $column)

Create the column definition for a timestamp (with time zone) type.

string
typeYear(Fluent $column)

Create the column definition for a year type.

string
typeBinary(Fluent $column)

Create the column definition for a binary type.

string
typeUuid(Fluent $column)

Create the column definition for a uuid type.

string
typeIpAddress(Fluent $column)

Create the column definition for an IP address type.

string
typeMacAddress(Fluent $column)

Create the column definition for a MAC address type.

string
typeGeometry(Fluent $column)

Create the column definition for a spatial Geometry type.

string
typeGeography(Fluent $column)

Create the column definition for a spatial Geography type.

string|null
modifyVirtualAs(Blueprint $blueprint, Fluent $column)

Get the SQL for a generated virtual column modifier.

string|null
modifyStoredAs(Blueprint $blueprint, Fluent $column)

Get the SQL for a generated stored column modifier.

string|null
modifyUnsigned(Blueprint $blueprint, Fluent $column)

Get the SQL for an unsigned column modifier.

string|null
modifyCharset(Blueprint $blueprint, Fluent $column)

Get the SQL for a character set column modifier.

string|null
modifyCollate(Blueprint $blueprint, Fluent $column)

Get the SQL for a collation column modifier.

string|null
modifyNullable(Blueprint $blueprint, Fluent $column)

Get the SQL for a nullable column modifier.

string|null
modifyInvisible(Blueprint $blueprint, Fluent $column)

Get the SQL for an invisible column modifier.

string|null
modifyDefault(Blueprint $blueprint, Fluent $column)

Get the SQL for a default column modifier.

string|null
modifyOnUpdate(Blueprint $blueprint, Fluent $column)

Get the SQL for an "on update" column modifier.

string|null
modifyIncrement(Blueprint $blueprint, Fluent $column)

Get the SQL for an auto-increment column modifier.

string|null
modifyFirst(Blueprint $blueprint, Fluent $column)

Get the SQL for a "first" column modifier.

string|null
modifyAfter(Blueprint $blueprint, Fluent $column)

Get the SQL for an "after" column modifier.

string|null
modifyComment(Blueprint $blueprint, Fluent $column)

Get the SQL for a "comment" column modifier.

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

in Grammar at line 26
__construct(Connection $connection)

Create a new grammar instance.

Parameters

Connection $connection

in Grammar at line 37
array wrapArray(array $values)

Wrap an array of values.

Parameters

array $values

Return Value

array

in Grammar at line 447
string wrapTable(Expression|string $table, string|null $prefix = null)

Wrap a table in keyword identifiers.

Parameters

Expression|string $table
string|null $prefix

Return Value

string

in Grammar at line 461
string wrap(Expression|string $value)

Wrap a value in keyword identifiers.

Parameters

Expression|string $value

Return Value

string

in Grammar at line 113
protected string wrapAliasedValue(string $value)

Wrap a value that has an alias.

Parameters

string $value

Return Value

string

in Grammar at line 127
protected string wrapAliasedTable(string $value, string|null $prefix = null)

Wrap a table that has an alias.

Parameters

string $value
string|null $prefix

Return Value

string

in Grammar at line 142
protected string wrapSegments(array $segments)

Wrap the given value segments.

Parameters

array $segments

Return Value

string

at line 1364
protected string wrapValue(string $value)

Wrap a single string in keyword identifiers.

Parameters

string $value

Return Value

string

at line 1379
protected string wrapJsonSelector(string $value)

Wrap the given JSON selector.

Parameters

string $value

Return Value

string

in Grammar at line 185
protected bool isJsonSelector(string $value)

Determine if the given string is a JSON selector.

Parameters

string $value

Return Value

bool

in Grammar at line 196
string columnize(array $columns)

Convert an array of column names into a delimited string.

Parameters

array $columns

Return Value

string

in Grammar at line 207
string parameterize(array $values)

Create query parameter place-holders for an array.

Parameters

array $values

Return Value

string

in Grammar at line 218
string parameter(mixed $value)

Get the appropriate query parameter place-holder for a value.

Parameters

mixed $value

Return Value

string

in Grammar at line 229
string quoteString(string|array $value)

Quote the given string literal.

Parameters

string|array $value

Return Value

string

in Grammar at line 245
string escape(string|float|int|bool|null $value, bool $binary = false)

Escapes a value for safe SQL embedding.

Parameters

string|float|int|bool|null $value
bool $binary

Return Value

string

in Grammar at line 256
bool isExpression(mixed $value)

Determine if the given value is a raw expression.

Parameters

mixed $value

Return Value

bool

in Grammar at line 267
string|int|float getValue(Expression|string|int|float $expression)

Transforms expressions to their scalar types.

Parameters

Expression|string|int|float $expression

Return Value

string|int|float

in Grammar at line 281
string getDateFormat()

Get the format for database stored dates.

Return Value

string

in Grammar at line 293
string getTablePrefix() deprecated

deprecated Use DB::getTablePrefix()

Get the grammar's table prefix.

Return Value

string

in Grammar at line 306
$this setTablePrefix(string $prefix) deprecated

deprecated Use DB::setTablePrefix()

Set the grammar's table prefix.

Parameters

string $prefix

Return Value

$this

in CompilesJsonPaths at line 16
protected array wrapJsonFieldAndPath(string $column)

Split the given JSON selector into the field and the optional path and wrap them separately.

Parameters

string $column

Return Value

array

in CompilesJsonPaths at line 34
protected string wrapJsonPath(string $value, string $delimiter = '->')

Wrap the given JSON path.

Parameters

string $value
string $delimiter

Return Value

string

in CompilesJsonPaths at line 51
protected string wrapJsonPathSegment(string $segment)

Wrap the given JSON path segment.

Parameters

string $segment

Return Value

string

at line 44
string compileCreateDatabase(string $name)

Compile a create database command.

Parameters

string $name

Return Value

string

in Grammar at line 57
string compileDropDatabaseIfExists(string $name)

Compile a drop database if exists command.

Parameters

string $name

Return Value

string

at line 64
string compileSchemas()

Compile the query to determine the schemas.

Return Value

string

at line 78
string|null compileTableExists(string|null $schema, string $table)

Compile the query to determine if the given table exists.

Parameters

string|null $schema
string $table

Return Value

string|null

at line 94
string compileTables(string|string[]|null $schema)

Compile the query to determine the tables.

Parameters

string|string[]|null $schema

Return Value

string

at line 112
string compileViews(string|string[]|null $schema)

Compile the query to determine the views.

Parameters

string|string[]|null $schema

Return Value

string

in Grammar at line 120
string compileTypes(string|string[]|null $schema)

Compile the query to determine the user-defined types.

Parameters

string|string[]|null $schema

Return Value

string

Exceptions

RuntimeException

at line 143
string compileColumns(string|null $schema, string $table)

Compile the query to determine the columns.

Parameters

string|null $schema
string $table

Return Value

string

at line 164
string compileIndexes(string|null $schema, string $table)

Compile the query to determine the indexes.

Parameters

string|null $schema
string $table

Return Value

string

at line 183
string compileForeignKeys(string|null $schema, string $table)

Compile the query to determine the foreign keys.

Parameters

string|null $schema
string $table

Return Value

string

at line 341
array|string compileRenameColumn(Blueprint $blueprint, Fluent $command)

Compile a rename column command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

array|string

at line 406
array|string compileChange(Blueprint $blueprint, Fluent $command)

Compile a change column command into a series of SQL statements.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

array|string

in Grammar at line 206
string compileFulltext(Blueprint $blueprint, Fluent $command)

Compile a fulltext index key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

Exceptions

RuntimeException

at line 589
string compileDropFullText(Blueprint $blueprint, Fluent $command)

Compile a drop fulltext index command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

in Grammar at line 232
string compileForeign(Blueprint $blueprint, Fluent $command)

Compile a foreign key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 613
string compileDropForeign(Blueprint $blueprint, Fluent $command)

Compile a drop foreign key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

in Grammar at line 283
protected array getColumns(Blueprint $blueprint)

Compile the blueprint's added column definitions.

Parameters

Blueprint $blueprint

Return Value

array

in Grammar at line 301
protected string getColumn(Blueprint $blueprint, ColumnDefinition $column)

Compile the column definition.

Parameters

Blueprint $blueprint
ColumnDefinition $column

Return Value

string

in Grammar at line 317
protected string getType(Fluent $column)

Get the SQL for the column data type.

Parameters

Fluent $column

Return Value

string

at line 1133
protected void typeComputed(Fluent $column)

Create the column definition for a generated, computed column type.

Parameters

Fluent $column

Return Value

void

Exceptions

RuntimeException

at line 1144
protected string typeVector(Fluent $column)

Create the column definition for a vector type.

Parameters

Fluent $column

Return Value

string

in Grammar at line 354
protected string typeRaw(Fluent $column)

Create the column definition for a raw column type.

Parameters

Fluent $column

Return Value

string

in Grammar at line 367
protected string addModifiers(string $sql, Blueprint $blueprint, Fluent $column)

Add the column modifiers to the definition.

Parameters

string $sql
Blueprint $blueprint
Fluent $column

Return Value

string

in Grammar at line 385
protected Fluent|null getCommandByName(Blueprint $blueprint, string $name)

Get the command with a given name if it exists on the blueprint.

Parameters

Blueprint $blueprint
string $name

Return Value

Fluent|null

in Grammar at line 401
protected array getCommandsByName(Blueprint $blueprint, string $name)

Get all of the commands with a given name.

Parameters

Blueprint $blueprint
string $name

Return Value

array

in Grammar at line 415
protected hasCommand(Blueprint $blueprint, $name)

No description

Parameters

Blueprint $blueprint
$name

in Grammar at line 433
array prefixArray(string $prefix, array $values)

Add a prefix to an array of values.

Parameters

string $prefix
array $values

Return Value

array

in Grammar at line 474
protected string getDefaultValue(mixed $value)

Format a value so that it can be used in "default" clauses.

Parameters

mixed $value

Return Value

string

in Grammar at line 494
array getFluentCommands()

Get the fluent commands for the grammar.

Return Value

array

in Grammar at line 504
bool supportsSchemaTransactions()

Check if this Grammar supports schema changes wrapped in a transaction.

Return Value

bool

at line 127
protected string compileSchemaWhereClause(string|string[]|null $schema, string $column)

Compile the query to compare the schema.

Parameters

string|string[]|null $schema
string $column

Return Value

string

at line 209
string compileCreate(Blueprint $blueprint, Fluent $command)

Compile a create table command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 235
protected string compileCreateTable(Blueprint $blueprint, Fluent $command)

Create the main create table clause.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 263
protected string compileCreateEncoding(string $sql, Blueprint $blueprint)

Append the character set specifications to a command.

Parameters

string $sql
Blueprint $blueprint

Return Value

string

at line 293
protected string compileCreateEngine(string $sql, Blueprint $blueprint)

Append the engine specifications to a command.

Parameters

string $sql
Blueprint $blueprint

Return Value

string

at line 311
string compileAdd(Blueprint $blueprint, Fluent $command)

Compile an add column command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 326
string compileAutoIncrementStartingValues(Blueprint $blueprint, Fluent $command)

Compile the auto-incrementing column starting values.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 361
protected string compileLegacyRenameColumn(Blueprint $blueprint, Fluent $command)

Compile a rename column command for legacy versions of MySQL.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 428
string compilePrimary(Blueprint $blueprint, Fluent $command)

Compile a primary key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 444
string compileUnique(Blueprint $blueprint, Fluent $command)

Compile a unique key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 456
string compileIndex(Blueprint $blueprint, Fluent $command)

Compile a plain index key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 468
string compileFullText(Blueprint $blueprint, Fluent $command)

Compile a fulltext index key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 480
string compileSpatialIndex(Blueprint $blueprint, Fluent $command)

Compile a spatial index key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 493
protected string compileKey(Blueprint $blueprint, Fluent $command, string $type)

Compile an index creation command.

Parameters

Blueprint $blueprint
Fluent $command
string $type

Return Value

string

at line 511
string compileDrop(Blueprint $blueprint, Fluent $command)

Compile a drop table command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 523
string compileDropIfExists(Blueprint $blueprint, Fluent $command)

Compile a drop table (if exists) command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 535
string compileDropColumn(Blueprint $blueprint, Fluent $command)

Compile a drop column command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 549
string compileDropPrimary(Blueprint $blueprint, Fluent $command)

Compile a drop primary key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 561
string compileDropUnique(Blueprint $blueprint, Fluent $command)

Compile a drop unique key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 575
string compileDropIndex(Blueprint $blueprint, Fluent $command)

Compile a drop index command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 601
string compileDropSpatialIndex(Blueprint $blueprint, Fluent $command)

Compile a drop spatial index command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 627
string compileRename(Blueprint $blueprint, Fluent $command)

Compile a rename table command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 641
string compileRenameIndex(Blueprint $blueprint, Fluent $command)

Compile a rename index command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 656
string compileDropAllTables(array $tables)

Compile the SQL needed to drop all tables.

Parameters

array $tables

Return Value

string

at line 667
string compileDropAllViews(array $views)

Compile the SQL needed to drop all views.

Parameters

array $views

Return Value

string

at line 677
string compileEnableForeignKeyConstraints()

Compile the command to enable foreign key constraints.

Return Value

string

at line 687
string compileDisableForeignKeyConstraints()

Compile the command to disable foreign key constraints.

Return Value

string

at line 699
string compileTableComment(Blueprint $blueprint, Fluent $command)

Compile a table comment command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 713
array escapeNames(array $names)

Quote-escape the given tables, views, or types.

Parameters

array $names

Return Value

array

at line 727
protected string typeChar(Fluent $column)

Create the column definition for a char type.

Parameters

Fluent $column

Return Value

string

at line 738
protected string typeString(Fluent $column)

Create the column definition for a string type.

Parameters

Fluent $column

Return Value

string

at line 749
protected string typeTinyText(Fluent $column)

Create the column definition for a tiny text type.

Parameters

Fluent $column

Return Value

string

at line 760
protected string typeText(Fluent $column)

Create the column definition for a text type.

Parameters

Fluent $column

Return Value

string

at line 771
protected string typeMediumText(Fluent $column)

Create the column definition for a medium text type.

Parameters

Fluent $column

Return Value

string

at line 782
protected string typeLongText(Fluent $column)

Create the column definition for a long text type.

Parameters

Fluent $column

Return Value

string

at line 793
protected string typeBigInteger(Fluent $column)

Create the column definition for a big integer type.

Parameters

Fluent $column

Return Value

string

at line 804
protected string typeInteger(Fluent $column)

Create the column definition for an integer type.

Parameters

Fluent $column

Return Value

string

at line 815
protected string typeMediumInteger(Fluent $column)

Create the column definition for a medium integer type.

Parameters

Fluent $column

Return Value

string

at line 826
protected string typeTinyInteger(Fluent $column)

Create the column definition for a tiny integer type.

Parameters

Fluent $column

Return Value

string

at line 837
protected string typeSmallInteger(Fluent $column)

Create the column definition for a small integer type.

Parameters

Fluent $column

Return Value

string

at line 848
protected string typeFloat(Fluent $column)

Create the column definition for a float type.

Parameters

Fluent $column

Return Value

string

at line 863
protected string typeDouble(Fluent $column)

Create the column definition for a double type.

Parameters

Fluent $column

Return Value

string

at line 874
protected string typeDecimal(Fluent $column)

Create the column definition for a decimal type.

Parameters

Fluent $column

Return Value

string

at line 885
protected string typeBoolean(Fluent $column)

Create the column definition for a boolean type.

Parameters

Fluent $column

Return Value

string

at line 896
protected string typeEnum(Fluent $column)

Create the column definition for an enumeration type.

Parameters

Fluent $column

Return Value

string

at line 907
protected string typeSet(Fluent $column)

Create the column definition for a set enumeration type.

Parameters

Fluent $column

Return Value

string

at line 918
protected string typeJson(Fluent $column)

Create the column definition for a json type.

Parameters

Fluent $column

Return Value

string

at line 929
protected string typeJsonb(Fluent $column)

Create the column definition for a jsonb type.

Parameters

Fluent $column

Return Value

string

at line 940
protected string typeDate(Fluent $column)

Create the column definition for a date type.

Parameters

Fluent $column

Return Value

string

at line 951
protected string typeDateTime(Fluent $column)

Create the column definition for a date-time type.

Parameters

Fluent $column

Return Value

string

at line 972
protected string typeDateTimeTz(Fluent $column)

Create the column definition for a date-time (with time zone) type.

Parameters

Fluent $column

Return Value

string

at line 983
protected string typeTime(Fluent $column)

Create the column definition for a time type.

Parameters

Fluent $column

Return Value

string

at line 994
protected string typeTimeTz(Fluent $column)

Create the column definition for a time (with time zone) type.

Parameters

Fluent $column

Return Value

string

at line 1005
protected string typeTimestamp(Fluent $column)

Create the column definition for a timestamp type.

Parameters

Fluent $column

Return Value

string

at line 1026
protected string typeTimestampTz(Fluent $column)

Create the column definition for a timestamp (with time zone) type.

Parameters

Fluent $column

Return Value

string

at line 1037
protected string typeYear(Fluent $column)

Create the column definition for a year type.

Parameters

Fluent $column

Return Value

string

at line 1048
protected string typeBinary(Fluent $column)

Create the column definition for a binary type.

Parameters

Fluent $column

Return Value

string

at line 1063
protected string typeUuid(Fluent $column)

Create the column definition for a uuid type.

Parameters

Fluent $column

Return Value

string

at line 1074
protected string typeIpAddress(Fluent $column)

Create the column definition for an IP address type.

Parameters

Fluent $column

Return Value

string

at line 1085
protected string typeMacAddress(Fluent $column)

Create the column definition for a MAC address type.

Parameters

Fluent $column

Return Value

string

at line 1096
protected string typeGeometry(Fluent $column)

Create the column definition for a spatial Geometry type.

Parameters

Fluent $column

Return Value

string

at line 1120
protected string typeGeography(Fluent $column)

Create the column definition for a spatial Geography type.

Parameters

Fluent $column

Return Value

string

at line 1158
protected string|null modifyVirtualAs(Blueprint $blueprint, Fluent $column)

Get the SQL for a generated virtual column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1180
protected string|null modifyStoredAs(Blueprint $blueprint, Fluent $column)

Get the SQL for a generated stored column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1202
protected string|null modifyUnsigned(Blueprint $blueprint, Fluent $column)

Get the SQL for an unsigned column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1216
protected string|null modifyCharset(Blueprint $blueprint, Fluent $column)

Get the SQL for a character set column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1230
protected string|null modifyCollate(Blueprint $blueprint, Fluent $column)

Get the SQL for a collation column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1244
protected string|null modifyNullable(Blueprint $blueprint, Fluent $column)

Get the SQL for a nullable column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1265
protected string|null modifyInvisible(Blueprint $blueprint, Fluent $column)

Get the SQL for an invisible column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1279
protected string|null modifyDefault(Blueprint $blueprint, Fluent $column)

Get the SQL for a default column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1293
protected string|null modifyOnUpdate(Blueprint $blueprint, Fluent $column)

Get the SQL for an "on update" column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1307
protected string|null modifyIncrement(Blueprint $blueprint, Fluent $column)

Get the SQL for an auto-increment column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1323
protected string|null modifyFirst(Blueprint $blueprint, Fluent $column)

Get the SQL for a "first" column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1337
protected string|null modifyAfter(Blueprint $blueprint, Fluent $column)

Get the SQL for an "after" column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null

at line 1351
protected string|null modifyComment(Blueprint $blueprint, Fluent $column)

Get the SQL for a "comment" column modifier.

Parameters

Blueprint $blueprint
Fluent $column

Return Value

string|null