123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536 |
- <?php
- declare(strict_types=1);
- /**
- * This file is part of Hyperf.
- *
- * @link https://www.hyperf.io
- * @document https://hyperf.wiki
- * @contact group@hyperf.io
- * @license https://github.com/hyperf/hyperf/blob/master/LICENSE
- */
- namespace Hyperf\Database\Schema;
- use BadMethodCallException;
- use Closure;
- use Hyperf\Collection\Collection;
- use Hyperf\Database\Connection;
- use Hyperf\Database\Query\Expression;
- use Hyperf\Database\Schema\Grammars\Grammar;
- use Hyperf\Database\SQLiteConnection;
- use Hyperf\Macroable\Macroable;
- use Hyperf\Support\Fluent;
- use function Hyperf\Collection\collect;
- class Blueprint
- {
- use Macroable;
- /**
- * 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.
- */
- public $charset;
- /**
- * The collation that should be used for the table.
- */
- public $collation;
- /**
- * Whether to make the table temporary.
- *
- * @var bool
- */
- public $temporary = false;
- /**
- * The column to add new columns after.
- *
- * @var string
- */
- public $after;
- /**
- * The comment of the table.
- *
- * @var string
- */
- protected $comment = '';
- /**
- * 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 \Hyperf\Database\Schema\ColumnDefinition[]
- */
- protected $columns = [];
- /**
- * The commands that should be run for the table.
- *
- * @var Fluent[]
- */
- protected $commands = [];
- /**
- * Create a new schema blueprint.
- *
- * @param string $table
- * @param string $prefix
- */
- 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.
- */
- 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.
- *
- * @return array
- */
- public function toSql(Connection $connection, Grammar $grammar)
- {
- $this->addImpliedCommands($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) {
- $method = 'compile' . ucfirst($command->name);
- if (method_exists($grammar, $method)) {
- if (! is_null($sql = $grammar->{$method}($this, $command, $connection))) {
- $statements = array_merge($statements, (array) $sql);
- }
- }
- }
- return $statements;
- }
- /**
- * Add the fluent commands specified on any columns.
- */
- public function addFluentCommands(Grammar $grammar)
- {
- foreach ($this->columns as $column) {
- foreach ($grammar->getFluentCommands() as $commandName) {
- $attributeName = lcfirst($commandName);
- if (! isset($column->{$attributeName})) {
- continue;
- }
- $value = $column->{$attributeName};
- $this->addCommand(
- $commandName,
- compact('value', 'column')
- );
- }
- }
- }
- /**
- * Indicate that the table needs to be created.
- *
- * @return Fluent
- */
- public function create()
- {
- return $this->addCommand('create');
- }
- /**
- * Set the table comment.
- */
- public function comment(string $comment)
- {
- $this->comment = $comment;
- }
- /**
- * Indicate that the table needs to be temporary.
- */
- public function temporary()
- {
- $this->temporary = true;
- }
- /**
- * Indicate that the table should be dropped.
- *
- * @return Fluent
- */
- public function drop()
- {
- return $this->addCommand('drop');
- }
- /**
- * Indicate that the table should be dropped if it exists.
- *
- * @return Fluent
- */
- public function dropIfExists()
- {
- return $this->addCommand('dropIfExists');
- }
- /**
- * Indicate that the given columns should be dropped.
- *
- * @param array|mixed $columns
- * @return 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 Fluent
- */
- public function renameColumn($from, $to)
- {
- return $this->addCommand('renameColumn', compact('from', 'to'));
- }
- /**
- * Indicate that the given primary key should be dropped.
- *
- * @param array|string $index
- * @return Fluent
- */
- public function dropPrimary($index = null)
- {
- return $this->dropIndexCommand('dropPrimary', 'primary', $index);
- }
- /**
- * Indicate that the given unique key should be dropped.
- *
- * @param array|string $index
- * @return Fluent
- */
- public function dropUnique($index)
- {
- return $this->dropIndexCommand('dropUnique', 'unique', $index);
- }
- /**
- * Indicate that the given index should be dropped.
- *
- * @param array|string $index
- * @return Fluent
- */
- public function dropIndex($index)
- {
- return $this->dropIndexCommand('dropIndex', 'index', $index);
- }
- /**
- * Indicate that the given fulltext index should be dropped.
- *
- * @param array|string $index
- * @return Fluent
- */
- public function dropFullText($index)
- {
- return $this->dropIndexCommand('dropFullText', 'fulltext', $index);
- }
- /**
- * Indicate that the given spatial index should be dropped.
- *
- * @param array|string $index
- * @return Fluent
- */
- public function dropSpatialIndex($index)
- {
- return $this->dropIndexCommand('dropSpatialIndex', 'spatialIndex', $index);
- }
- /**
- * Indicate that the given foreign key should be dropped.
- *
- * @param array|string $index
- * @return Fluent
- */
- public function dropForeign($index)
- {
- return $this->dropIndexCommand('dropForeign', 'foreign', $index);
- }
- /**
- * Indicate that the given indexes should be renamed.
- *
- * @param string $from
- * @param string $to
- * @return Fluent
- */
- public function renameIndex($from, $to)
- {
- return $this->addCommand('renameIndex', compact('from', 'to'));
- }
- /**
- * Indicate that the timestamp columns should be dropped.
- */
- public function dropTimestamps()
- {
- $this->dropColumn('created_at', 'updated_at');
- }
- /**
- * Indicate that the timestamp columns should be dropped.
- */
- public function dropTimestampsTz()
- {
- $this->dropTimestamps();
- }
- /**
- * Indicate that the soft delete column should be dropped.
- *
- * @param string $column
- */
- public function dropSoftDeletes($column = 'deleted_at')
- {
- $this->dropColumn($column);
- }
- /**
- * Indicate that the soft delete column should be dropped.
- *
- * @param string $column
- */
- public function dropSoftDeletesTz($column = 'deleted_at')
- {
- $this->dropSoftDeletes($column);
- }
- /**
- * Indicate that the remember token column should be dropped.
- */
- public function dropRememberToken()
- {
- $this->dropColumn('remember_token');
- }
- /**
- * Indicate that the polymorphic columns should be dropped.
- *
- * @param string $name
- * @param null|string $indexName
- */
- 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 Fluent
- */
- public function rename($to)
- {
- return $this->addCommand('rename', compact('to'));
- }
- /**
- * Specify the primary key(s) for the table.
- *
- * @param array|string $columns
- * @param string $name
- * @param null|string $algorithm
- * @return Fluent
- */
- public function primary($columns, $name = null, $algorithm = null)
- {
- return $this->indexCommand('primary', $columns, $name, $algorithm);
- }
- /**
- * Specify a unique index for the table.
- *
- * @param array|string $columns
- * @param string $name
- * @param null|string $algorithm
- * @return Fluent
- */
- public function unique($columns, $name = null, $algorithm = null)
- {
- return $this->indexCommand('unique', $columns, $name, $algorithm);
- }
- /**
- * Specify an index for the table.
- *
- * @param array|string $columns
- * @param string $name
- * @param null|string $algorithm
- * @return Fluent
- */
- public function index($columns, $name = null, $algorithm = null)
- {
- return $this->indexCommand('index', $columns, $name, $algorithm);
- }
- /**
- * Specify a spatial index for the table.
- *
- * @param array|string $columns
- * @param string $name
- * @return Fluent
- */
- public function spatialIndex($columns, $name = null)
- {
- return $this->indexCommand('spatialIndex', $columns, $name);
- }
- /**
- * Specify a foreign key for the table.
- *
- * @param array|string $columns
- * @param string $name
- * @return Fluent|ForeignKeyDefinition
- */
- public function foreign($columns, $name = null)
- {
- return $this->indexCommand('foreign', $columns, $name);
- }
- /**
- * Create a new auto-incrementing integer (4-byte) column on the table.
- *
- * @param string $column
- * @return 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 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 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 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 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 ColumnDefinition
- */
- public function bigIncrements($column)
- {
- return $this->unsignedBigInteger($column, true);
- }
- /**
- * Create a new char column on the table.
- *
- * @param string $column
- * @param int $length
- * @return ColumnDefinition
- */
- public function char($column, $length = 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 $length
- * @return ColumnDefinition
- */
- public function string($column, $length = null)
- {
- $length = $length ?: Builder::$defaultStringLength;
- return $this->addColumn('string', $column, compact('length'));
- }
- /**
- * Create a new text column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function text($column)
- {
- return $this->addColumn('text', $column);
- }
- /**
- * Create a new medium text column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function mediumText($column)
- {
- return $this->addColumn('mediumText', $column);
- }
- /**
- * Create a new long text column on the table.
- *
- * @param string $column
- * @return 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 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 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 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 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 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 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 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 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 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 ColumnDefinition
- */
- public function unsignedBigInteger($column, $autoIncrement = false)
- {
- return $this->bigInteger($column, $autoIncrement, true);
- }
- /**
- * Create a new float column on the table.
- *
- * @param string $column
- * @param int $total
- * @param int $places
- * @return ColumnDefinition
- */
- public function float($column, $total = 8, $places = 2)
- {
- return $this->addColumn('float', $column, compact('total', 'places'));
- }
- /**
- * Create a new double column on the table.
- *
- * @param string $column
- * @param null|int $total
- * @param null|int $places
- * @return ColumnDefinition
- */
- public function double($column, $total = null, $places = null)
- {
- return $this->addColumn('double', $column, compact('total', 'places'));
- }
- /**
- * Create a new decimal column on the table.
- *
- * @param string $column
- * @param int $total
- * @param int $places
- * @return ColumnDefinition
- */
- public function decimal($column, $total = 8, $places = 2)
- {
- return $this->addColumn('decimal', $column, compact('total', 'places'));
- }
- /**
- * Create a new unsigned decimal column on the table.
- *
- * @param string $column
- * @param int $total
- * @param int $places
- * @return ColumnDefinition
- */
- public function unsignedDecimal($column, $total = 8, $places = 2)
- {
- return $this->addColumn('decimal', $column, [
- 'total' => $total, 'places' => $places, 'unsigned' => true,
- ]);
- }
- /**
- * Create a new boolean column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function boolean($column)
- {
- return $this->addColumn('boolean', $column);
- }
- /**
- * Create a new enum column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function enum($column, array $allowed)
- {
- return $this->addColumn('enum', $column, compact('allowed'));
- }
- /**
- * Create a new json column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function json($column)
- {
- return $this->addColumn('json', $column);
- }
- /**
- * Create a new jsonb column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function jsonb($column)
- {
- return $this->addColumn('jsonb', $column);
- }
- /**
- * Create a new date column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function date($column)
- {
- return $this->addColumn('date', $column);
- }
- /**
- * Create a new date-time column on the table.
- *
- * @param string $column
- * @param int $precision
- * @return 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 $precision
- * @return 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 $precision
- * @return 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 $precision
- * @return 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 $precision
- * @return 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 $precision
- * @return 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 $precision
- */
- 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 $precision
- */
- public function nullableTimestamps($precision = 0)
- {
- $this->timestamps($precision);
- }
- /**
- * Add creation and update timestampTz columns to the table.
- *
- * @param int $precision
- */
- 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 null|int $precision
- */
- 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 $precision
- * @return 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 $precision
- * @return ColumnDefinition
- */
- public function softDeletesTz($column = 'deleted_at', $precision = 0)
- {
- return $this->timestampTz($column, $precision)->nullable();
- }
- /**
- * Create a new year column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function year($column)
- {
- return $this->addColumn('year', $column);
- }
- /**
- * Create a new binary column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function binary($column)
- {
- return $this->addColumn('binary', $column);
- }
- /**
- * Create a new auto-incrementing big integer (8-byte) column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function id($column = 'id')
- {
- return $this->bigIncrements($column);
- }
- /**
- * Create a new ULID column on the table.
- *
- * @param string $column
- * @param null|int $length
- * @return ColumnDefinition
- */
- public function ulid($column = 'ulid', $length = 26)
- {
- return $this->char($column, $length);
- }
- /**
- * Create a new uuid column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function uuid($column)
- {
- return $this->addColumn('uuid', $column);
- }
- /**
- * Create a new IP address column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function ipAddress($column)
- {
- return $this->addColumn('ipAddress', $column);
- }
- /**
- * Create a new MAC address column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function macAddress($column)
- {
- return $this->addColumn('macAddress', $column);
- }
- /**
- * Create a new geometry column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function geometry($column)
- {
- return $this->addColumn('geometry', $column);
- }
- /**
- * Create a new point column on the table.
- *
- * @param string $column
- * @param null|int $srid
- * @return ColumnDefinition
- */
- public function point($column, $srid = null)
- {
- return $this->addColumn('point', $column, compact('srid'));
- }
- /**
- * Create a new linestring column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function lineString($column)
- {
- return $this->addColumn('linestring', $column);
- }
- /**
- * Create a new polygon column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function polygon($column)
- {
- return $this->addColumn('polygon', $column);
- }
- /**
- * Create a new geometrycollection column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function geometryCollection($column)
- {
- return $this->addColumn('geometrycollection', $column);
- }
- /**
- * Create a new multipoint column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function multiPoint($column)
- {
- return $this->addColumn('multipoint', $column);
- }
- /**
- * Create a new multilinestring column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function multiLineString($column)
- {
- return $this->addColumn('multilinestring', $column);
- }
- /**
- * Create a new multipolygon column on the table.
- *
- * @param string $column
- * @return ColumnDefinition
- */
- public function multiPolygon($column)
- {
- return $this->addColumn('multipolygon', $column);
- }
- /**
- * Add the proper columns for a polymorphic table.
- *
- * @param string $name
- * @param null|string $indexName
- */
- public function morphs($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.
- *
- * @param string $name
- * @param null|string $indexName
- */
- public function nullableMorphs($name, $indexName = null)
- {
- $this->string("{$name}_type")->nullable();
- $this->unsignedBigInteger("{$name}_id")->nullable();
- $this->index(["{$name}_type", "{$name}_id"], $indexName);
- }
- /**
- * Adds the `remember_token` column to the table.
- *
- * @return ColumnDefinition
- */
- public function rememberToken()
- {
- return $this->string('remember_token', 100)->nullable();
- }
- /**
- * Add a new column to the blueprint.
- *
- * @param string $type
- * @param string $name
- * @return ColumnDefinition
- */
- public function addColumn($type, $name, array $parameters = [])
- {
- $this->columns[] = $column = new ColumnDefinition(
- array_merge(compact('type', 'name'), $parameters)
- );
- return $column;
- }
- /**
- * 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['attributes']['name'] != $name;
- }));
- return $this;
- }
- /**
- * Get the table the blueprint describes.
- *
- * @return string
- */
- public function getTable()
- {
- return $this->table;
- }
- /**
- * Get the comment on the blueprint.
- *
- * @return string
- */
- public function getComment()
- {
- return $this->comment;
- }
- /**
- * Get the columns on the blueprint.
- *
- * @return \Hyperf\Database\Schema\ColumnDefinition[]
- */
- public function getColumns()
- {
- return $this->columns;
- }
- /**
- * Get the commands on the blueprint.
- *
- * @return Fluent[]
- */
- public function getCommands()
- {
- return $this->commands;
- }
- /**
- * Get the columns on the blueprint that should be added.
- *
- * @return \Hyperf\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 \Hyperf\Database\Schema\ColumnDefinition[]
- */
- public function getChangedColumns()
- {
- return array_filter($this->columns, function ($column) {
- return (bool) $column->change;
- });
- }
- /**
- * Determine if the blueprint has auto-increment columns.
- */
- public function hasAutoIncrementColumn(): bool
- {
- return ! is_null(collect($this->getAddedColumns())->first(function ($column) {
- return $column->autoIncrement === true;
- }));
- }
- /**
- * Get the auto-increment column starting values.
- */
- public function autoIncrementingStartingValues(): array
- {
- if (! $this->hasAutoIncrementColumn()) {
- return [];
- }
- return collect($this->getAddedColumns())->mapWithKeys(function ($column) {
- return $column->autoIncrement === true
- ? [$column->name => $column->get('startingValue', $column->get('from'))]
- : [$column->name => null];
- })->filter()->all();
- }
- /**
- * Specify an fulltext for the table.
- *
- * @param array|string $columns
- * @param null|string $name
- * @param null|string $algorithm
- * @return Fluent
- */
- public function fullText($columns, $name = null, $algorithm = null)
- {
- return $this->indexCommand('fulltext', $columns, $name, $algorithm);
- }
- /**
- * Specify a raw index for the table.
- *
- * @param string $expression
- * @param string $name
- * @return Fluent
- */
- public function rawIndex($expression, $name)
- {
- return $this->index([new Expression($expression)], $name);
- }
- /**
- * Create a new ULID column on the table with a foreign key constraint.
- *
- * @param string $column
- * @param null|int $length
- * @return ForeignIdColumnDefinition
- */
- public function foreignUlid($column = 'ulid', $length = 26)
- {
- return $this->addColumnDefinition(new ForeignIdColumnDefinition($this, [
- 'type' => 'char',
- 'name' => $column,
- 'length' => $length,
- ]));
- }
- /**
- * Create a new UUID column on the table with a foreign key constraint.
- *
- * @param string $column
- * @return ForeignIdColumnDefinition
- */
- public function foreignUuid($column)
- {
- return $this->addColumnDefinition(new ForeignIdColumnDefinition($this, [
- 'type' => 'uuid',
- 'name' => $column,
- ]));
- }
- /**
- * Ensure the commands on the blueprint are valid for the connection type.
- *
- * @throws BadMethodCallException
- */
- protected function ensureCommandsAreValid(Connection $connection)
- {
- if ($connection instanceof SQLiteConnection) {
- if ($this->commandsNamed(['dropColumn', 'renameColumn'])->count() > 1) {
- throw new BadMethodCallException(
- "SQLite doesn't support multiple calls to dropColumn / renameColumn in a single modification."
- );
- }
- if ($this->commandsNamed(['dropForeign'])->count() > 0) {
- throw new BadMethodCallException(
- "SQLite doesn't support dropping foreign keys (you would need to re-create the table)."
- );
- }
- }
- }
- /**
- * Get all of the commands matching the given names.
- *
- * @return 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.
- */
- protected function addImpliedCommands(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();
- $this->addFluentCommands($grammar);
- }
- /**
- * Add the index commands fluently specified on columns.
- */
- protected function addFluentIndexes()
- {
- foreach ($this->columns as $column) {
- foreach (['primary', 'unique', 'index', 'fullText', 'spatialIndex'] as $index) {
- // 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);
- 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.
- if (isset($column->{$index})) {
- $this->{$index}($column->name, $column->{$index});
- continue 2;
- }
- }
- }
- }
- /**
- * Determine if the blueprint has a create command.
- *
- * @return bool
- */
- protected function creating()
- {
- return collect($this->commands)->contains(function ($command) {
- return $command->name === 'create';
- });
- }
- /**
- * Add a new index command to the blueprint.
- *
- * @param string $type
- * @param array|string $columns
- * @param string $index
- * @param null|string $algorithm
- * @return 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 array|string $index
- * @return 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
- * @return string
- */
- protected function createIndexName($type, array $columns)
- {
- $index = strtolower($this->prefix . $this->table . '_' . implode('_', $columns) . '_' . $type);
- return str_replace(['-', '.'], '_', $index);
- }
- /**
- * Add a new command to the blueprint.
- *
- * @param string $name
- * @return Fluent
- */
- protected function addCommand($name, array $parameters = [])
- {
- $this->commands[] = $command = $this->createCommand($name, $parameters);
- return $command;
- }
- /**
- * Create a new Fluent command.
- *
- * @param string $name
- * @return Fluent
- */
- protected function createCommand($name, array $parameters = [])
- {
- return new Fluent(array_merge(compact('name'), $parameters));
- }
- /**
- * Add a new column definition to the blueprint.
- *
- * @param ColumnDefinition $definition
- * @return ColumnDefinition
- */
- protected function addColumnDefinition($definition)
- {
- $this->columns[] = $definition;
- if ($this->after) {
- $definition->after($this->after);
- $this->after = $definition->name;
- }
- return $definition;
- }
- }
|