| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766 |
- <?php
- namespace Illuminate\Database\Schema;
- use Closure;
- use Illuminate\Database\Connection;
- use Illuminate\Database\Eloquent\Concerns\HasUlids;
- use Illuminate\Database\Query\Expression;
- use Illuminate\Database\Schema\Grammars\Grammar;
- use Illuminate\Database\Schema\Grammars\MySqlGrammar;
- use Illuminate\Support\Fluent;
- use Illuminate\Support\Traits\Macroable;
- class Blueprint
- {
- use Macroable;
- /**
- * The table the blueprint describes.
- *
- * @var string
- */
- protected $table;
- /**
- * The prefix of the table.
- *
- * @var string
- */
- protected $prefix;
- /**
- * The columns that should be added to the table.
- *
- * @var \Illuminate\Database\Schema\ColumnDefinition[]
- */
- protected $columns = [];
- /**
- * The commands that should be run for the table.
- *
- * @var \Illuminate\Support\Fluent[]
- */
- protected $commands = [];
- /**
- * The storage engine that should be used for the table.
- *
- * @var string
- */
- public $engine;
- /**
- * The default character set that should be used for the table.
- *
- * @var string
- */
- public $charset;
- /**
- * The collation that should be used for the table.
- *
- * @var string
- */
- public $collation;
- /**
- * Whether to make the table temporary.
- *
- * @var bool
- */
- public $temporary = false;
- /**
- * The column to add new columns after.
- *
- * @var string
- */
- public $after;
- /**
- * Create a new schema blueprint.
- *
- * @param string $table
- * @param \Closure|null $callback
- * @param string $prefix
- * @return void
- */
- public function __construct($table, ?Closure $callback = null, $prefix = '')
- {
- $this->table = $table;
- $this->prefix = $prefix;
- if (! is_null($callback)) {
- $callback($this);
- }
- }
- /**
- * Execute the blueprint against the database.
- *
- * @param \Illuminate\Database\Connection $connection
- * @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
- * @return void
- */
- public function build(Connection $connection, Grammar $grammar)
- {
- foreach ($this->toSql($connection, $grammar) as $statement) {
- $connection->statement($statement);
- }
- }
- /**
- * Get the raw SQL statements for the blueprint.
- *
- * @param \Illuminate\Database\Connection $connection
- * @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
- * @return array
- */
- public function toSql(Connection $connection, Grammar $grammar)
- {
- $this->addImpliedCommands($connection, $grammar);
- $statements = [];
- // Each type of command has a corresponding compiler function on the schema
- // grammar which is used to build the necessary SQL statements to build
- // the blueprint element, so we'll just call that compilers function.
- $this->ensureCommandsAreValid($connection);
- foreach ($this->commands as $command) {
- if ($command->shouldBeSkipped) {
- continue;
- }
- $method = 'compile'.ucfirst($command->name);
- if (method_exists($grammar, $method) || $grammar::hasMacro($method)) {
- if (! is_null($sql = $grammar->$method($this, $command, $connection))) {
- $statements = array_merge($statements, (array) $sql);
- }
- }
- }
- return $statements;
- }
- /**
- * Ensure the commands on the blueprint are valid for the connection type.
- *
- * @param \Illuminate\Database\Connection $connection
- * @return void
- *
- * @throws \BadMethodCallException
- */
- protected function ensureCommandsAreValid(Connection $connection)
- {
- //
- }
- /**
- * Get all of the commands matching the given names.
- *
- * @param array $names
- * @return \Illuminate\Support\Collection
- */
- protected function commandsNamed(array $names)
- {
- return collect($this->commands)->filter(function ($command) use ($names) {
- return in_array($command->name, $names);
- });
- }
- /**
- * Add the commands that are implied by the blueprint's state.
- *
- * @param \Illuminate\Database\Connection $connection
- * @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
- * @return void
- */
- protected function addImpliedCommands(Connection $connection, Grammar $grammar)
- {
- if (count($this->getAddedColumns()) > 0 && ! $this->creating()) {
- array_unshift($this->commands, $this->createCommand('add'));
- }
- if (count($this->getChangedColumns()) > 0 && ! $this->creating()) {
- array_unshift($this->commands, $this->createCommand('change'));
- }
- $this->addFluentIndexes($connection, $grammar);
- $this->addFluentCommands($connection, $grammar);
- }
- /**
- * Add the index commands fluently specified on columns.
- *
- * @param \Illuminate\Database\Connection $connection
- * @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
- * @return void
- */
- protected function addFluentIndexes(Connection $connection, Grammar $grammar)
- {
- foreach ($this->columns as $column) {
- foreach (['primary', 'unique', 'index', 'fulltext', 'fullText', 'spatialIndex'] as $index) {
- // If the column is supposed to be changed to an auto increment column and
- // the specified index is primary, there is no need to add a command on
- // MySQL, as it will be handled during the column definition instead.
- if ($index === 'primary' && $column->autoIncrement && $column->change && $grammar instanceof MySqlGrammar) {
- continue 2;
- }
- // If the index has been specified on the given column, but is simply equal
- // to "true" (boolean), no name has been specified for this index so the
- // index method can be called without a name and it will generate one.
- if ($column->{$index} === true) {
- $this->{$index}($column->name);
- $column->{$index} = null;
- continue 2;
- }
- // If the index has been specified on the given column, but it equals false
- // and the column is supposed to be changed, we will call the drop index
- // method with an array of column to drop it by its conventional name.
- elseif ($column->{$index} === false && $column->change) {
- $this->{'drop'.ucfirst($index)}([$column->name]);
- $column->{$index} = null;
- continue 2;
- }
- // If the index has been specified on the given column, and it has a string
- // value, we'll go ahead and call the index method and pass the name for
- // the index since the developer specified the explicit name for this.
- elseif (isset($column->{$index})) {
- $this->{$index}($column->name, $column->{$index});
- $column->{$index} = null;
- continue 2;
- }
- }
- }
- }
- /**
- * Add the fluent commands specified on any columns.
- *
- * @param \Illuminate\Database\Connection $connection
- * @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
- * @return void
- */
- public function addFluentCommands(Connection $connection, Grammar $grammar)
- {
- foreach ($this->columns as $column) {
- foreach ($grammar->getFluentCommands() as $commandName) {
- $this->addCommand($commandName, compact('column'));
- }
- }
- }
- /**
- * Determine if the blueprint has a create command.
- *
- * @return bool
- */
- public function creating()
- {
- return collect($this->commands)->contains(function ($command) {
- return $command->name === 'create';
- });
- }
- /**
- * Indicate that the table needs to be created.
- *
- * @return \Illuminate\Support\Fluent
- */
- public function create()
- {
- return $this->addCommand('create');
- }
- /**
- * Specify the storage engine that should be used for the table.
- *
- * @param string $engine
- * @return void
- */
- public function engine($engine)
- {
- $this->engine = $engine;
- }
- /**
- * Specify that the InnoDB storage engine should be used for the table (MySQL only).
- *
- * @return void
- */
- public function innoDb()
- {
- $this->engine('InnoDB');
- }
- /**
- * Specify the character set that should be used for the table.
- *
- * @param string $charset
- * @return void
- */
- public function charset($charset)
- {
- $this->charset = $charset;
- }
- /**
- * Specify the collation that should be used for the table.
- *
- * @param string $collation
- * @return void
- */
- public function collation($collation)
- {
- $this->collation = $collation;
- }
- /**
- * Indicate that the table needs to be temporary.
- *
- * @return void
- */
- public function temporary()
- {
- $this->temporary = true;
- }
- /**
- * Indicate that the table should be dropped.
- *
- * @return \Illuminate\Support\Fluent
- */
- public function drop()
- {
- return $this->addCommand('drop');
- }
- /**
- * Indicate that the table should be dropped if it exists.
- *
- * @return \Illuminate\Support\Fluent
- */
- public function dropIfExists()
- {
- return $this->addCommand('dropIfExists');
- }
- /**
- * Indicate that the given columns should be dropped.
- *
- * @param array|mixed $columns
- * @return \Illuminate\Support\Fluent
- */
- public function dropColumn($columns)
- {
- $columns = is_array($columns) ? $columns : func_get_args();
- return $this->addCommand('dropColumn', compact('columns'));
- }
- /**
- * Indicate that the given columns should be renamed.
- *
- * @param string $from
- * @param string $to
- * @return \Illuminate\Support\Fluent
- */
- public function renameColumn($from, $to)
- {
- return $this->addCommand('renameColumn', compact('from', 'to'));
- }
- /**
- * Indicate that the given primary key should be dropped.
- *
- * @param string|array|null $index
- * @return \Illuminate\Support\Fluent
- */
- public function dropPrimary($index = null)
- {
- return $this->dropIndexCommand('dropPrimary', 'primary', $index);
- }
- /**
- * Indicate that the given unique key should be dropped.
- *
- * @param string|array $index
- * @return \Illuminate\Support\Fluent
- */
- public function dropUnique($index)
- {
- return $this->dropIndexCommand('dropUnique', 'unique', $index);
- }
- /**
- * Indicate that the given index should be dropped.
- *
- * @param string|array $index
- * @return \Illuminate\Support\Fluent
- */
- public function dropIndex($index)
- {
- return $this->dropIndexCommand('dropIndex', 'index', $index);
- }
- /**
- * Indicate that the given fulltext index should be dropped.
- *
- * @param string|array $index
- * @return \Illuminate\Support\Fluent
- */
- public function dropFullText($index)
- {
- return $this->dropIndexCommand('dropFullText', 'fulltext', $index);
- }
- /**
- * Indicate that the given spatial index should be dropped.
- *
- * @param string|array $index
- * @return \Illuminate\Support\Fluent
- */
- public function dropSpatialIndex($index)
- {
- return $this->dropIndexCommand('dropSpatialIndex', 'spatialIndex', $index);
- }
- /**
- * Indicate that the given foreign key should be dropped.
- *
- * @param string|array $index
- * @return \Illuminate\Support\Fluent
- */
- public function dropForeign($index)
- {
- return $this->dropIndexCommand('dropForeign', 'foreign', $index);
- }
- /**
- * Indicate that the given column and foreign key should be dropped.
- *
- * @param string $column
- * @return \Illuminate\Support\Fluent
- */
- public function dropConstrainedForeignId($column)
- {
- $this->dropForeign([$column]);
- return $this->dropColumn($column);
- }
- /**
- * Indicate that the given foreign key should be dropped.
- *
- * @param \Illuminate\Database\Eloquent\Model|string $model
- * @param string|null $column
- * @return \Illuminate\Support\Fluent
- */
- public function dropForeignIdFor($model, $column = null)
- {
- if (is_string($model)) {
- $model = new $model;
- }
- return $this->dropForeign([$column ?: $model->getForeignKey()]);
- }
- /**
- * Indicate that the given foreign key should be dropped.
- *
- * @param \Illuminate\Database\Eloquent\Model|string $model
- * @param string|null $column
- * @return \Illuminate\Support\Fluent
- */
- public function dropConstrainedForeignIdFor($model, $column = null)
- {
- if (is_string($model)) {
- $model = new $model;
- }
- return $this->dropConstrainedForeignId($column ?: $model->getForeignKey());
- }
- /**
- * Indicate that the given indexes should be renamed.
- *
- * @param string $from
- * @param string $to
- * @return \Illuminate\Support\Fluent
- */
- public function renameIndex($from, $to)
- {
- return $this->addCommand('renameIndex', compact('from', 'to'));
- }
- /**
- * Indicate that the timestamp columns should be dropped.
- *
- * @return void
- */
- public function dropTimestamps()
- {
- $this->dropColumn('created_at', 'updated_at');
- }
- /**
- * Indicate that the timestamp columns should be dropped.
- *
- * @return void
- */
- public function dropTimestampsTz()
- {
- $this->dropTimestamps();
- }
- /**
- * Indicate that the soft delete column should be dropped.
- *
- * @param string $column
- * @return void
- */
- public function dropSoftDeletes($column = 'deleted_at')
- {
- $this->dropColumn($column);
- }
- /**
- * Indicate that the soft delete column should be dropped.
- *
- * @param string $column
- * @return void
- */
- public function dropSoftDeletesTz($column = 'deleted_at')
- {
- $this->dropSoftDeletes($column);
- }
- /**
- * Indicate that the remember token column should be dropped.
- *
- * @return void
- */
- public function dropRememberToken()
- {
- $this->dropColumn('remember_token');
- }
- /**
- * Indicate that the polymorphic columns should be dropped.
- *
- * @param string $name
- * @param string|null $indexName
- * @return void
- */
- public function dropMorphs($name, $indexName = null)
- {
- $this->dropIndex($indexName ?: $this->createIndexName('index', ["{$name}_type", "{$name}_id"]));
- $this->dropColumn("{$name}_type", "{$name}_id");
- }
- /**
- * Rename the table to a given name.
- *
- * @param string $to
- * @return \Illuminate\Support\Fluent
- */
- public function rename($to)
- {
- return $this->addCommand('rename', compact('to'));
- }
- /**
- * Specify the primary key(s) for the table.
- *
- * @param string|array $columns
- * @param string|null $name
- * @param string|null $algorithm
- * @return \Illuminate\Database\Schema\IndexDefinition
- */
- public function primary($columns, $name = null, $algorithm = null)
- {
- return $this->indexCommand('primary', $columns, $name, $algorithm);
- }
- /**
- * Specify a unique index for the table.
- *
- * @param string|array $columns
- * @param string|null $name
- * @param string|null $algorithm
- * @return \Illuminate\Database\Schema\IndexDefinition
- */
- public function unique($columns, $name = null, $algorithm = null)
- {
- return $this->indexCommand('unique', $columns, $name, $algorithm);
- }
- /**
- * Specify an index for the table.
- *
- * @param string|array $columns
- * @param string|null $name
- * @param string|null $algorithm
- * @return \Illuminate\Database\Schema\IndexDefinition
- */
- public function index($columns, $name = null, $algorithm = null)
- {
- return $this->indexCommand('index', $columns, $name, $algorithm);
- }
- /**
- * Specify an fulltext for the table.
- *
- * @param string|array $columns
- * @param string|null $name
- * @param string|null $algorithm
- * @return \Illuminate\Database\Schema\IndexDefinition
- */
- public function fullText($columns, $name = null, $algorithm = null)
- {
- return $this->indexCommand('fulltext', $columns, $name, $algorithm);
- }
- /**
- * Specify a spatial index for the table.
- *
- * @param string|array $columns
- * @param string|null $name
- * @return \Illuminate\Database\Schema\IndexDefinition
- */
- public function spatialIndex($columns, $name = null)
- {
- return $this->indexCommand('spatialIndex', $columns, $name);
- }
- /**
- * Specify a raw index for the table.
- *
- * @param string $expression
- * @param string $name
- * @return \Illuminate\Database\Schema\IndexDefinition
- */
- public function rawIndex($expression, $name)
- {
- return $this->index([new Expression($expression)], $name);
- }
- /**
- * Specify a foreign key for the table.
- *
- * @param string|array $columns
- * @param string|null $name
- * @return \Illuminate\Database\Schema\ForeignKeyDefinition
- */
- public function foreign($columns, $name = null)
- {
- $command = new ForeignKeyDefinition(
- $this->indexCommand('foreign', $columns, $name)->getAttributes()
- );
- $this->commands[count($this->commands) - 1] = $command;
- return $command;
- }
- /**
- * Create a new auto-incrementing big integer (8-byte) column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function id($column = 'id')
- {
- return $this->bigIncrements($column);
- }
- /**
- * Create a new auto-incrementing integer (4-byte) column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function increments($column)
- {
- return $this->unsignedInteger($column, true);
- }
- /**
- * Create a new auto-incrementing integer (4-byte) column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function integerIncrements($column)
- {
- return $this->unsignedInteger($column, true);
- }
- /**
- * Create a new auto-incrementing tiny integer (1-byte) column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function tinyIncrements($column)
- {
- return $this->unsignedTinyInteger($column, true);
- }
- /**
- * Create a new auto-incrementing small integer (2-byte) column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function smallIncrements($column)
- {
- return $this->unsignedSmallInteger($column, true);
- }
- /**
- * Create a new auto-incrementing medium integer (3-byte) column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function mediumIncrements($column)
- {
- return $this->unsignedMediumInteger($column, true);
- }
- /**
- * Create a new auto-incrementing big integer (8-byte) column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function bigIncrements($column)
- {
- return $this->unsignedBigInteger($column, true);
- }
- /**
- * Create a new char column on the table.
- *
- * @param string $column
- * @param int|null $length
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function char($column, $length = null)
- {
- $length = ! is_null($length) ? $length : Builder::$defaultStringLength;
- return $this->addColumn('char', $column, compact('length'));
- }
- /**
- * Create a new string column on the table.
- *
- * @param string $column
- * @param int|null $length
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function string($column, $length = null)
- {
- $length = $length ?: Builder::$defaultStringLength;
- return $this->addColumn('string', $column, compact('length'));
- }
- /**
- * Create a new tiny text column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function tinyText($column)
- {
- return $this->addColumn('tinyText', $column);
- }
- /**
- * Create a new text column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function text($column)
- {
- return $this->addColumn('text', $column);
- }
- /**
- * Create a new medium text column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function mediumText($column)
- {
- return $this->addColumn('mediumText', $column);
- }
- /**
- * Create a new long text column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function longText($column)
- {
- return $this->addColumn('longText', $column);
- }
- /**
- * Create a new integer (4-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @param bool $unsigned
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function integer($column, $autoIncrement = false, $unsigned = false)
- {
- return $this->addColumn('integer', $column, compact('autoIncrement', 'unsigned'));
- }
- /**
- * Create a new tiny integer (1-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @param bool $unsigned
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function tinyInteger($column, $autoIncrement = false, $unsigned = false)
- {
- return $this->addColumn('tinyInteger', $column, compact('autoIncrement', 'unsigned'));
- }
- /**
- * Create a new small integer (2-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @param bool $unsigned
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function smallInteger($column, $autoIncrement = false, $unsigned = false)
- {
- return $this->addColumn('smallInteger', $column, compact('autoIncrement', 'unsigned'));
- }
- /**
- * Create a new medium integer (3-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @param bool $unsigned
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function mediumInteger($column, $autoIncrement = false, $unsigned = false)
- {
- return $this->addColumn('mediumInteger', $column, compact('autoIncrement', 'unsigned'));
- }
- /**
- * Create a new big integer (8-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @param bool $unsigned
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function bigInteger($column, $autoIncrement = false, $unsigned = false)
- {
- return $this->addColumn('bigInteger', $column, compact('autoIncrement', 'unsigned'));
- }
- /**
- * Create a new unsigned integer (4-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function unsignedInteger($column, $autoIncrement = false)
- {
- return $this->integer($column, $autoIncrement, true);
- }
- /**
- * Create a new unsigned tiny integer (1-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function unsignedTinyInteger($column, $autoIncrement = false)
- {
- return $this->tinyInteger($column, $autoIncrement, true);
- }
- /**
- * Create a new unsigned small integer (2-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function unsignedSmallInteger($column, $autoIncrement = false)
- {
- return $this->smallInteger($column, $autoIncrement, true);
- }
- /**
- * Create a new unsigned medium integer (3-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function unsignedMediumInteger($column, $autoIncrement = false)
- {
- return $this->mediumInteger($column, $autoIncrement, true);
- }
- /**
- * Create a new unsigned big integer (8-byte) column on the table.
- *
- * @param string $column
- * @param bool $autoIncrement
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function unsignedBigInteger($column, $autoIncrement = false)
- {
- return $this->bigInteger($column, $autoIncrement, true);
- }
- /**
- * Create a new unsigned big integer (8-byte) column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ForeignIdColumnDefinition
- */
- public function foreignId($column)
- {
- return $this->addColumnDefinition(new ForeignIdColumnDefinition($this, [
- 'type' => 'bigInteger',
- 'name' => $column,
- 'autoIncrement' => false,
- 'unsigned' => true,
- ]));
- }
- /**
- * Create a foreign ID column for the given model.
- *
- * @param \Illuminate\Database\Eloquent\Model|string $model
- * @param string|null $column
- * @return \Illuminate\Database\Schema\ForeignIdColumnDefinition
- */
- public function foreignIdFor($model, $column = null)
- {
- if (is_string($model)) {
- $model = new $model;
- }
- $column = $column ?: $model->getForeignKey();
- if ($model->getKeyType() === 'int' && $model->getIncrementing()) {
- return $this->foreignId($column);
- }
- $modelTraits = class_uses_recursive($model);
- if (in_array(HasUlids::class, $modelTraits, true)) {
- return $this->foreignUlid($column);
- }
- return $this->foreignUuid($column);
- }
- /**
- * Create a new float column on the table.
- *
- * @param string $column
- * @param int $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function float($column, $precision = 53)
- {
- return $this->addColumn('float', $column, compact('precision'));
- }
- /**
- * Create a new double column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function double($column)
- {
- return $this->addColumn('double', $column);
- }
- /**
- * Create a new decimal column on the table.
- *
- * @param string $column
- * @param int $total
- * @param int $places
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function decimal($column, $total = 8, $places = 2)
- {
- return $this->addColumn('decimal', $column, compact('total', 'places'));
- }
- /**
- * Create a new boolean column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function boolean($column)
- {
- return $this->addColumn('boolean', $column);
- }
- /**
- * Create a new enum column on the table.
- *
- * @param string $column
- * @param array $allowed
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function enum($column, array $allowed)
- {
- return $this->addColumn('enum', $column, compact('allowed'));
- }
- /**
- * Create a new set column on the table.
- *
- * @param string $column
- * @param array $allowed
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function set($column, array $allowed)
- {
- return $this->addColumn('set', $column, compact('allowed'));
- }
- /**
- * Create a new json column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function json($column)
- {
- return $this->addColumn('json', $column);
- }
- /**
- * Create a new jsonb column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function jsonb($column)
- {
- return $this->addColumn('jsonb', $column);
- }
- /**
- * Create a new date column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function date($column)
- {
- return $this->addColumn('date', $column);
- }
- /**
- * Create a new date-time column on the table.
- *
- * @param string $column
- * @param int|null $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function dateTime($column, $precision = 0)
- {
- return $this->addColumn('dateTime', $column, compact('precision'));
- }
- /**
- * Create a new date-time column (with time zone) on the table.
- *
- * @param string $column
- * @param int|null $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function dateTimeTz($column, $precision = 0)
- {
- return $this->addColumn('dateTimeTz', $column, compact('precision'));
- }
- /**
- * Create a new time column on the table.
- *
- * @param string $column
- * @param int|null $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function time($column, $precision = 0)
- {
- return $this->addColumn('time', $column, compact('precision'));
- }
- /**
- * Create a new time column (with time zone) on the table.
- *
- * @param string $column
- * @param int|null $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function timeTz($column, $precision = 0)
- {
- return $this->addColumn('timeTz', $column, compact('precision'));
- }
- /**
- * Create a new timestamp column on the table.
- *
- * @param string $column
- * @param int|null $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function timestamp($column, $precision = 0)
- {
- return $this->addColumn('timestamp', $column, compact('precision'));
- }
- /**
- * Create a new timestamp (with time zone) column on the table.
- *
- * @param string $column
- * @param int|null $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function timestampTz($column, $precision = 0)
- {
- return $this->addColumn('timestampTz', $column, compact('precision'));
- }
- /**
- * Add nullable creation and update timestamps to the table.
- *
- * @param int|null $precision
- * @return void
- */
- public function timestamps($precision = 0)
- {
- $this->timestamp('created_at', $precision)->nullable();
- $this->timestamp('updated_at', $precision)->nullable();
- }
- /**
- * Add nullable creation and update timestamps to the table.
- *
- * Alias for self::timestamps().
- *
- * @param int|null $precision
- * @return void
- */
- public function nullableTimestamps($precision = 0)
- {
- $this->timestamps($precision);
- }
- /**
- * Add creation and update timestampTz columns to the table.
- *
- * @param int|null $precision
- * @return void
- */
- public function timestampsTz($precision = 0)
- {
- $this->timestampTz('created_at', $precision)->nullable();
- $this->timestampTz('updated_at', $precision)->nullable();
- }
- /**
- * Add creation and update datetime columns to the table.
- *
- * @param int|null $precision
- * @return void
- */
- public function datetimes($precision = 0)
- {
- $this->datetime('created_at', $precision)->nullable();
- $this->datetime('updated_at', $precision)->nullable();
- }
- /**
- * Add a "deleted at" timestamp for the table.
- *
- * @param string $column
- * @param int|null $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function softDeletes($column = 'deleted_at', $precision = 0)
- {
- return $this->timestamp($column, $precision)->nullable();
- }
- /**
- * Add a "deleted at" timestampTz for the table.
- *
- * @param string $column
- * @param int|null $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function softDeletesTz($column = 'deleted_at', $precision = 0)
- {
- return $this->timestampTz($column, $precision)->nullable();
- }
- /**
- * Add a "deleted at" datetime column to the table.
- *
- * @param string $column
- * @param int|null $precision
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function softDeletesDatetime($column = 'deleted_at', $precision = 0)
- {
- return $this->datetime($column, $precision)->nullable();
- }
- /**
- * Create a new year column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function year($column)
- {
- return $this->addColumn('year', $column);
- }
- /**
- * Create a new binary column on the table.
- *
- * @param string $column
- * @param int|null $length
- * @param bool $fixed
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function binary($column, $length = null, $fixed = false)
- {
- return $this->addColumn('binary', $column, compact('length', 'fixed'));
- }
- /**
- * Create a new UUID column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function uuid($column = 'uuid')
- {
- return $this->addColumn('uuid', $column);
- }
- /**
- * Create a new UUID column on the table with a foreign key constraint.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ForeignIdColumnDefinition
- */
- public function foreignUuid($column)
- {
- return $this->addColumnDefinition(new ForeignIdColumnDefinition($this, [
- 'type' => 'uuid',
- 'name' => $column,
- ]));
- }
- /**
- * Create a new ULID column on the table.
- *
- * @param string $column
- * @param int|null $length
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function ulid($column = 'ulid', $length = 26)
- {
- return $this->char($column, $length);
- }
- /**
- * Create a new ULID column on the table with a foreign key constraint.
- *
- * @param string $column
- * @param int|null $length
- * @return \Illuminate\Database\Schema\ForeignIdColumnDefinition
- */
- public function foreignUlid($column, $length = 26)
- {
- return $this->addColumnDefinition(new ForeignIdColumnDefinition($this, [
- 'type' => 'char',
- 'name' => $column,
- 'length' => $length,
- ]));
- }
- /**
- * Create a new IP address column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function ipAddress($column = 'ip_address')
- {
- return $this->addColumn('ipAddress', $column);
- }
- /**
- * Create a new MAC address column on the table.
- *
- * @param string $column
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function macAddress($column = 'mac_address')
- {
- return $this->addColumn('macAddress', $column);
- }
- /**
- * Create a new geometry column on the table.
- *
- * @param string $column
- * @param string|null $subtype
- * @param int $srid
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function geometry($column, $subtype = null, $srid = 0)
- {
- return $this->addColumn('geometry', $column, compact('subtype', 'srid'));
- }
- /**
- * Create a new geography column on the table.
- *
- * @param string $column
- * @param string|null $subtype
- * @param int $srid
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function geography($column, $subtype = null, $srid = 4326)
- {
- return $this->addColumn('geography', $column, compact('subtype', 'srid'));
- }
- /**
- * Create a new generated, computed column on the table.
- *
- * @param string $column
- * @param string $expression
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function computed($column, $expression)
- {
- return $this->addColumn('computed', $column, compact('expression'));
- }
- /**
- * Add the proper columns for a polymorphic table.
- *
- * @param string $name
- * @param string|null $indexName
- * @return void
- */
- public function morphs($name, $indexName = null)
- {
- if (Builder::$defaultMorphKeyType === 'uuid') {
- $this->uuidMorphs($name, $indexName);
- } elseif (Builder::$defaultMorphKeyType === 'ulid') {
- $this->ulidMorphs($name, $indexName);
- } else {
- $this->numericMorphs($name, $indexName);
- }
- }
- /**
- * Add nullable columns for a polymorphic table.
- *
- * @param string $name
- * @param string|null $indexName
- * @return void
- */
- public function nullableMorphs($name, $indexName = null)
- {
- if (Builder::$defaultMorphKeyType === 'uuid') {
- $this->nullableUuidMorphs($name, $indexName);
- } elseif (Builder::$defaultMorphKeyType === 'ulid') {
- $this->nullableUlidMorphs($name, $indexName);
- } else {
- $this->nullableNumericMorphs($name, $indexName);
- }
- }
- /**
- * Add the proper columns for a polymorphic table using numeric IDs (incremental).
- *
- * @param string $name
- * @param string|null $indexName
- * @return void
- */
- public function numericMorphs($name, $indexName = null)
- {
- $this->string("{$name}_type");
- $this->unsignedBigInteger("{$name}_id");
- $this->index(["{$name}_type", "{$name}_id"], $indexName);
- }
- /**
- * Add nullable columns for a polymorphic table using numeric IDs (incremental).
- *
- * @param string $name
- * @param string|null $indexName
- * @return void
- */
- public function nullableNumericMorphs($name, $indexName = null)
- {
- $this->string("{$name}_type")->nullable();
- $this->unsignedBigInteger("{$name}_id")->nullable();
- $this->index(["{$name}_type", "{$name}_id"], $indexName);
- }
- /**
- * Add the proper columns for a polymorphic table using UUIDs.
- *
- * @param string $name
- * @param string|null $indexName
- * @return void
- */
- public function uuidMorphs($name, $indexName = null)
- {
- $this->string("{$name}_type");
- $this->uuid("{$name}_id");
- $this->index(["{$name}_type", "{$name}_id"], $indexName);
- }
- /**
- * Add nullable columns for a polymorphic table using UUIDs.
- *
- * @param string $name
- * @param string|null $indexName
- * @return void
- */
- public function nullableUuidMorphs($name, $indexName = null)
- {
- $this->string("{$name}_type")->nullable();
- $this->uuid("{$name}_id")->nullable();
- $this->index(["{$name}_type", "{$name}_id"], $indexName);
- }
- /**
- * Add the proper columns for a polymorphic table using ULIDs.
- *
- * @param string $name
- * @param string|null $indexName
- * @return void
- */
- public function ulidMorphs($name, $indexName = null)
- {
- $this->string("{$name}_type");
- $this->ulid("{$name}_id");
- $this->index(["{$name}_type", "{$name}_id"], $indexName);
- }
- /**
- * Add nullable columns for a polymorphic table using ULIDs.
- *
- * @param string $name
- * @param string|null $indexName
- * @return void
- */
- public function nullableUlidMorphs($name, $indexName = null)
- {
- $this->string("{$name}_type")->nullable();
- $this->ulid("{$name}_id")->nullable();
- $this->index(["{$name}_type", "{$name}_id"], $indexName);
- }
- /**
- * Adds the `remember_token` column to the table.
- *
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function rememberToken()
- {
- return $this->string('remember_token', 100)->nullable();
- }
- /**
- * Add a comment to the table.
- *
- * @param string $comment
- * @return \Illuminate\Support\Fluent
- */
- public function comment($comment)
- {
- return $this->addCommand('tableComment', compact('comment'));
- }
- /**
- * Add a new index command to the blueprint.
- *
- * @param string $type
- * @param string|array $columns
- * @param string $index
- * @param string|null $algorithm
- * @return \Illuminate\Support\Fluent
- */
- protected function indexCommand($type, $columns, $index, $algorithm = null)
- {
- $columns = (array) $columns;
- // If no name was specified for this index, we will create one using a basic
- // convention of the table name, followed by the columns, followed by an
- // index type, such as primary or index, which makes the index unique.
- $index = $index ?: $this->createIndexName($type, $columns);
- return $this->addCommand(
- $type, compact('index', 'columns', 'algorithm')
- );
- }
- /**
- * Create a new drop index command on the blueprint.
- *
- * @param string $command
- * @param string $type
- * @param string|array $index
- * @return \Illuminate\Support\Fluent
- */
- protected function dropIndexCommand($command, $type, $index)
- {
- $columns = [];
- // If the given "index" is actually an array of columns, the developer means
- // to drop an index merely by specifying the columns involved without the
- // conventional name, so we will build the index name from the columns.
- if (is_array($index)) {
- $index = $this->createIndexName($type, $columns = $index);
- }
- return $this->indexCommand($command, $columns, $index);
- }
- /**
- * Create a default index name for the table.
- *
- * @param string $type
- * @param array $columns
- * @return string
- */
- protected function createIndexName($type, array $columns)
- {
- $table = str_contains($this->table, '.')
- ? substr_replace($this->table, '.'.$this->prefix, strrpos($this->table, '.'), 1)
- : $this->prefix.$this->table;
- $index = strtolower($table.'_'.implode('_', $columns).'_'.$type);
- return str_replace(['-', '.'], '_', $index);
- }
- /**
- * Add a new column to the blueprint.
- *
- * @param string $type
- * @param string $name
- * @param array $parameters
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- public function addColumn($type, $name, array $parameters = [])
- {
- return $this->addColumnDefinition(new ColumnDefinition(
- array_merge(compact('type', 'name'), $parameters)
- ));
- }
- /**
- * Add a new column definition to the blueprint.
- *
- * @param \Illuminate\Database\Schema\ColumnDefinition $definition
- * @return \Illuminate\Database\Schema\ColumnDefinition
- */
- protected function addColumnDefinition($definition)
- {
- $this->columns[] = $definition;
- if ($this->after) {
- $definition->after($this->after);
- $this->after = $definition->name;
- }
- return $definition;
- }
- /**
- * Add the columns from the callback after the given column.
- *
- * @param string $column
- * @param \Closure $callback
- * @return void
- */
- public function after($column, Closure $callback)
- {
- $this->after = $column;
- $callback($this);
- $this->after = null;
- }
- /**
- * Remove a column from the schema blueprint.
- *
- * @param string $name
- * @return $this
- */
- public function removeColumn($name)
- {
- $this->columns = array_values(array_filter($this->columns, function ($c) use ($name) {
- return $c['name'] != $name;
- }));
- return $this;
- }
- /**
- * Add a new command to the blueprint.
- *
- * @param string $name
- * @param array $parameters
- * @return \Illuminate\Support\Fluent
- */
- protected function addCommand($name, array $parameters = [])
- {
- $this->commands[] = $command = $this->createCommand($name, $parameters);
- return $command;
- }
- /**
- * Create a new Fluent command.
- *
- * @param string $name
- * @param array $parameters
- * @return \Illuminate\Support\Fluent
- */
- protected function createCommand($name, array $parameters = [])
- {
- return new Fluent(array_merge(compact('name'), $parameters));
- }
- /**
- * Get the table the blueprint describes.
- *
- * @return string
- */
- public function getTable()
- {
- return $this->table;
- }
- /**
- * Get the table prefix.
- *
- * @return string
- */
- public function getPrefix()
- {
- return $this->prefix;
- }
- /**
- * Get the columns on the blueprint.
- *
- * @return \Illuminate\Database\Schema\ColumnDefinition[]
- */
- public function getColumns()
- {
- return $this->columns;
- }
- /**
- * Get the commands on the blueprint.
- *
- * @return \Illuminate\Support\Fluent[]
- */
- public function getCommands()
- {
- return $this->commands;
- }
- /**
- * Get the columns on the blueprint that should be added.
- *
- * @return \Illuminate\Database\Schema\ColumnDefinition[]
- */
- public function getAddedColumns()
- {
- return array_filter($this->columns, function ($column) {
- return ! $column->change;
- });
- }
- /**
- * Get the columns on the blueprint that should be changed.
- *
- * @return \Illuminate\Database\Schema\ColumnDefinition[]
- */
- public function getChangedColumns()
- {
- return array_filter($this->columns, function ($column) {
- return (bool) $column->change;
- });
- }
- }
|