Файл: vendor/laravel/framework/src/Illuminate/Database/Schema/Grammars/MySqlGrammar.php
Строк: 2220
<?php
namespace IlluminateDatabaseSchemaGrammars;
use IlluminateDatabaseConnection;
use IlluminateDatabaseQueryExpression;
use IlluminateDatabaseSchemaBlueprint;
use IlluminateSupportFluent;
use RuntimeException;
class MySqlGrammar extends Grammar
{
/**
* The possible column modifiers.
*
* @var string[]
*/
protected $modifiers = [
'Unsigned', 'Charset', 'Collate', 'VirtualAs', 'StoredAs', 'Nullable',
'Srid', 'Default', 'OnUpdate', 'Invisible', 'Increment', 'Comment', 'After', 'First',
];
/**
* The possible column serials.
*
* @var string[]
*/
protected $serials = ['bigInteger', 'integer', 'mediumInteger', 'smallInteger', 'tinyInteger'];
/**
* The commands to be executed outside of create or alter command.
*
* @var string[]
*/
protected $fluentCommands = ['AutoIncrementStartingValues'];
/**
* Compile a create database command.
*
* @param string $name
* @param IlluminateDatabaseConnection $connection
* @return string
*/
public function compileCreateDatabase($name, $connection)
{
$charset = $connection->getConfig('charset');
$collation = $connection->getConfig('collation');
if (! $charset || ! $collation) {
return sprintf(
'create database %s',
$this->wrapValue($name),
);
}
return sprintf(
'create database %s default character set %s default collate %s',
$this->wrapValue($name),
$this->wrapValue($charset),
$this->wrapValue($collation),
);
}
/**
* Compile a drop database if exists command.
*
* @param string $name
* @return string
*/
public function compileDropDatabaseIfExists($name)
{
return sprintf(
'drop database if exists %s',
$this->wrapValue($name)
);
}
/**
* Compile the query to determine the list of tables.
*
* @deprecated Will be removed in a future Laravel version.
*
* @return string
*/
public function compileTableExists()
{
return "select * from information_schema.tables where table_schema = ? and table_name = ? and table_type = 'BASE TABLE'";
}
/**
* Compile the query to determine the tables.
*
* @param string $database
* @return string
*/
public function compileTables($database)
{
return sprintf(
'select table_name as `name`, (data_length + index_length) as `size`, '
.'table_comment as `comment`, engine as `engine`, table_collation as `collation` '
."from information_schema.tables where table_schema = %s and table_type in ('BASE TABLE', 'SYSTEM VERSIONED') "
.'order by table_name',
$this->quoteString($database)
);
}
/**
* Compile the query to determine the views.
*
* @param string $database
* @return string
*/
public function compileViews($database)
{
return sprintf(
'select table_name as `name`, view_definition as `definition` '
.'from information_schema.views where table_schema = %s '
.'order by table_name',
$this->quoteString($database)
);
}
/**
* Compile the SQL needed to retrieve all table names.
*
* @deprecated Will be removed in a future Laravel version.
*
* @return string
*/
public function compileGetAllTables()
{
return 'SHOW FULL TABLES WHERE table_type = 'BASE TABLE'';
}
/**
* Compile the SQL needed to retrieve all view names.
*
* @deprecated Will be removed in a future Laravel version.
*
* @return string
*/
public function compileGetAllViews()
{
return 'SHOW FULL TABLES WHERE table_type = 'VIEW'';
}
/**
* Compile the query to determine the list of columns.
*
* @deprecated Will be removed in a future Laravel version.
*
* @return string
*/
public function compileColumnListing()
{
return 'select column_name as `column_name` from information_schema.columns where table_schema = ? and table_name = ?';
}
/**
* Compile the query to determine the columns.
*
* @param string $database
* @param string $table
* @return string
*/
public function compileColumns($database, $table)
{
return sprintf(
'select column_name as `name`, data_type as `type_name`, column_type as `type`, '
.'collation_name as `collation`, is_nullable as `nullable`, '
.'column_default as `default`, column_comment as `comment`, extra as `extra` '
.'from information_schema.columns where table_schema = %s and table_name = %s '
.'order by ordinal_position asc',
$this->quoteString($database),
$this->quoteString($table)
);
}
/**
* Compile the query to determine the indexes.
*
* @param string $database
* @param string $table
* @return string
*/
public function compileIndexes($database, $table)
{
return sprintf(
'select index_name as `name`, group_concat(column_name order by seq_in_index) as `columns`, '
.'index_type as `type`, not non_unique as `unique` '
.'from information_schema.statistics where table_schema = %s and table_name = %s '
.'group by index_name, index_type, non_unique',
$this->quoteString($database),
$this->quoteString($table)
);
}
/**
* Compile the query to determine the foreign keys.
*
* @param string $database
* @param string $table
* @return string
*/
public function compileForeignKeys($database, $table)
{
return sprintf(
'select kc.constraint_name as `name`, '
.'group_concat(kc.column_name order by kc.ordinal_position) as `columns`, '
.'kc.referenced_table_schema as `foreign_schema`, '
.'kc.referenced_table_name as `foreign_table`, '
.'group_concat(kc.referenced_column_name order by kc.ordinal_position) as `foreign_columns`, '
.'rc.update_rule as `on_update`, '
.'rc.delete_rule as `on_delete` '
.'from information_schema.key_column_usage kc join information_schema.referential_constraints rc '
.'on kc.constraint_schema = rc.constraint_schema and kc.constraint_name = rc.constraint_name '
.'where kc.table_schema = %s and kc.table_name = %s and kc.referenced_table_name is not null '
.'group by kc.constraint_name, kc.referenced_table_schema, kc.referenced_table_name, rc.update_rule, rc.delete_rule',
$this->quoteString($database),
$this->quoteString($table)
);
}
/**
* Compile a create table command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @param IlluminateDatabaseConnection $connection
* @return string
*/
public function compileCreate(Blueprint $blueprint, Fluent $command, Connection $connection)
{
$sql = $this->compileCreateTable(
$blueprint, $command, $connection
);
// Once we have the primary SQL, we can add the encoding option to the SQL for
// the table. Then, we can check if a storage engine has been supplied for
// the table. If so, we will add the engine declaration to the SQL query.
$sql = $this->compileCreateEncoding(
$sql, $connection, $blueprint
);
// Finally, we will append the engine configuration onto this SQL statement as
// the final thing we do before returning this finished SQL. Once this gets
// added the query will be ready to execute against the real connections.
return $this->compileCreateEngine($sql, $connection, $blueprint);
}
/**
* Create the main create table clause.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @param IlluminateDatabaseConnection $connection
* @return string
*/
protected function compileCreateTable($blueprint, $command, $connection)
{
$tableStructure = $this->getColumns($blueprint);
if ($primaryKey = $this->getCommandByName($blueprint, 'primary')) {
$tableStructure[] = sprintf(
'primary key %s(%s)',
$primaryKey->algorithm ? 'using '.$primaryKey->algorithm : '',
$this->columnize($primaryKey->columns)
);
$primaryKey->shouldBeSkipped = true;
}
return sprintf('%s table %s (%s)',
$blueprint->temporary ? 'create temporary' : 'create',
$this->wrapTable($blueprint),
implode(', ', $tableStructure)
);
}
/**
* Append the character set specifications to a command.
*
* @param string $sql
* @param IlluminateDatabaseConnection $connection
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @return string
*/
protected function compileCreateEncoding($sql, Connection $connection, Blueprint $blueprint)
{
// First we will set the character set if one has been set on either the create
// blueprint itself or on the root configuration for the connection that the
// table is being created on. We will add these to the create table query.
if (isset($blueprint->charset)) {
$sql .= ' default character set '.$blueprint->charset;
} elseif (! is_null($charset = $connection->getConfig('charset'))) {
$sql .= ' default character set '.$charset;
}
// Next we will add the collation to the create table statement if one has been
// added to either this create table blueprint or the configuration for this
// connection that the query is targeting. We'll add it to this SQL query.
if (isset($blueprint->collation)) {
$sql .= " collate '{$blueprint->collation}'";
} elseif (! is_null($collation = $connection->getConfig('collation'))) {
$sql .= " collate '{$collation}'";
}
return $sql;
}
/**
* Append the engine specifications to a command.
*
* @param string $sql
* @param IlluminateDatabaseConnection $connection
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @return string
*/
protected function compileCreateEngine($sql, Connection $connection, Blueprint $blueprint)
{
if (isset($blueprint->engine)) {
return $sql.' engine = '.$blueprint->engine;
} elseif (! is_null($engine = $connection->getConfig('engine'))) {
return $sql.' engine = '.$engine;
}
return $sql;
}
/**
* Compile an add column command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileAdd(Blueprint $blueprint, Fluent $command)
{
$columns = $this->prefixArray('add', $this->getColumns($blueprint));
return 'alter table '.$this->wrapTable($blueprint).' '.implode(', ', $columns);
}
/**
* Compile the auto-incrementing column starting values.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileAutoIncrementStartingValues(Blueprint $blueprint, Fluent $command)
{
if ($command->column->autoIncrement
&& $value = $command->column->get('startingValue', $command->column->get('from'))) {
return 'alter table '.$this->wrapTable($blueprint).' auto_increment = '.$value;
}
}
/**
* Compile a rename column command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @param IlluminateDatabaseConnection $connection
* @return array|string
*/
public function compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)
{
return $connection->usingNativeSchemaOperations()
? sprintf('alter table %s rename column %s to %s',
$this->wrapTable($blueprint),
$this->wrap($command->from),
$this->wrap($command->to)
)
: parent::compileRenameColumn($blueprint, $command, $connection);
}
/**
* Compile a change column command into a series of SQL statements.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @param IlluminateDatabaseConnection $connection
* @return array|string
*
* @throws RuntimeException
*/
public function compileChange(Blueprint $blueprint, Fluent $command, Connection $connection)
{
if (! $connection->usingNativeSchemaOperations()) {
return parent::compileChange($blueprint, $command, $connection);
}
$columns = [];
foreach ($blueprint->getChangedColumns() as $column) {
$sql = sprintf('%s %s%s %s',
is_null($column->renameTo) ? 'modify' : 'change',
$this->wrap($column),
is_null($column->renameTo) ? '' : ' '.$this->wrap($column->renameTo),
$this->getType($column)
);
$columns[] = $this->addModifiers($sql, $blueprint, $column);
}
return 'alter table '.$this->wrapTable($blueprint).' '.implode(', ', $columns);
}
/**
* Compile a primary key command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compilePrimary(Blueprint $blueprint, Fluent $command)
{
return sprintf('alter table %s add primary key %s(%s)',
$this->wrapTable($blueprint),
$command->algorithm ? 'using '.$command->algorithm : '',
$this->columnize($command->columns)
);
}
/**
* Compile a unique key command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileUnique(Blueprint $blueprint, Fluent $command)
{
return $this->compileKey($blueprint, $command, 'unique');
}
/**
* Compile a plain index key command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileIndex(Blueprint $blueprint, Fluent $command)
{
return $this->compileKey($blueprint, $command, 'index');
}
/**
* Compile a fulltext index key command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileFullText(Blueprint $blueprint, Fluent $command)
{
return $this->compileKey($blueprint, $command, 'fulltext');
}
/**
* Compile a spatial index key command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileSpatialIndex(Blueprint $blueprint, Fluent $command)
{
return $this->compileKey($blueprint, $command, 'spatial index');
}
/**
* Compile an index creation command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @param string $type
* @return string
*/
protected function compileKey(Blueprint $blueprint, Fluent $command, $type)
{
return sprintf('alter table %s add %s %s%s(%s)',
$this->wrapTable($blueprint),
$type,
$this->wrap($command->index),
$command->algorithm ? ' using '.$command->algorithm : '',
$this->columnize($command->columns)
);
}
/**
* Compile a drop table command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileDrop(Blueprint $blueprint, Fluent $command)
{
return 'drop table '.$this->wrapTable($blueprint);
}
/**
* Compile a drop table (if exists) command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileDropIfExists(Blueprint $blueprint, Fluent $command)
{
return 'drop table if exists '.$this->wrapTable($blueprint);
}
/**
* Compile a drop column command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileDropColumn(Blueprint $blueprint, Fluent $command)
{
$columns = $this->prefixArray('drop', $this->wrapArray($command->columns));
return 'alter table '.$this->wrapTable($blueprint).' '.implode(', ', $columns);
}
/**
* Compile a drop primary key command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileDropPrimary(Blueprint $blueprint, Fluent $command)
{
return 'alter table '.$this->wrapTable($blueprint).' drop primary key';
}
/**
* Compile a drop unique key command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileDropUnique(Blueprint $blueprint, Fluent $command)
{
$index = $this->wrap($command->index);
return "alter table {$this->wrapTable($blueprint)} drop index {$index}";
}
/**
* Compile a drop index command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileDropIndex(Blueprint $blueprint, Fluent $command)
{
$index = $this->wrap($command->index);
return "alter table {$this->wrapTable($blueprint)} drop index {$index}";
}
/**
* Compile a drop fulltext index command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileDropFullText(Blueprint $blueprint, Fluent $command)
{
return $this->compileDropIndex($blueprint, $command);
}
/**
* Compile a drop spatial index command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileDropSpatialIndex(Blueprint $blueprint, Fluent $command)
{
return $this->compileDropIndex($blueprint, $command);
}
/**
* Compile a drop foreign key command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileDropForeign(Blueprint $blueprint, Fluent $command)
{
$index = $this->wrap($command->index);
return "alter table {$this->wrapTable($blueprint)} drop foreign key {$index}";
}
/**
* Compile a rename table command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileRename(Blueprint $blueprint, Fluent $command)
{
$from = $this->wrapTable($blueprint);
return "rename table {$from} to ".$this->wrapTable($command->to);
}
/**
* Compile a rename index command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileRenameIndex(Blueprint $blueprint, Fluent $command)
{
return sprintf('alter table %s rename index %s to %s',
$this->wrapTable($blueprint),
$this->wrap($command->from),
$this->wrap($command->to)
);
}
/**
* Compile the SQL needed to drop all tables.
*
* @param array $tables
* @return string
*/
public function compileDropAllTables($tables)
{
return 'drop table '.implode(',', $this->wrapArray($tables));
}
/**
* Compile the SQL needed to drop all views.
*
* @param array $views
* @return string
*/
public function compileDropAllViews($views)
{
return 'drop view '.implode(',', $this->wrapArray($views));
}
/**
* Compile the command to enable foreign key constraints.
*
* @return string
*/
public function compileEnableForeignKeyConstraints()
{
return 'SET FOREIGN_KEY_CHECKS=1;';
}
/**
* Compile the command to disable foreign key constraints.
*
* @return string
*/
public function compileDisableForeignKeyConstraints()
{
return 'SET FOREIGN_KEY_CHECKS=0;';
}
/**
* Compile a table comment command.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $command
* @return string
*/
public function compileTableComment(Blueprint $blueprint, Fluent $command)
{
return sprintf('alter table %s comment = %s',
$this->wrapTable($blueprint),
"'".str_replace("'", "''", $command->comment)."'"
);
}
/**
* Create the column definition for a char type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeChar(Fluent $column)
{
return "char({$column->length})";
}
/**
* Create the column definition for a string type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeString(Fluent $column)
{
return "varchar({$column->length})";
}
/**
* Create the column definition for a tiny text type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeTinyText(Fluent $column)
{
return 'tinytext';
}
/**
* Create the column definition for a text type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeText(Fluent $column)
{
return 'text';
}
/**
* Create the column definition for a medium text type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeMediumText(Fluent $column)
{
return 'mediumtext';
}
/**
* Create the column definition for a long text type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeLongText(Fluent $column)
{
return 'longtext';
}
/**
* Create the column definition for a big integer type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeBigInteger(Fluent $column)
{
return 'bigint';
}
/**
* Create the column definition for an integer type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeInteger(Fluent $column)
{
return 'int';
}
/**
* Create the column definition for a medium integer type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeMediumInteger(Fluent $column)
{
return 'mediumint';
}
/**
* Create the column definition for a tiny integer type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeTinyInteger(Fluent $column)
{
return 'tinyint';
}
/**
* Create the column definition for a small integer type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeSmallInteger(Fluent $column)
{
return 'smallint';
}
/**
* Create the column definition for a float type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeFloat(Fluent $column)
{
return $this->typeDouble($column);
}
/**
* Create the column definition for a double type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeDouble(Fluent $column)
{
if ($column->total && $column->places) {
return "double({$column->total}, {$column->places})";
}
return 'double';
}
/**
* Create the column definition for a decimal type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeDecimal(Fluent $column)
{
return "decimal({$column->total}, {$column->places})";
}
/**
* Create the column definition for a boolean type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeBoolean(Fluent $column)
{
return 'tinyint(1)';
}
/**
* Create the column definition for an enumeration type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeEnum(Fluent $column)
{
return sprintf('enum(%s)', $this->quoteString($column->allowed));
}
/**
* Create the column definition for a set enumeration type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeSet(Fluent $column)
{
return sprintf('set(%s)', $this->quoteString($column->allowed));
}
/**
* Create the column definition for a json type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeJson(Fluent $column)
{
return 'json';
}
/**
* Create the column definition for a jsonb type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeJsonb(Fluent $column)
{
return 'json';
}
/**
* Create the column definition for a date type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeDate(Fluent $column)
{
return 'date';
}
/**
* Create the column definition for a date-time type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeDateTime(Fluent $column)
{
$current = $column->precision ? "CURRENT_TIMESTAMP($column->precision)" : 'CURRENT_TIMESTAMP';
if ($column->useCurrent) {
$column->default(new Expression($current));
}
if ($column->useCurrentOnUpdate) {
$column->onUpdate(new Expression($current));
}
return $column->precision ? "datetime($column->precision)" : 'datetime';
}
/**
* Create the column definition for a date-time (with time zone) type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeDateTimeTz(Fluent $column)
{
return $this->typeDateTime($column);
}
/**
* Create the column definition for a time type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeTime(Fluent $column)
{
return $column->precision ? "time($column->precision)" : 'time';
}
/**
* Create the column definition for a time (with time zone) type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeTimeTz(Fluent $column)
{
return $this->typeTime($column);
}
/**
* Create the column definition for a timestamp type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeTimestamp(Fluent $column)
{
$current = $column->precision ? "CURRENT_TIMESTAMP($column->precision)" : 'CURRENT_TIMESTAMP';
if ($column->useCurrent) {
$column->default(new Expression($current));
}
if ($column->useCurrentOnUpdate) {
$column->onUpdate(new Expression($current));
}
return $column->precision ? "timestamp($column->precision)" : 'timestamp';
}
/**
* Create the column definition for a timestamp (with time zone) type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeTimestampTz(Fluent $column)
{
return $this->typeTimestamp($column);
}
/**
* Create the column definition for a year type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeYear(Fluent $column)
{
return 'year';
}
/**
* Create the column definition for a binary type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeBinary(Fluent $column)
{
return 'blob';
}
/**
* Create the column definition for a uuid type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeUuid(Fluent $column)
{
return 'char(36)';
}
/**
* Create the column definition for an IP address type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeIpAddress(Fluent $column)
{
return 'varchar(45)';
}
/**
* Create the column definition for a MAC address type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
protected function typeMacAddress(Fluent $column)
{
return 'varchar(17)';
}
/**
* Create the column definition for a spatial Geometry type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
public function typeGeometry(Fluent $column)
{
return 'geometry';
}
/**
* Create the column definition for a spatial Point type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
public function typePoint(Fluent $column)
{
return 'point';
}
/**
* Create the column definition for a spatial LineString type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
public function typeLineString(Fluent $column)
{
return 'linestring';
}
/**
* Create the column definition for a spatial Polygon type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
public function typePolygon(Fluent $column)
{
return 'polygon';
}
/**
* Create the column definition for a spatial GeometryCollection type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
public function typeGeometryCollection(Fluent $column)
{
return 'geometrycollection';
}
/**
* Create the column definition for a spatial MultiPoint type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
public function typeMultiPoint(Fluent $column)
{
return 'multipoint';
}
/**
* Create the column definition for a spatial MultiLineString type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
public function typeMultiLineString(Fluent $column)
{
return 'multilinestring';
}
/**
* Create the column definition for a spatial MultiPolygon type.
*
* @param IlluminateSupportFluent $column
* @return string
*/
public function typeMultiPolygon(Fluent $column)
{
return 'multipolygon';
}
/**
* Create the column definition for a generated, computed column type.
*
* @param IlluminateSupportFluent $column
* @return void
*
* @throws RuntimeException
*/
protected function typeComputed(Fluent $column)
{
throw new RuntimeException('This database driver requires a type, see the virtualAs / storedAs modifiers.');
}
/**
* Get the SQL for a generated virtual column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyVirtualAs(Blueprint $blueprint, Fluent $column)
{
if (! is_null($virtualAs = $column->virtualAsJson)) {
if ($this->isJsonSelector($virtualAs)) {
$virtualAs = $this->wrapJsonSelector($virtualAs);
}
return " as ({$virtualAs})";
}
if (! is_null($virtualAs = $column->virtualAs)) {
return " as ({$this->getValue($virtualAs)})";
}
}
/**
* Get the SQL for a generated stored column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyStoredAs(Blueprint $blueprint, Fluent $column)
{
if (! is_null($storedAs = $column->storedAsJson)) {
if ($this->isJsonSelector($storedAs)) {
$storedAs = $this->wrapJsonSelector($storedAs);
}
return " as ({$storedAs}) stored";
}
if (! is_null($storedAs = $column->storedAs)) {
return " as ({$this->getValue($storedAs)}) stored";
}
}
/**
* Get the SQL for an unsigned column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyUnsigned(Blueprint $blueprint, Fluent $column)
{
if ($column->unsigned) {
return ' unsigned';
}
}
/**
* Get the SQL for a character set column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyCharset(Blueprint $blueprint, Fluent $column)
{
if (! is_null($column->charset)) {
return ' character set '.$column->charset;
}
}
/**
* Get the SQL for a collation column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyCollate(Blueprint $blueprint, Fluent $column)
{
if (! is_null($column->collation)) {
return " collate '{$column->collation}'";
}
}
/**
* Get the SQL for a nullable column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyNullable(Blueprint $blueprint, Fluent $column)
{
if (is_null($column->virtualAs) &&
is_null($column->virtualAsJson) &&
is_null($column->storedAs) &&
is_null($column->storedAsJson)) {
return $column->nullable ? ' null' : ' not null';
}
if ($column->nullable === false) {
return ' not null';
}
}
/**
* Get the SQL for an invisible column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyInvisible(Blueprint $blueprint, Fluent $column)
{
if (! is_null($column->invisible)) {
return ' invisible';
}
}
/**
* Get the SQL for a default column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyDefault(Blueprint $blueprint, Fluent $column)
{
if (! is_null($column->default)) {
return ' default '.$this->getDefaultValue($column->default);
}
}
/**
* Get the SQL for an "on update" column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyOnUpdate(Blueprint $blueprint, Fluent $column)
{
if (! is_null($column->onUpdate)) {
return ' on update '.$this->getValue($column->onUpdate);
}
}
/**
* Get the SQL for an auto-increment column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyIncrement(Blueprint $blueprint, Fluent $column)
{
if (in_array($column->type, $this->serials) && $column->autoIncrement) {
return ' auto_increment primary key';
}
}
/**
* Get the SQL for a "first" column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyFirst(Blueprint $blueprint, Fluent $column)
{
if (! is_null($column->first)) {
return ' first';
}
}
/**
* Get the SQL for an "after" column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyAfter(Blueprint $blueprint, Fluent $column)
{
if (! is_null($column->after)) {
return ' after '.$this->wrap($column->after);
}
}
/**
* Get the SQL for a "comment" column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifyComment(Blueprint $blueprint, Fluent $column)
{
if (! is_null($column->comment)) {
return " comment '".addslashes($column->comment)."'";
}
}
/**
* Get the SQL for a SRID column modifier.
*
* @param IlluminateDatabaseSchemaBlueprint $blueprint
* @param IlluminateSupportFluent $column
* @return string|null
*/
protected function modifySrid(Blueprint $blueprint, Fluent $column)
{
if (is_int($column->srid) && $column->srid > 0) {
return ' srid '.$column->srid;
}
}
/**
* Wrap a single string in keyword identifiers.
*
* @param string $value
* @return string
*/
protected function wrapValue($value)
{
if ($value !== '*') {
return '`'.str_replace('`', '``', $value).'`';
}
return $value;
}
/**
* Wrap the given JSON selector.
*
* @param string $value
* @return string
*/
protected function wrapJsonSelector($value)
{
[$field, $path] = $this->wrapJsonFieldAndPath($value);
return 'json_unquote(json_extract('.$field.$path.'))';
}
}