Skip to content

Commit

Permalink
Merge pull request #370 from HugoPoi/feature/foreign-key-on-config
Browse files Browse the repository at this point in the history
Feature add foreign key on update on delete trigger config
  • Loading branch information
jannyHou committed Apr 26, 2019
2 parents 7aec25b + 24fe635 commit 6218665
Show file tree
Hide file tree
Showing 3 changed files with 399 additions and 93 deletions.
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -432,7 +432,9 @@ Example:
"name": "authorId",
"foreignKey": "authorId",
"entityKey": "aId",
"entity": "Author"
"entity": "Author",
"onUpdate": "restrict",
"onDelete": "restrict"
}
}
}
Expand Down
123 changes: 83 additions & 40 deletions lib/migration.js
Expand Up @@ -37,6 +37,35 @@ function mixinMigration(MySQL, mysql) {
});
};

MySQL.prototype.getConstraintTrigger = function(model, actualFks, cb) {
var table = this.tableEscaped(model);
var sql = 'SHOW CREATE TABLE ' + table;
this.execute(sql, function(err, createTable) {
if (err) {
return cb(err);
} else {
var matchConstraint = new RegExp('CONSTRAINT `([^`]+)` FOREIGN KEY \\(`([^`]+)`\\)' +
' REFERENCES `([^`]+)` \\(`([^`]+)`\\)' +
'(?: ON DELETE (RESTRICT|CASCADE|SET NULL|NO ACTION|SET DEFAULT))?' +
'(?: ON UPDATE (RESTRICT|CASCADE|SET NULL|NO ACTION|SET DEFAULT))?', 'g');
var rawConstraints = [];
do {
var match = matchConstraint.exec(createTable[0]['Create Table']);
if (match) {
actualFks.forEach(function(fk) {
if (fk.fkName === match[1]) {
fk.onDelete = match[5] ? match[5].toLowerCase() : 'restrict';
fk.onUpdate = match[6] ? match[6].toLowerCase() : 'restrict';
}
});
rawConstraints.push(match);
}
} while (match != null);
cb(err, rawConstraints);
}
});
};

/**
* Perform autoupdate for the given models
* @param {String[]} [models] A model name or an array of model names.
Expand Down Expand Up @@ -69,35 +98,36 @@ function mixinMigration(MySQL, mysql) {
self.discoverForeignKeys(self.table(model), {}, function(err, foreignKeys) {
if (err) console.log('Failed to discover "' + self.table(model) +
'" foreign keys', err);

if (!err && fields && fields.length) {
// if we already have a definition, update this table
self.alterTable(model, fields, indexes, foreignKeys, function(err, result) {
if (!err) {
// foreignKeys is a list of EXISTING fkeys here, so you don't need to recreate them again
// prepare fkSQL for new foreign keys
var fkSQL = self.getForeignKeySQL(model,
self.getModelDefinition(model).settings.foreignKeys,
foreignKeys);
self.addForeignKeys(model, fkSQL, function(err, result) {
self.getConstraintTrigger(model, foreignKeys, function(err) {
if (!err && fields && fields.length) {
// if we already have a definition, update this table
self.alterTable(model, fields, indexes, foreignKeys, function(err, result) {
if (!err) {
// foreignKeys is a list of EXISTING fkeys here, so you don't need to recreate them again
// prepare fkSQL for new foreign keys
var fkSQL = self.getForeignKeySQL(model,
self.getModelDefinition(model).settings.foreignKeys,
foreignKeys);
self.addForeignKeys(model, fkSQL, function(err, result) {
done(err);
});
} else {
done(err);
});
} else {
done(err);
}
});
} else {
// if there is not yet a definition, create this table
self.createTable(model, function(err) {
if (!err) {
self.addForeignKeys(model, function(err, result) {
}
});
} else {
// if there is not yet a definition, create this table
self.createTable(model, function(err) {
if (!err) {
self.addForeignKeys(model, function(err, result) {
done(err);
});
} else {
done(err);
});
} else {
done(err);
}
});
}
}
});
}
});
});
});
}, function(err) {
Expand Down Expand Up @@ -147,15 +177,16 @@ function mixinMigration(MySQL, mysql) {
self.discoverForeignKeys(self.table(model), {}, function(err, foreignKeys) {
if (err) console.log('Failed to discover "' + self.table(model) +
'" foreign keys', err);

self.alterTable(model, fields, indexes, foreignKeys, function(err, needAlter) {
if (err) {
return done(err);
} else {
ok = ok || needAlter;
done(err);
}
}, true);
self.getConstraintTrigger(model, foreignKeys, function(err) {
self.alterTable(model, fields, indexes, foreignKeys, function(err, needAlter) {
if (err) {
return done(err);
} else {
ok = ok || needAlter;
done(err);
}
}, true);
});
});
});
}, function(err) {
Expand Down Expand Up @@ -279,6 +310,8 @@ function mixinMigration(MySQL, mysql) {
if (indexName === 'PRIMARY' ||
(m.properties[indexName] && self.id(model, indexName))) return;

if (m.settings.foreignKeys && m.settings.foreignKeys[indexName]) return;

if (indexNames.indexOf(indexName) === -1 && !m.properties[indexName] ||
m.properties[indexName] && !m.properties[indexName].index) {
sql.push('DROP INDEX ' + self.client.escapeId(indexName));
Expand Down Expand Up @@ -331,19 +364,20 @@ function mixinMigration(MySQL, mysql) {
if (!found) {
var colName = expectedColNameForModel(propName, m);
var pName = self.client.escapeId(colName);
var indexName = self.client.escapeId(propName);
var type = '';
var kind = '';
if (i.type) {
type = 'USING ' + i.type;
}
if (kind && type) {
sql.push('ADD ' + kind + ' INDEX ' + pName +
sql.push('ADD ' + kind + ' INDEX ' + indexName +
' (' + pName + ') ' + type);
} else {
if (typeof i === 'object' && i.unique && i.unique === true) {
kind = 'UNIQUE';
}
sql.push('ADD ' + kind + ' INDEX ' + pName + ' ' + type +
sql.push('ADD ' + kind + ' INDEX ' + indexName + ' ' + type +
' (' + pName + ') ');
}
}
Expand Down Expand Up @@ -466,7 +500,9 @@ function mixinMigration(MySQL, mysql) {
var fkRefTable = self.table(fkEntityName);
needsToDrop = fkCol != fk.fkColumnName ||
fkRefKey != fk.pkColumnName ||
fkRefTable != fk.pkTableName;
fkRefTable != fk.pkTableName ||
(newFk.onDelete || 'restrict') != fk.onDelete ||
(newFk.onUpdate || 'restrict') != fk.onUpdate;
} else {
needsToDrop = true;
}
Expand Down Expand Up @@ -561,10 +597,17 @@ function mixinMigration(MySQL, mysql) {

// verify that the other model in the same DB
if (this._models[fkEntityName]) {
return ' CONSTRAINT ' + this.client.escapeId(fk.name) +
var constraint = ' CONSTRAINT ' + this.client.escapeId(fk.name) +
' FOREIGN KEY (`' + expectedColNameForModel(fk.foreignKey, definition) + '`)' +
' REFERENCES ' + this.tableEscaped(fkEntityName) +
'(' + this.client.escapeId(fk.entityKey) + ')';
if (fk.onDelete) {
constraint += ' ON DELETE ' + fk.onDelete.toUpperCase();
}
if (fk.onUpdate) {
constraint += ' ON UPDATE ' + fk.onUpdate.toUpperCase();
}
return constraint;
}
}
return '';
Expand Down

0 comments on commit 6218665

Please sign in to comment.