Illuminate\Database\Schema\Grammars\PostgresGrammar

class PostgresGrammar extends Grammar (View source)

Traits

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	$tablePrefix	The grammar table prefix.	from Grammar
protected string[]	$modifiers	The possible column modifiers.
protected bool	$transactions	If this Grammar supports schema changes wrapped in a transaction.
protected string[]	$fluentCommands	The commands to be executed outside of create or alter command.
protected string[]	$serials	The columns available as serials.

Methods

static void

macro(string $name, object|callable $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

array

wrapArray(array $values)

Wrap an array of values.

from Grammar

string

wrapTable(Expression|string $table)

Wrap a table in keyword identifiers.

from Grammar

string

wrap(Expression|string $value, bool $prefixAlias = false)

Wrap a value in keyword identifiers.

from Grammar

string

wrapAliasedValue(string $value, bool $prefixAlias = false)

Wrap a value 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()

Get the grammar's table prefix.

from Grammar

$this

setTablePrefix(string $prefix)

Set the grammar's table prefix.

from Grammar

$this

setConnection(Connection $connection)

Set the grammar's database connection.

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

void

compileCreateDatabase(string $name, Connection $connection)

Compile a create database command.

void

compileDropDatabaseIfExists(string $name)

Compile a drop database if exists command.

array|string

compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)

Compile a rename column command.

array|string

compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)

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.

array

getColumns(Blueprint $blueprint)

Compile the blueprint's added column definitions.

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.

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 primary key command 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

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

TableDiff

getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)

Create an empty Doctrine DBAL TableDiff from the Blueprint.

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

compileTableExists()

Compile the query to determine if a table exists.

string

compileTables()

Compile the query to determine the tables.

string

compileViews()

Compile the query to determine the views.

string

compileTypes()

Compile the query to determine the user-defined types.

string

compileGetAllTables(string|array $searchPath) deprecated

Compile the SQL needed to retrieve all table names.

string

compileGetAllViews(string|array $searchPath) deprecated

Compile the SQL needed to retrieve all view names.

string

compileColumnListing() deprecated

Compile the query to determine the list of columns.

string

compileColumns(string $database, string $schema, string $table)

Compile the query to determine the columns.

string

compileIndexes(string $schema, string $table)

Compile the query to determine the indexes.

string

compileForeignKeys(string $schema, string $table)

Compile the query to determine the foreign keys.

string

compileCreate(Blueprint $blueprint, Fluent $command)

Compile a create table command.

string

compileAdd(Blueprint $blueprint, Fluent $command)

Compile a column addition command.

string

compileAutoIncrementStartingValues(Blueprint $blueprint, Fluent $command)

Compile the auto-incrementing column starting values.

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

compileSpatialIndex(Blueprint $blueprint, Fluent $command)

Compile a spatial index key 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

compileDropAllTables(array $tables)

Compile the SQL needed to drop all tables.

string

compileDropAllViews(array $views)

Compile the SQL needed to drop all views.

string

compileDropAllTypes(array $types)

Compile the SQL needed to drop all types.

string

compileDropAllDomains(array $domains)

Compile the SQL needed to drop all domains.

string

compileGetAllTypes() deprecated

Compile the SQL needed to retrieve all type names.

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

compileDropForeign(Blueprint $blueprint, Fluent $command)

Compile a drop foreign key command.

string

compileRename(Blueprint $blueprint, Fluent $command)

Compile a rename table command.

string

compileRenameIndex(Blueprint $blueprint, Fluent $command)

Compile a rename index command.

string

compileEnableForeignKeyConstraints()

Compile the command to enable foreign key constraints.

string

compileDisableForeignKeyConstraints()

Compile the command to disable foreign key constraints.

string

compileComment(Blueprint $blueprint, Fluent $command)

Compile a comment command.

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

typeInteger(Fluent $column)

Create the column definition for an integer type.

string

typeBigInteger(Fluent $column)

Create the column definition for a big 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

typeReal(Fluent $column)

Create the column definition for a real 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

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

typePoint(Fluent $column)

Create the column definition for a spatial Point type.

string

typeLineString(Fluent $column)

Create the column definition for a spatial LineString type.

string

typePolygon(Fluent $column)

Create the column definition for a spatial Polygon type.

string

typeGeometryCollection(Fluent $column)

Create the column definition for a spatial GeometryCollection type.

string

typeMultiPoint(Fluent $column)

Create the column definition for a spatial MultiPoint type.

string

typeMultiLineString(Fluent $column)

Create the column definition for a spatial MultiLineString type.

string

typeMultiPolygon(Fluent $column)

Create the column definition for a spatial MultiPolygon type.

string

typeMultiPolygonZ(Fluent $column)

Create the column definition for a spatial MultiPolygonZ type.

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

modifyDefault(Blueprint $blueprint, Fluent $column)

Get the SQL for a default column modifier.

string|null

modifyIncrement(Blueprint $blueprint, Fluent $column)

Get the SQL for an auto-increment column modifier.

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|array|null

modifyGeneratedAs(Blueprint $blueprint, Fluent $column)

Get the SQL for an identity column modifier.

Details

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

in Macroable at line 40
`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 59
`static bool hasMacro(string $name)`

Checks if macro is registered.

Parameters

string

$name

Return Value

bool

in Macroable at line 69
`static void flushMacros()`

Flush the existing macros.

Return Value

void

in Macroable at line 83
`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 109
`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 33
`array wrapArray(array $values)`

Wrap an array of values.

Parameters

array

$values

Return Value

array

in Grammar at line 280
`string wrapTable(Expression|string $table)`

Wrap a table in keyword identifiers.

Parameters

Expression|string

$table

Return Value

string

in Grammar at line 294
`string wrap(Expression|string $value, bool $prefixAlias = false)`

Wrap a value in keyword identifiers.

Parameters

Expression\|string	$value
bool	$prefixAlias

Return Value

string

in Grammar at line 90
`protected string wrapAliasedValue(string $value, bool $prefixAlias = false)`

Wrap a value that has an alias.

Parameters

string	$value
bool	$prefixAlias

Return Value

string

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

Wrap the given value segments.

Parameters

array

$segments

Return Value

string

in Grammar at line 125
`protected string wrapValue(string $value)`

Wrap a single string in keyword identifiers.

Parameters

string

$value

Return Value

string

in Grammar at line 142
`protected string wrapJsonSelector(string $value)`

Wrap the given JSON selector.

Parameters

string

$value

Return Value

string

Exceptions

RuntimeException

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

Determine if the given string is a JSON selector.

Parameters

string

$value

Return Value

bool

in Grammar at line 164
`string columnize(array $columns)`

Convert an array of column names into a delimited string.

Parameters

array

$columns

Return Value

string

in Grammar at line 175
`string parameterize(array $values)`

Create query parameter place-holders for an array.

Parameters

array

$values

Return Value

string

in Grammar at line 186
`string parameter(mixed $value)`

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

Parameters

mixed

$value

Return Value

string

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

Quote the given string literal.

Parameters

string|array

$value

Return Value

string

in Grammar at line 213
`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 228
`bool isExpression(mixed $value)`

Determine if the given value is a raw expression.

Parameters

mixed

$value

Return Value

bool

in Grammar at line 239
`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 253
`string getDateFormat()`

Get the format for database stored dates.

Return Value

string

in Grammar at line 263
`string getTablePrefix()`

Get the grammar's table prefix.

Return Value

string

in Grammar at line 274
`$this setTablePrefix(string $prefix)`

Set the grammar's table prefix.

Parameters

string

$prefix

Return Value

$this

in Grammar at line 287
`$this setConnection(Connection $connection)`

Set the grammar's database connection.

Parameters

Connection

$connection

Return Value

$this

in CompilesJsonPaths at line 15
`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 33
`protected string wrapJsonPath(string $value, string $delimiter = '->')`

Wrap the given JSON path.

Parameters

string	$value
string	$delimiter

Return Value

string

in CompilesJsonPaths at line 50
`protected string wrapJsonPathSegment(string $segment)`

Wrap the given JSON path segment.

Parameters

string

$segment

Return Value

string

at line 48
`void compileCreateDatabase(string $name, Connection $connection)`

Compile a create database command.

Parameters

string	$name
Connection	$connection

Return Value

void

at line 63
`void compileDropDatabaseIfExists(string $name)`

Compile a drop database if exists command.

Parameters

string

$name

Return Value

void

at line 294
`array|string compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)`

Compile a rename column command.

Parameters

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Return Value

array|string

at line 315
`array|string compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)`

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

Parameters

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Return Value

array|string

Exceptions

RuntimeException

at line 412
`string compileFulltext(Blueprint $blueprint, Fluent $command)`

Compile a fulltext index key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

Exceptions

RuntimeException

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

Compile a drop fulltext index command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a foreign key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile the blueprint's added column definitions.

Parameters

Blueprint

$blueprint

Return Value

array

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

Get the SQL for the column data type.

Parameters

Fluent

$column

Return Value

string

in Grammar at line 206
`protected void typeComputed(Fluent $column)`

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

Parameters

Fluent

$column

Return Value

void

Exceptions

RuntimeException

in Grammar at line 219
`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 237
`protected Fluent|null getCommandByName(Blueprint $blueprint, string $name)`

Get the primary key command if it exists on the blueprint.

Parameters

Blueprint	$blueprint
string	$name

Return Value

Fluent|null

in Grammar at line 253
`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 267
`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 307
`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 329
`TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)`

Create an empty Doctrine DBAL TableDiff from the Blueprint.

Parameters

Blueprint	$blueprint
AbstractSchemaManager	$schema

Return Value

TableDiff

in Grammar at line 343
`array getFluentCommands()`

Get the fluent commands for the grammar.

Return Value

array

in Grammar at line 353
`bool supportsSchemaTransactions()`

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

Return Value

bool

at line 76
`string compileTableExists()`

Compile the query to determine if a table exists.

Return Value

string

at line 86
`string compileTables()`

Compile the query to determine the tables.

Return Value

string

at line 99
`string compileViews()`

Compile the query to determine the views.

Return Value

string

at line 109
`string compileTypes()`

Compile the query to determine the user-defined types.

Return Value

string

at line 130
`string compileGetAllTables(string|array $searchPath) deprecated`

deprecated Will be removed in a future Laravel version.

Compile the SQL needed to retrieve all table names.

Parameters

string|array

$searchPath

Return Value

string

at line 143
`string compileGetAllViews(string|array $searchPath) deprecated`

deprecated Will be removed in a future Laravel version.

Compile the SQL needed to retrieve all view names.

Parameters

string|array

$searchPath

Return Value

string

at line 155
`string compileColumnListing() deprecated`

deprecated Will be removed in a future Laravel version.

Compile the query to determine the list of columns.

Return Value

string

at line 168
`string compileColumns(string $database, string $schema, string $table)`

Compile the query to determine the columns.

Parameters

string	$database
string	$schema
string	$table

Return Value

string

at line 191
`string compileIndexes(string $schema, string $table)`

Compile the query to determine the indexes.

Parameters

string	$schema
string	$table

Return Value

string

at line 217
`string compileForeignKeys(string $schema, string $table)`

Compile the query to determine the foreign keys.

Parameters

string	$schema
string	$table

Return Value

string

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

Compile a create table command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a column addition command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile the auto-incrementing column starting values.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a primary key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a unique key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a plain index key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a spatial index key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop table command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop table (if exists) command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

at line 497
`string compileDropAllTables(array $tables)`

Compile the SQL needed to drop all tables.

Parameters

array

$tables

Return Value

string

at line 508
`string compileDropAllViews(array $views)`

Compile the SQL needed to drop all views.

Parameters

array

$views

Return Value

string

at line 519
`string compileDropAllTypes(array $types)`

Compile the SQL needed to drop all types.

Parameters

array

$types

Return Value

string

at line 530
`string compileDropAllDomains(array $domains)`

Compile the SQL needed to drop all domains.

Parameters

array

$domains

Return Value

string

at line 542
`string compileGetAllTypes() deprecated`

deprecated Will be removed in a future Laravel version.

Compile the SQL needed to retrieve all type names.

Return Value

string

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

Compile a drop column command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop primary key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop unique key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop index command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop spatial index command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop foreign key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a rename table command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a rename index command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

at line 673
`string compileEnableForeignKeyConstraints()`

Compile the command to enable foreign key constraints.

Return Value

string

at line 683
`string compileDisableForeignKeyConstraints()`

Compile the command to disable foreign key constraints.

Return Value

string

at line 695
`string compileComment(Blueprint $blueprint, Fluent $command)`

Compile a comment command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a table comment command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

at line 727
`array escapeNames(array $names)`

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

Parameters

array

$names

Return Value

array

at line 742
`protected string typeChar(Fluent $column)`

Create the column definition for a char type.

Parameters

Fluent

$column

Return Value

string

at line 757
`protected string typeString(Fluent $column)`

Create the column definition for a string type.

Parameters

Fluent

$column

Return Value

string

at line 772
`protected string typeTinyText(Fluent $column)`

Create the column definition for a tiny text type.

Parameters

Fluent

$column

Return Value

string

at line 783
`protected string typeText(Fluent $column)`

Create the column definition for a text type.

Parameters

Fluent

$column

Return Value

string

at line 794
`protected string typeMediumText(Fluent $column)`

Create the column definition for a medium text type.

Parameters

Fluent

$column

Return Value

string

at line 805
`protected string typeLongText(Fluent $column)`

Create the column definition for a long text type.

Parameters

Fluent

$column

Return Value

string

at line 816
`protected string typeInteger(Fluent $column)`

Create the column definition for an integer type.

Parameters

Fluent

$column

Return Value

string

at line 827
`protected string typeBigInteger(Fluent $column)`

Create the column definition for a big integer type.

Parameters

Fluent

$column

Return Value

string

at line 838
`protected string typeMediumInteger(Fluent $column)`

Create the column definition for a medium integer type.

Parameters

Fluent

$column

Return Value

string

at line 849
`protected string typeTinyInteger(Fluent $column)`

Create the column definition for a tiny integer type.

Parameters

Fluent

$column

Return Value

string

at line 860
`protected string typeSmallInteger(Fluent $column)`

Create the column definition for a small integer type.

Parameters

Fluent

$column

Return Value

string

at line 871
`protected string typeFloat(Fluent $column)`

Create the column definition for a float type.

Parameters

Fluent

$column

Return Value

string

at line 882
`protected string typeDouble(Fluent $column)`

Create the column definition for a double type.

Parameters

Fluent

$column

Return Value

string

at line 893
`protected string typeReal(Fluent $column)`

Create the column definition for a real type.

Parameters

Fluent

$column

Return Value

string

at line 904
`protected string typeDecimal(Fluent $column)`

Create the column definition for a decimal type.

Parameters

Fluent

$column

Return Value

string

at line 915
`protected string typeBoolean(Fluent $column)`

Create the column definition for a boolean type.

Parameters

Fluent

$column

Return Value

string

at line 926
`protected string typeEnum(Fluent $column)`

Create the column definition for an enumeration type.

Parameters

Fluent

$column

Return Value

string

at line 941
`protected string typeJson(Fluent $column)`

Create the column definition for a json type.

Parameters

Fluent

$column

Return Value

string

at line 952
`protected string typeJsonb(Fluent $column)`

Create the column definition for a jsonb type.

Parameters

Fluent

$column

Return Value

string

at line 963
`protected string typeDate(Fluent $column)`

Create the column definition for a date type.

Parameters

Fluent

$column

Return Value

string

at line 974
`protected string typeDateTime(Fluent $column)`

Create the column definition for a date-time type.

Parameters

Fluent

$column

Return Value

string

at line 985
`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 996
`protected string typeTime(Fluent $column)`

Create the column definition for a time type.

Parameters

Fluent

$column

Return Value

string

at line 1007
`protected string typeTimeTz(Fluent $column)`

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

Parameters

Fluent

$column

Return Value

string

at line 1018
`protected string typeTimestamp(Fluent $column)`

Create the column definition for a timestamp type.

Parameters

Fluent

$column

Return Value

string

at line 1033
`protected string typeTimestampTz(Fluent $column)`

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

Parameters

Fluent

$column

Return Value

string

at line 1048
`protected string typeYear(Fluent $column)`

Create the column definition for a year type.

Parameters

Fluent

$column

Return Value

string

at line 1059
`protected string typeBinary(Fluent $column)`

Create the column definition for a binary type.

Parameters

Fluent

$column

Return Value

string

at line 1070
`protected string typeUuid(Fluent $column)`

Create the column definition for a uuid type.

Parameters

Fluent

$column

Return Value

string

at line 1081
`protected string typeIpAddress(Fluent $column)`

Create the column definition for an IP address type.

Parameters

Fluent

$column

Return Value

string

at line 1092
`protected string typeMacAddress(Fluent $column)`

Create the column definition for a MAC address type.

Parameters

Fluent

$column

Return Value

string

at line 1103
`protected string typeGeometry(Fluent $column)`

Create the column definition for a spatial Geometry type.

Parameters

Fluent

$column

Return Value

string

at line 1114
`protected string typePoint(Fluent $column)`

Create the column definition for a spatial Point type.

Parameters

Fluent

$column

Return Value

string

at line 1125
`protected string typeLineString(Fluent $column)`

Create the column definition for a spatial LineString type.

Parameters

Fluent

$column

Return Value

string

at line 1136
`protected string typePolygon(Fluent $column)`

Create the column definition for a spatial Polygon type.

Parameters

Fluent

$column

Return Value

string

at line 1147
`protected string typeGeometryCollection(Fluent $column)`

Create the column definition for a spatial GeometryCollection type.

Parameters

Fluent

$column

Return Value

string

at line 1158
`protected string typeMultiPoint(Fluent $column)`

Create the column definition for a spatial MultiPoint type.

Parameters

Fluent

$column

Return Value

string

at line 1169
`string typeMultiLineString(Fluent $column)`

Create the column definition for a spatial MultiLineString type.

Parameters

Fluent

$column

Return Value

string

at line 1180
`protected string typeMultiPolygon(Fluent $column)`

Create the column definition for a spatial MultiPolygon type.

Parameters

Fluent

$column

Return Value

string

at line 1191
`protected string typeMultiPolygonZ(Fluent $column)`

Create the column definition for a spatial MultiPolygonZ type.

Parameters

Fluent

$column

Return Value

string

at line 1223
`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 1237
`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 1253
`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 1271
`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 1287
`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 1311
`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 1335
`protected string|array|null modifyGeneratedAs(Blueprint $blueprint, Fluent $column)`

Get the SQL for an identity column modifier.

Parameters

Blueprint	$blueprint
Fluent	$column

Return Value

string|array|null

PostgresGrammar

Traits

Properties

Methods

Details

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

Parameters

Return Value

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

Parameters

Return Value

Exceptions

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

Parameters

Return Value

in Macroable at line 69 static void flushMacros()

Return Value

in Macroable at line 83 static mixed __callStatic(string $method, array $parameters)

Parameters

Return Value

Exceptions

in Macroable at line 109 mixed __call(string $method, array $parameters)

Parameters

Return Value

Exceptions

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

Parameters

Return Value

in Grammar at line 280 string wrapTable(Expression|string $table)

Parameters

Return Value

in Grammar at line 294 string wrap(Expression|string $value, bool $prefixAlias = false)

Parameters

Return Value

in Grammar at line 90 protected string wrapAliasedValue(string $value, bool $prefixAlias = false)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

Exceptions

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in Grammar at line 253 string getDateFormat()

Return Value

in Grammar at line 263 string getTablePrefix()

Return Value

in Grammar at line 274 $this setTablePrefix(string $prefix)

Parameters

Return Value

in Grammar at line 287 $this setConnection(Connection $connection)

Parameters

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

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

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

in Macroable at line 69
`static void flushMacros()`

in Macroable at line 83
`static mixed __callStatic(string $method, array $parameters)`

in Macroable at line 109
`mixed __call(string $method, array $parameters)`

in Grammar at line 33
`array wrapArray(array $values)`

in Grammar at line 280
`string wrapTable(Expression|string $table)`

in Grammar at line 294
`string wrap(Expression|string $value, bool $prefixAlias = false)`

in Grammar at line 90
`protected string wrapAliasedValue(string $value, bool $prefixAlias = false)`

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

in Grammar at line 125
`protected string wrapValue(string $value)`

in Grammar at line 142
`protected string wrapJsonSelector(string $value)`

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

in Grammar at line 164
`string columnize(array $columns)`

in Grammar at line 175
`string parameterize(array $values)`

in Grammar at line 186
`string parameter(mixed $value)`

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

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

in Grammar at line 228
`bool isExpression(mixed $value)`

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

in Grammar at line 253
`string getDateFormat()`

in Grammar at line 263
`string getTablePrefix()`

in Grammar at line 274
`$this setTablePrefix(string $prefix)`

in Grammar at line 287
`$this setConnection(Connection $connection)`

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

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

in CompilesJsonPaths at line 50
`protected string wrapJsonPathSegment(string $segment)`

at line 48
`void compileCreateDatabase(string $name, Connection $connection)`

at line 63
`void compileDropDatabaseIfExists(string $name)`

at line 294
`array|string compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)`

at line 315
`array|string compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)`

at line 412
`string compileFulltext(Blueprint $blueprint, Fluent $command)`

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

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

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

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

in Grammar at line 206
`protected void typeComputed(Fluent $column)`

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

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

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

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

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

in Grammar at line 329
`TableDiff getDoctrineTableDiff(Blueprint $blueprint, AbstractSchemaManager $schema)`

in Grammar at line 343
`array getFluentCommands()`

in Grammar at line 353
`bool supportsSchemaTransactions()`

at line 76
`string compileTableExists()`

at line 86
`string compileTables()`

at line 99
`string compileViews()`