Skip to content

Commit 70a449f

Browse files
cebecebe
authored
Fix cebe#168: Cannot define index on relation #35 (cebe#171)
Fix cebe#168 Failing test: https://github.com/cebe/yii2-openapi/pull/169/files PR in fork: SOHELAHMED7#35 Also add other enhancements and fix bugs related to [index and foreign key order](https://stackoverflow.com/a/8482400) in migrations.
2 parents e5b0ccd + 40892a2 commit 70a449f

33 files changed

+667
-42
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ Allow to set foreign key constraint in migrations for ON UPDATE event of row in
285285

286286
### `x-fk-column-name`
287287

288-
Provide custom column name in case of relationship column. Example:
288+
Provide custom database table column name in case of relationship column. This will not reflect in models relations, faker etc. Example:
289289

290290
```yaml
291291
components:

‎src/lib/AttributeResolver.php‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -436,10 +436,30 @@ protected function prepareIndexes(array $indexes):array
436436
}
437437
$props = array_map('trim', explode(',', trim($props)));
438438
$columns = [];
439+
$xFkColumnNames = [];
440+
foreach ($this->attributes as $key => $value) {
441+
if (!empty($value->fkColName)) {
442+
$xFkColumnNames[$value->fkColName] = $key;
443+
}
444+
}
439445
foreach ($props as $prop) {
446+
// for more info see test tests/specs/fk_col_name/fk_col_name.yaml
447+
// File: ForeignKeyColumnNameTest::testIndexForColumnWithCustomName
448+
// first check direct column names
440449
if (!isset($this->attributes[$prop])) {
441-
throw new InvalidDefinitionException('Invalid index definition - property ' . $prop
442-
. ' not declared');
450+
// then check x-fk-column-name
451+
if (!in_array($prop, array_keys($xFkColumnNames))) {
452+
// then check relations/reference e.g. `user`/`user_id`
453+
$refPropName = (substr($prop, -3) === '_id') ? rtrim($prop, '_id') : null;
454+
if ($refPropName && !isset($this->attributes[$refPropName])) {
455+
throw new InvalidDefinitionException('Invalid index definition - property ' . $prop
456+
. ' not declared');
457+
} else {
458+
$prop = $refPropName;
459+
}
460+
} else {
461+
$prop = $xFkColumnNames[$prop];
462+
}
443463
}
444464
$columns[] = $this->attributes[$prop]->columnName;
445465
}

‎src/lib/FakerStubResolver.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public function resolve():?string
6262
}
6363

6464
// column name ends with `_id`
65-
if (substr($this->attribute->columnName, -strlen('_id'))==='_id') {
65+
if (substr($this->attribute->columnName, -3) === '_id' || !empty($this->attribute->fkColName)) {
6666
$config = $this->config;
6767
if (!$config) {
6868
$config = new Config;

‎src/lib/migrations/BaseMigrationBuilder.php‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,14 @@ public function buildFresh():MigrationModel
141141
$this->migration->addUpCode($builder->addPrimaryKey($tableName, $this->model->junctionCols))
142142
->addDownCode($builder->dropPrimaryKey($tableName, $this->model->junctionCols));
143143
}
144+
145+
foreach ($this->model->indexes as $index) {
146+
$upCode = $index->isUnique ? $builder->addUniqueIndex($tableName, $index->name, $index->columns)
147+
: $builder->addIndex($tableName, $index->name, $index->columns, $index->type);
148+
$this->migration->addUpCode($upCode)
149+
->addDownCode($builder->dropIndex($tableName, $index->name));
150+
}
151+
144152
foreach ($this->model->getHasOneRelations() as $relation) {
145153
$fkCol = $relation->getColumnName();
146154
$refCol = $relation->getForeignName();
@@ -153,13 +161,6 @@ public function buildFresh():MigrationModel
153161
}
154162
}
155163

156-
foreach ($this->model->indexes as $index) {
157-
$upCode = $index->isUnique ? $builder->addUniqueIndex($tableName, $index->name, $index->columns)
158-
: $builder->addIndex($tableName, $index->name, $index->columns, $index->type);
159-
$this->migration->addUpCode($upCode)
160-
->addDownCode($builder->dropIndex($tableName, $index->name));
161-
}
162-
163164
return $this->migration;
164165
}
165166

@@ -211,14 +212,14 @@ function (string $unknownColumn) {
211212
}
212213
$this->buildColumnChanges($current, $desired, $changedAttributes);
213214
}
215+
if (!$relation) {
216+
$this->buildIndexChanges();
217+
}
214218
if ($relation) {
215219
$this->buildRelationsForJunction($relation);
216220
} else {
217221
$this->buildRelations();
218222
}
219-
if (!$relation) {
220-
$this->buildIndexChanges();
221-
}
222223
return $this->migration;
223224
}
224225

‎src/lib/migrations/MigrationRecordBuilder.php‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ final class MigrationRecordBuilder
2424
public const DROP_FK = MigrationRecordBuilder::INDENT . "\$this->dropForeignKey('%s', '%s');";
2525
public const DROP_PK = MigrationRecordBuilder::INDENT . "\$this->dropPrimaryKey('%s', '%s');";
2626
public const ADD_TABLE = MigrationRecordBuilder::INDENT . "\$this->createTable('%s', %s);";
27-
public const ADD_UNIQUE = MigrationRecordBuilder::INDENT . "\$this->createIndex('%s', '%s', '%s', true);";
28-
public const ADD_INDEX = MigrationRecordBuilder::INDENT . "\$this->createIndex('%s', '%s', '%s', %s);";
27+
public const ADD_UNIQUE = MigrationRecordBuilder::INDENT . "\$this->createIndex('%s', '%s', %s, true);";
28+
public const ADD_INDEX = MigrationRecordBuilder::INDENT . "\$this->createIndex('%s', '%s', %s, %s);";
2929
public const DROP_COLUMN = MigrationRecordBuilder::INDENT . "\$this->dropColumn('%s', '%s');";
3030
public const ADD_ENUM = MigrationRecordBuilder::INDENT . "\$this->execute('CREATE TYPE \"enum_%s_%s\" AS ENUM(%s)');";
3131
public const DROP_ENUM = MigrationRecordBuilder::INDENT . "\$this->execute('DROP TYPE \"enum_%s_%s\"');";
@@ -231,13 +231,24 @@ public function addFk(string $fkName, string $tableAlias, string $fkCol, string
231231

232232
public function addUniqueIndex(string $tableAlias, string $indexName, array $columns):string
233233
{
234-
return sprintf(self::ADD_UNIQUE, $indexName, $tableAlias, implode(',', $columns));
234+
return sprintf(
235+
self::ADD_UNIQUE,
236+
$indexName,
237+
$tableAlias,
238+
count($columns) === 1 ? "'{$columns[0]}'" : '["'.implode('", "', $columns).'"]'
239+
);
235240
}
236241

237242
public function addIndex(string $tableAlias, string $indexName, array $columns, ?string $using = null):string
238243
{
239244
$indexType = $using === null ? 'false' : "'".ColumnToCode::escapeQuotes($using)."'";
240-
return sprintf(self::ADD_INDEX, $indexName, $tableAlias, implode(',', $columns), $indexType);
245+
return sprintf(
246+
self::ADD_INDEX,
247+
$indexName,
248+
$tableAlias,
249+
count($columns) === 1 ? "'{$columns[0]}'" : '["'.implode('", "', $columns).'"]',
250+
$indexType
251+
);
241252
}
242253

243254
public function addPrimaryKey(string $tableAlias, array $columns, string $pkName= null):string

‎tests/specs/blog/migrations/m200000_000001_create_table_users.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public function up()
1818
]);
1919
$this->createIndex('users_username_key', '{{%users}}', 'username', true);
2020
$this->createIndex('users_email_key', '{{%users}}', 'email', true);
21-
$this->createIndex('users_role_flags_index', '{{%users}}', 'role,flags', false);
21+
$this->createIndex('users_role_flags_index', '{{%users}}', ["role", "flags"], false);
2222
}
2323

2424
public function down()

‎tests/specs/blog/migrations/m200000_000002_create_table_blog_posts.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ public function up()
1717
'created_by_id' => $this->integer()->null()->defaultValue(null),
1818
]);
1919
$this->addPrimaryKey('pk_blog_posts_uid', '{{%blog_posts}}', 'uid');
20-
$this->addForeignKey('fk_blog_posts_category_id_categories_id', '{{%blog_posts}}', 'category_id', '{{%categories}}', 'id');
21-
$this->addForeignKey('fk_blog_posts_created_by_id_users_id', '{{%blog_posts}}', 'created_by_id', '{{%users}}', 'id');
2220
$this->createIndex('blog_posts_title_key', '{{%blog_posts}}', 'title', true);
2321
$this->createIndex('blog_posts_slug_key', '{{%blog_posts}}', 'slug', true);
22+
$this->addForeignKey('fk_blog_posts_category_id_categories_id', '{{%blog_posts}}', 'category_id', '{{%categories}}', 'id');
23+
$this->addForeignKey('fk_blog_posts_created_by_id_users_id', '{{%blog_posts}}', 'created_by_id', '{{%users}}', 'id');
2424
}
2525

2626
public function down()
2727
{
28-
$this->dropIndex('blog_posts_slug_key', '{{%blog_posts}}');
29-
$this->dropIndex('blog_posts_title_key', '{{%blog_posts}}');
3028
$this->dropForeignKey('fk_blog_posts_created_by_id_users_id', '{{%blog_posts}}');
3129
$this->dropForeignKey('fk_blog_posts_category_id_categories_id', '{{%blog_posts}}');
30+
$this->dropIndex('blog_posts_slug_key', '{{%blog_posts}}');
31+
$this->dropIndex('blog_posts_title_key', '{{%blog_posts}}');
3232
$this->dropPrimaryKey('pk_blog_posts_uid', '{{%blog_posts}}');
3333
$this->dropTable('{{%blog_posts}}');
3434
}

‎tests/specs/blog/migrations_maria_db/m200000_000001_create_table_users.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public function up()
1818
]);
1919
$this->createIndex('users_username_key', '{{%users}}', 'username', true);
2020
$this->createIndex('users_email_key', '{{%users}}', 'email', true);
21-
$this->createIndex('users_role_flags_index', '{{%users}}', 'role,flags', false);
21+
$this->createIndex('users_role_flags_index', '{{%users}}', ["role", "flags"], false);
2222
}
2323

2424
public function down()

‎tests/specs/blog/migrations_maria_db/m200000_000002_create_table_blog_posts.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ public function up()
1717
'created_by_id' => $this->integer()->null()->defaultValue(null),
1818
]);
1919
$this->addPrimaryKey('pk_blog_posts_uid', '{{%blog_posts}}', 'uid');
20-
$this->addForeignKey('fk_blog_posts_category_id_categories_id', '{{%blog_posts}}', 'category_id', '{{%categories}}', 'id');
21-
$this->addForeignKey('fk_blog_posts_created_by_id_users_id', '{{%blog_posts}}', 'created_by_id', '{{%users}}', 'id');
2220
$this->createIndex('blog_posts_title_key', '{{%blog_posts}}', 'title', true);
2321
$this->createIndex('blog_posts_slug_key', '{{%blog_posts}}', 'slug', true);
22+
$this->addForeignKey('fk_blog_posts_category_id_categories_id', '{{%blog_posts}}', 'category_id', '{{%categories}}', 'id');
23+
$this->addForeignKey('fk_blog_posts_created_by_id_users_id', '{{%blog_posts}}', 'created_by_id', '{{%users}}', 'id');
2424
}
2525

2626
public function down()
2727
{
28-
$this->dropIndex('blog_posts_slug_key', '{{%blog_posts}}');
29-
$this->dropIndex('blog_posts_title_key', '{{%blog_posts}}');
3028
$this->dropForeignKey('fk_blog_posts_created_by_id_users_id', '{{%blog_posts}}');
3129
$this->dropForeignKey('fk_blog_posts_category_id_categories_id', '{{%blog_posts}}');
30+
$this->dropIndex('blog_posts_slug_key', '{{%blog_posts}}');
31+
$this->dropIndex('blog_posts_title_key', '{{%blog_posts}}');
3232
$this->dropPrimaryKey('pk_blog_posts_uid', '{{%blog_posts}}');
3333
$this->dropTable('{{%blog_posts}}');
3434
}

‎tests/specs/blog/migrations_mysql_db/m200000_000001_create_table_users.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public function up()
1818
]);
1919
$this->createIndex('users_username_key', '{{%users}}', 'username', true);
2020
$this->createIndex('users_email_key', '{{%users}}', 'email', true);
21-
$this->createIndex('users_role_flags_index', '{{%users}}', 'role,flags', false);
21+
$this->createIndex('users_role_flags_index', '{{%users}}', ["role", "flags"], false);
2222
}
2323

2424
public function down()

0 commit comments

Comments
 (0)