Illuminate\Database\Schema\Grammars\SQLiteGrammar

class SQLiteGrammar 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.	from Grammar
protected array	$fluentCommands	The commands to be executed outside of create or alter command.	from Grammar
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)

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)

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.

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.

from Grammar

void

compileDropDatabaseIfExists(string $name)

Compile a drop database if exists command.

from Grammar

array|string

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

Compile a rename column command.

from Grammar

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.

from Grammar

string

compileDropFullText(Blueprint $blueprint, Fluent $command)

Compile a drop fulltext index command.

from Grammar

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.

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.

from Grammar

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

array

getAlterCommands(Connection $connection)

Get the commands to be compiled on the alter command.

string

compileSqlCreateStatement(string $name, string $type = 'table')

Compile the query to determine the SQL text that describes the given object.

string

compileDbstatExists()

Compile the query to determine if the dbstat table is available.

string

compileTableExists(string $table)

Compile the query to determine if the given table exists.

string

compileTables(bool $withSize = false)

Compile the query to determine the tables.

string

compileViews()

Compile the query to determine the views.

string

compileColumns(string $table)

Compile the query to determine the columns.

string

compileIndexes(string $table)

Compile the query to determine the indexes.

string

compileForeignKeys(string $table)

Compile the query to determine the foreign keys.

string

compileCreate(Blueprint $blueprint, Fluent $command)

Compile a create table command.

string|null

addForeignKeys(ForeignKeyDefinition[] $foreignKeys)

Get the foreign key syntax for a table creation statement.

string

getForeignKey(Fluent $foreign)

Get the SQL for the foreign key.

string|null

addPrimaryKeys(Fluent|null $primary)

Get the primary key syntax for a table creation statement.

string

compileAdd(Blueprint $blueprint, Fluent $command)

Compile alter table commands for adding columns.

array|string

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

Compile alter table command into a series of SQL statements.

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.

void

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()

Compile the SQL needed to drop all tables.

string

compileDropAllViews()

Compile the SQL needed to drop all views.

string

compileRebuild()

Compile the SQL needed to rebuild the database.

array|null

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

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.

void

compileDropSpatialIndex(Blueprint $blueprint, Fluent $command)

Compile a drop spatial index command.

string

compileRename(Blueprint $blueprint, Fluent $command)

Compile a rename table command.

array

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

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

compileSetBusyTimeout(int $milliseconds)

Compile the command to set the busy timeout.

string

compileSetJournalMode(string $mode)

Compile the command to set the journal mode.

string

compileSetSynchronous(string $mode)

Compile the command to set the synchronous mode.

string

compileEnableWriteableSchema()

Compile the SQL needed to enable a writable schema.

string

compileDisableWriteableSchema()

Compile the SQL needed to disable a writable schema.

string

pragma(string $name, mixed $value)

Get the SQL to set a PRAGMA value.

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

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

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

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

modifyCollate(Blueprint $blueprint, Fluent $column)

Get the SQL for a collation column modifier.

Details

in Macroable at line 29
`static void macro(string $name, object|callable $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 33
`array wrapArray(array $values)`

Wrap an array of values.

Parameters

array

$values

Return Value

array

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

Wrap a table in keyword identifiers.

Parameters

Expression|string

$table

Return Value

string

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

Wrap a value in keyword identifiers.

Parameters

Expression|string

$value

Return Value

string

in Grammar at line 106
`protected string wrapAliasedValue(string $value)`

Wrap a value that has an alias.

Parameters

string

$value

Return Value

string

in Grammar at line 119
`protected string wrapAliasedTable(string $value)`

Wrap a table that has an alias.

Parameters

string

$value

Return Value

string

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

Wrap the given value segments.

Parameters

array

$segments

Return Value

string

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

Wrap a single string in keyword identifiers.

Parameters

string

$value

Return Value

string

at line 1176
`protected string wrapJsonSelector(string $value)`

Wrap the given JSON selector.

Parameters

string

$value

Return Value

string

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

Determine if the given string is a JSON selector.

Parameters

string

$value

Return Value

bool

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

Convert an array of column names into a delimited string.

Parameters

array

$columns

Return Value

string

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

Create query parameter place-holders for an array.

Parameters

array

$values

Return Value

string

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

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

Parameters

mixed

$value

Return Value

string

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

Quote the given string literal.

Parameters

string|array

$value

Return Value

string

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

Determine if the given value is a raw expression.

Parameters

mixed

$value

Return Value

bool

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

Get the format for database stored dates.

Return Value

string

in Grammar at line 285
`string getTablePrefix()`

Get the grammar's table prefix.

Return Value

string

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

Set the grammar's table prefix.

Parameters

string

$prefix

Return Value

$this

in Grammar at line 309
`$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

in Grammar at line 49
`void compileCreateDatabase(string $name, Connection $connection)`

Compile a create database command.

Parameters

string	$name
Connection	$connection

Return Value

void

Exceptions

LogicException

in Grammar at line 62
`void compileDropDatabaseIfExists(string $name)`

Compile a drop database if exists command.

Parameters

string

$name

Return Value

void

Exceptions

LogicException

in Grammar at line 75
`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 324
`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

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

Compile a fulltext index key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

Exceptions

RuntimeException

in Grammar at line 122
`string compileDropFullText(Blueprint $blueprint, Fluent $command)`

Compile a drop fulltext index command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

Exceptions

RuntimeException

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

Compile a foreign key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop foreign key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile the blueprint's added column definitions.

Parameters

Blueprint

$blueprint

Return Value

array

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

Compile the column definition.

Parameters

Blueprint	$blueprint
ColumnDefinition	$column

Return Value

string

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

Get the SQL for the column data type.

Parameters

Fluent

$column

Return Value

string

at line 1058
`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 245
`protected string typeVector(Fluent $column)`

Create the column definition for a vector type.

Parameters

Fluent

$column

Return Value

string

Exceptions

RuntimeException

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

Create the column definition for a raw column type.

Parameters

Fluent

$column

Return Value

string

in Grammar at line 269
`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 287
`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 303
`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 317
`protected hasCommand(Blueprint $blueprint, $name)`

No description

Parameters

Blueprint	$blueprint
	$name

in Grammar at line 335
`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 374
`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 394
`array getFluentCommands()`

Get the fluent commands for the grammar.

Return Value

array

in Grammar at line 404
`bool supportsSchemaTransactions()`

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

Return Value

bool

at line 35
`array getAlterCommands(Connection $connection)`

Get the commands to be compiled on the alter command.

Parameters

Connection

$connection

Return Value

array

at line 53
`string compileSqlCreateStatement(string $name, string $type = 'table')`

Compile the query to determine the SQL text that describes the given object.

Parameters

string	$name
string	$type

Return Value

string

at line 66
`string compileDbstatExists()`

Compile the query to determine if the dbstat table is available.

Return Value

string

at line 77
`string compileTableExists(string $table)`

Compile the query to determine if the given table exists.

Parameters

string

$table

Return Value

string

at line 91
`string compileTables(bool $withSize = false)`

Compile the query to determine the tables.

Parameters

bool

$withSize

Return Value

string

at line 107
`string compileViews()`

Compile the query to determine the views.

Return Value

string

at line 118
`string compileColumns(string $table)`

Compile the query to determine the columns.

Parameters

string

$table

Return Value

string

at line 133
`string compileIndexes(string $table)`

Compile the query to determine the indexes.

Parameters

string

$table

Return Value

string

at line 152
`string compileForeignKeys(string $table)`

Compile the query to determine the foreign keys.

Parameters

string

$table

Return Value

string

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

Compile a create table command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

at line 187
`protected string|null addForeignKeys(ForeignKeyDefinition[] $foreignKeys)`

Get the foreign key syntax for a table creation statement.

Parameters

ForeignKeyDefinition[]

$foreignKeys

Return Value

string|null

at line 203
`protected string getForeignKey(Fluent $foreign)`

Get the SQL for the foreign key.

Parameters

Fluent

$foreign

Return Value

string

at line 234
`protected string|null addPrimaryKeys(Fluent|null $primary)`

Get the primary key syntax for a table creation statement.

Parameters

Fluent|null

$primary

Return Value

string|null

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

Compile alter table commands for adding columns.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile alter table command into a series of SQL statements.

Parameters

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Return Value

array|string

Exceptions

RuntimeException

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

Compile a primary key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a unique key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a plain index key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

at line 382
`void compileSpatialIndex(Blueprint $blueprint, Fluent $command)`

Compile a spatial index key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

void

Exceptions

RuntimeException

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

Compile a drop table command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop table (if exists) command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

at line 428
`string compileDropAllTables()`

Compile the SQL needed to drop all tables.

Return Value

string

at line 438
`string compileDropAllViews()`

Compile the SQL needed to drop all views.

Return Value

string

at line 448
`string compileRebuild()`

Compile the SQL needed to rebuild the database.

Return Value

string

at line 461
`array|null compileDropColumn(Blueprint $blueprint, Fluent $command, Connection $connection)`

Compile a drop column command.

Parameters

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Return Value

array|null

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

Compile a drop primary key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop unique key command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

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

Compile a drop index command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

at line 525
`void compileDropSpatialIndex(Blueprint $blueprint, Fluent $command)`

Compile a drop spatial index command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

void

Exceptions

RuntimeException

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

Compile a rename table command.

Parameters

Blueprint	$blueprint
Fluent	$command

Return Value

string

at line 570
`array compileRenameIndex(Blueprint $blueprint, Fluent $command, Connection $connection)`

Compile a rename index command.

Parameters

Blueprint	$blueprint
Fluent	$command
Connection	$connection

Return Value

array

Exceptions

RuntimeException

at line 606
`string compileEnableForeignKeyConstraints()`

Compile the command to enable foreign key constraints.

Return Value

string

at line 616
`string compileDisableForeignKeyConstraints()`

Compile the command to disable foreign key constraints.

Return Value

string

at line 627
`string compileSetBusyTimeout(int $milliseconds)`

Compile the command to set the busy timeout.

Parameters

int

$milliseconds

Return Value

string

at line 638
`string compileSetJournalMode(string $mode)`

Compile the command to set the journal mode.

Parameters

string

$mode

Return Value

string

at line 649
`string compileSetSynchronous(string $mode)`

Compile the command to set the synchronous mode.

Parameters

string

$mode

Return Value

string

at line 659
`string compileEnableWriteableSchema()`

Compile the SQL needed to enable a writable schema.

Return Value

string

at line 669
`string compileDisableWriteableSchema()`

Compile the SQL needed to disable a writable schema.

Return Value

string

at line 681
`protected string pragma(string $name, mixed $value)`

Get the SQL to set a PRAGMA value.

Parameters

string	$name
mixed	$value

Return Value

string

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

Create the column definition for a char type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a string type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a tiny text type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a text type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a medium text type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a long text type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for an integer type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a big integer type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a medium integer type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a tiny integer type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a small integer type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a float type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a double type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a decimal type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a boolean type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for an enumeration type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a json type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a jsonb type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a date type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a date-time type.

Parameters

Fluent

$column

Return Value

string

at line 920
`protected string typeDateTimeTz(Fluent $column)`

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

Note: "SQLite does not have a storage class set aside for storing dates and/or times."

Parameters

Fluent

$column

Return Value

string

at line 931
`protected string typeTime(Fluent $column)`

Create the column definition for a time type.

Parameters

Fluent

$column

Return Value

string

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

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

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a timestamp type.

Parameters

Fluent

$column

Return Value

string

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

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

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a year type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a binary type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a uuid type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for an IP address type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a MAC address type.

Parameters

Fluent

$column

Return Value

string

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

Create the column definition for a spatial Geometry type.

Parameters

Fluent

$column

Return Value

string

at line 1045
`protected string typeGeography(Fluent $column)`

Create the column definition for a spatial Geography type.

Parameters

Fluent

$column

Return Value

string

at line 1070
`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 1092
`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 1114
`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 1135
`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 1149
`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 1163
`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

SQLiteGrammar

Traits

Properties

Methods

Details

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

Parameters

Return Value

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

Parameters

Return Value

Exceptions

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

Parameters

Return Value

in Macroable at line 72 static void flushMacros()

Return Value

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

Parameters

Return Value

Exceptions

in Macroable at line 112 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 348 string wrapTable(Expression|string $table)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in Grammar at line 119 protected string wrapAliasedTable(string $value)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

at line 1176 protected string wrapJsonSelector(string $value)

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

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

Parameters

Return Value

in Grammar at line 275 string getDateFormat()

Return Value

in Grammar at line 285 string getTablePrefix()

Return Value

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

Parameters

Return Value

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

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

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

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

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

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

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

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

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

in Grammar at line 106
`protected string wrapAliasedValue(string $value)`

in Grammar at line 119
`protected string wrapAliasedTable(string $value)`

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

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

at line 1176
`protected string wrapJsonSelector(string $value)`

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

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

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

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

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

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

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

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

in Grammar at line 275
`string getDateFormat()`

in Grammar at line 285
`string getTablePrefix()`

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

in Grammar at line 309
`$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)`

in Grammar at line 49
`void compileCreateDatabase(string $name, Connection $connection)`

in Grammar at line 62
`void compileDropDatabaseIfExists(string $name)`

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

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

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

in Grammar at line 122
`string compileDropFullText(Blueprint $blueprint, Fluent $command)`

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

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

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

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

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

at line 1058
`protected void typeComputed(Fluent $column)`

in Grammar at line 245
`protected string typeVector(Fluent $column)`

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

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

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

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