-
Notifications
You must be signed in to change notification settings - Fork 611
/
MigrationHelper.php
394 lines (358 loc) · 12.5 KB
/
MigrationHelper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
<?php
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\helpers;
use Craft;
use craft\db\Connection;
use craft\db\Migration;
use craft\db\TableSchema;
/**
* Migration utility methods.
*
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 3.0.0
* @deprecated in 4.0.0. Use [[Db]] instead.
*/
class MigrationHelper
{
/**
* Returns whether a foreign key exists.
*
* @param string $tableName
* @param string|string[] $columns
* @return string|null The foreign key name, or null if it doesn't exist
* @since 3.0.27
*/
public static function findForeignKey(string $tableName, array|string $columns): ?string
{
return Db::findForeignKey($tableName, $columns);
}
/**
* Returns whether a foreign key exists.
*
* @param string $tableName
* @param string|string[] $columns
* @return bool
*/
public static function doesForeignKeyExist(string $tableName, array|string $columns): bool
{
return Db::findForeignKey($tableName, $columns) !== null;
}
/**
* Drops a foreign key if it exists.
*
* @param string $tableName
* @param string|string[] $columns
* @param Migration|null $migration
*/
public static function dropForeignKeyIfExists(string $tableName, array|string $columns, ?Migration $migration = null): void
{
if ($migration) {
$migration->dropForeignKeyIfExists($tableName, $columns);
} else {
Db::dropForeignKeyIfExists($tableName, $columns);
}
}
/**
* Returns whether an index exists.
*
* @param string $tableName
* @param string|string[] $columns
* @param bool $unique
* @param Connection|null $db
* @return bool
*/
public static function doesIndexExist(string $tableName, array|string $columns, bool $unique = false, ?Connection $db = null): bool
{
return Db::findIndex($tableName, $columns, $unique, $db) !== null;
}
/**
* Drops an index if it exists.
*
* @param string $tableName
* @param string|string[] $columns
* @param bool $unique
* @param Migration|null $migration
*/
public static function dropIndexIfExists(string $tableName, array|string $columns, bool $unique = false, ?Migration $migration = null): void
{
if ($migration) {
$migration->dropIndexIfExists($tableName, $columns, $unique);
} else {
Db::dropIndexIfExists($tableName, $columns, $unique);
}
}
/**
* Renames a table, while also updating its sequence, index, and FK names, as well as any other FK names pointing to the table.
*
* @param string $oldName
* @param string $newName
* @param Migration|null $migration
*/
public static function renameTable(string $oldName, string $newName, ?Migration $migration = null): void
{
if ($migration) {
$migration->renameTable($oldName, $newName);
} else {
Db::renameTable($oldName, $newName);
}
}
/**
* Renames a column, while also updating any index and FK names that use the column.
*
* @param string $tableName
* @param string $oldName
* @param string $newName
* @param Migration|null $migration
*/
public static function renameColumn(string $tableName, string $oldName, string $newName, ?Migration $migration = null): void
{
if ($migration) {
$migration->renameColumn($tableName, $oldName, $newName);
} else {
Craft::$app->getDb()->createCommand()
->renameColumn($tableName, $oldName, $newName)
->execute();
}
}
/**
* Returns a list of all the foreign keys that point to a given table/column.
*
* @param string $tableName The table the foreign keys should point to.
* @param string $column The column the foreign keys should point to. Defaults to 'id'.
* @return array A list of the foreign keys pointing to that table/column.
*/
public static function findForeignKeysTo(string $tableName, string $column = 'id'): array
{
$schema = Craft::$app->getDb()->getSchema();
$tableName = $schema->getRawTableName($tableName);
$allTables = $schema->getTableSchemas();
$fks = [];
foreach ($allTables as $otherTable) {
/** @var TableSchema $otherTable */
$counter = 0;
foreach ($otherTable->foreignKeys as $fk) {
if ($fk[0] === $tableName && in_array($column, $fk, true) !== false) {
$fk['updateType'] = $otherTable->getExtendedForeignKeys()[$counter]['updateType'];
$fk['deleteType'] = $otherTable->getExtendedForeignKeys()[$counter]['deleteType'];
$fks[$otherTable->name][] = $fk;
}
$counter++;
}
}
return $fks;
}
/**
* Drops a table, its own foreign keys, and any foreign keys referencing it.
*
* @param string $tableName
* @param Migration|null $migration
*/
public static function dropTable(string $tableName, ?Migration $migration = null): void
{
if ($migration !== null) {
$migration->dropAllForeignKeysToTable($tableName);
$migration->dropTable($tableName);
} else {
Db::dropAllForeignKeysToTable($tableName);
Craft::$app->getDb()->createCommand()
->dropTable($tableName)
->execute();
}
}
/**
* Drops all the foreign keys on a table.
*
* @param string $tableName
* @param Migration|null $migration
* @return array An array of the foreign keys that were just dropped.
*/
public static function dropAllForeignKeysOnTable(string $tableName, ?Migration $migration = null): array
{
$db = $migration ? $migration->db : Craft::$app->getDb();
$schema = $db->getSchema();
$schema->refresh();
$rawTableName = $schema->getRawTableName($tableName);
$table = $schema->getTableSchema($rawTableName);
$foreignKeys = [];
foreach ($table->foreignKeys as $fk) {
$columns = [];
foreach ($fk as $key => $value) {
if ($key !== 0) {
$columns[] = $key;
}
}
$foreignKeys[$rawTableName][] = $fk;
static::dropForeignKeyIfExists($tableName, $columns, $migration);
}
return $foreignKeys;
}
/**
* Drops all the foreign keys that reference a table.
*
* @param string $tableName
* @param Migration|null $migration
*/
public static function dropAllForeignKeysToTable(string $tableName, ?Migration $migration = null): void
{
if ($migration) {
$migration->dropAllForeignKeysToTable($tableName);
} else {
Db::dropAllForeignKeysToTable($tableName);
}
}
/**
* Drops a foreign key.
*
* @param string $tableName
* @param string|string[] $columns
* @param Migration|null $migration
*/
public static function dropForeignKey(string $tableName, array|string $columns, ?Migration $migration = null): void
{
$db = $migration ? $migration->db : Craft::$app->getDb();
$schema = $db->getSchema();
$tableName = $schema->getRawTableName($tableName);
$foreignKeyName = Db::findForeignKey($tableName, $columns);
if ($migration !== null) {
$migration->dropForeignKey($foreignKeyName, $tableName);
} else {
$db->createCommand()
->dropForeignKey($foreignKeyName, $tableName)
->execute();
}
}
/**
* Drops all the indexes on a table.
*
* @param string $tableName
* @param Migration|null $migration
*/
public static function dropAllIndexesOnTable(string $tableName, ?Migration $migration = null): void
{
$db = $migration ? $migration->db : Craft::$app->getDb();
$schema = $db->getSchema();
$allIndexes = $schema->findIndexes($tableName);
foreach ($allIndexes as $indexName => $index) {
self::_dropIndex($tableName, $indexName, $migration);
}
}
/**
* Drops all the unique indexes on a table.
*
* @param string $tableName
* @param Migration|null $migration
*/
public static function dropAllUniqueIndexesOnTable(string $tableName, ?Migration $migration = null): void
{
$db = $migration ? $migration->db : Craft::$app->getDb();
$allIndexes = $db->getSchema()->findIndexes($tableName);
foreach ($allIndexes as $indexName => $index) {
if ($index['unique']) {
self::_dropIndex($tableName, $indexName, $migration);
}
}
}
/**
* Drops an index.
*
* @param string $tableName
* @param string|string[] $columns
* @param bool $unique
* @param Migration|null $migration
*/
public static function dropIndex(string $tableName, array|string $columns, bool $unique = false, ?Migration $migration = null): void
{
static::dropIndexIfExists($tableName, $columns, $unique, $migration);
}
/**
* Restores an index.
*
* @param string $tableName
* @param string|string[] $columns
* @param bool $unique
* @param Migration|null $migration
*/
public static function restoreIndex(string $tableName, array|string $columns, bool $unique = false, ?Migration $migration = null): void
{
self::_createIndex($tableName, $columns, $unique, $migration);
}
/**
* Restores a foreign key.
*
* @param string $tableName
* @param string|string[] $columns
* @param string $refTable
* @param array $refColumns
* @param string $onUpdate
* @param string $onDelete
* @param Migration|null $migration
*/
public static function restoreForeignKey(string $tableName, array|string $columns, string $refTable, array $refColumns, string $onUpdate, string $onDelete, ?Migration $migration = null): void
{
self::_addForeignKey($tableName, $columns, $refTable, $refColumns, $onUpdate, $onDelete, $migration);
}
/**
* Restores a foreign key.
*
* @param string $tableName
* @param string|string[] $columns
* @param string $refTable
* @param array $refColumns
* @param string $onUpdate
* @param string $onDelete
* @param Migration|null $migration
*/
private static function _addForeignKey(string $tableName, array|string $columns, string $refTable, array $refColumns, string $onUpdate, string $onDelete, ?Migration $migration = null): void
{
$db = $migration ? $migration->db : Craft::$app->getDb();
$foreignKeyName = $db->getForeignKeyName();
if ($migration !== null) {
$migration->addForeignKey($foreignKeyName, $tableName, $columns, $refTable, $refColumns, $onDelete, $onUpdate);
} else {
$db->createCommand()
->addForeignKey($foreignKeyName, $tableName, $columns, $refTable, $refColumns, $onDelete, $onUpdate)
->execute();
}
}
/**
* Creates an index.
*
* @param string $tableName
* @param string|string[] $columns
* @param bool $unique
* @param Migration|null $migration
*/
private static function _createIndex(string $tableName, array|string $columns, bool $unique = false, ?Migration $migration = null): void
{
$db = $migration ? $migration->db : Craft::$app->getDb();
$indexName = $db->getIndexName();
if ($migration !== null) {
$migration->createIndex($indexName, $tableName, $columns, $unique);
} else {
$db->createCommand()
->createIndex($indexName, $tableName, $columns, $unique)
->execute();
}
}
/**
* Drops an index by its name.
*
* @param string $tableName
* @param string $indexName
* @param Migration|null $migration
*/
private static function _dropIndex(string $tableName, string $indexName, ?Migration $migration = null): void
{
if ($migration !== null) {
$migration->dropIndex($indexName, $tableName);
} else {
Craft::$app->getDb()->createCommand()
->dropIndex($indexName, $tableName)
->execute();
}
}
}