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

Grammar

abstract class Grammar 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.
protected array $fluentCommands

The commands to be executed outside of create or alter command.

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.

string
wrap(Expression|string $value)

Wrap a value in keyword identifiers.

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.

from  Grammar
string
wrapJsonSelector(string $value)

Wrap the given JSON selector.

from  Grammar
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.

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.

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.

string
compileDropFullText(Blueprint $blueprint, Fluent $command)

Compile a drop fulltext index command.

string
compileForeign(Blueprint $blueprint, Fluent $command)

Compile a foreign key command.

string
compileDropForeign(Blueprint $blueprint, Fluent $command)

Compile a drop foreign key command.

array
getColumns(Blueprint $blueprint)

Compile the blueprint's added column definitions.

string
getColumn(Blueprint $blueprint, ColumnDefinition $column)

Compile the column definition.

string
getType(Fluent $column)

Get the SQL for the column data type.

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.

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

Add the column modifiers to the definition.

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

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

array
getCommandsByName(Blueprint $blueprint, string $name)

Get all of the commands with a given name.

hasCommand(Blueprint $blueprint, $name)

No description

array
prefixArray(string $prefix, array $values)

Add a prefix to an array of values.

string
getDefaultValue(mixed $value)

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

array
getFluentCommands()

Get the fluent commands for the grammar.

bool
supportsSchemaTransactions()

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

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

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

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

in Grammar at line 157
protected string wrapValue(string $value)

Wrap a single string in keyword identifiers.

Parameters

string $value

Return Value

string

in Grammar at line 174
protected string wrapJsonSelector(string $value)

Wrap the given JSON selector.

Parameters

string $value

Return Value

string

Exceptions

RuntimeException

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

at line 57
string compileDropDatabaseIfExists(string $name)

Compile a drop database if exists command.

Parameters

string $name

Return Value

string

at line 69
string compileSchemas()

Compile the query to determine the schemas.

Return Value

string

at line 81
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

Exceptions

RuntimeException

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

Compile the query to determine the views.

Parameters

string|string[]|null $schema

Return Value

string

Exceptions

RuntimeException

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 134
string compileColumns(string|null $schema, string $table)

Compile the query to determine the columns.

Parameters

string|null $schema
string $table

Return Value

string

Exceptions

RuntimeException

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

Compile the query to determine the indexes.

Parameters

string|null $schema
string $table

Return Value

string

Exceptions

RuntimeException

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

Compile the query to determine the foreign keys.

Parameters

string|null $schema
string $table

Return Value

string

Exceptions

RuntimeException

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

Compile a rename column command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

array|string

at line 192
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

Exceptions

RuntimeException

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 220
string compileDropFullText(Blueprint $blueprint, Fluent $command)

Compile a drop fulltext index command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

Exceptions

RuntimeException

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

Compile a foreign key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

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

Compile a drop foreign key command.

Parameters

Blueprint $blueprint
Fluent $command

Return Value

string

at line 283
protected array getColumns(Blueprint $blueprint)

Compile the blueprint's added column definitions.

Parameters

Blueprint $blueprint

Return Value

array

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

Compile the column definition.

Parameters

Blueprint $blueprint
ColumnDefinition $column

Return Value

string

at line 317
protected string getType(Fluent $column)

Get the SQL for the column data type.

Parameters

Fluent $column

Return Value

string

at line 330
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 343
protected string typeVector(Fluent $column)

Create the column definition for a vector type.

Parameters

Fluent $column

Return Value

string

Exceptions

RuntimeException

at line 354
protected string typeRaw(Fluent $column)

Create the column definition for a raw column type.

Parameters

Fluent $column

Return Value

string

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

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

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

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

No description

Parameters

Blueprint $blueprint
$name

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

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

at line 494
array getFluentCommands()

Get the fluent commands for the grammar.

Return Value

array

at line 504
bool supportsSchemaTransactions()

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

Return Value

bool