Added ability to model deferrable FK constraints

Author: unknown

forward_engineering/ddlProvider/ddlHelpers/constraintsHelper.js

@@ -111,11 +111,29 @@ module.exports = ({
         );
     };
 
-    const additionalPropertiesForForeignKey = relationship => {
-        const foreignOnDelete = _.get(relationship, 'relationshipOnDelete', '');
-        const foreignOnUpdate = _.get(relationship, 'relationshipOnUpdate', '');
-        const foreignMatch = _.get(relationship, 'relationshipMatch', '');
-        return {foreignOnDelete, foreignOnUpdate, foreignMatch};
+    /**
+     * @param relationshipCustomProperties {{
+     *     relationshipOnDelete?: string,
+     *     relationshipOnUpdate?: string,
+     *     relationshipMatch?: string,
+     *     deferrable?: "" | "DEFERRABLE" | "NOT DEFERRABLE",
+     *     deferrableConstraintCheckTime?: "" | "INITIALLY IMMEDIATE" | "INITIALLY DEFERRED",
+     * }}
+     * @return {{
+     *     relationshipOnDelete: string,
+     *     relationshipOnUpdate: string,
+     *     relationshipMatch: string,
+     *     deferrable: string,
+     *     deferrableConstraintCheckTime: string,
+     * }}
+     * */
+    const additionalPropertiesForForeignKey = relationshipCustomProperties => {
+        const foreignOnDelete = _.get(relationshipCustomProperties, 'relationshipOnDelete', '');
+        const foreignOnUpdate = _.get(relationshipCustomProperties, 'relationshipOnUpdate', '');
+        const foreignMatch = _.get(relationshipCustomProperties, 'relationshipMatch', '');
+        const deferrable = _.get(relationshipCustomProperties, 'deferrable', '');
+        const deferrableConstraintCheckTime = _.get(relationshipCustomProperties, 'deferrableConstraintCheckTime', '');
+        return {foreignOnDelete, foreignOnUpdate, foreignMatch, deferrable, deferrableConstraintCheckTime};
     };
 
     return {

forward_engineering/ddlProvider/ddlProvider.js

@@ -329,6 +329,8 @@ module.exports = (baseProvider, options, app) => {
 		 *     relationshipOnDelete?: string,
 		 *     relationshipOnUpdate?: string,
 		 *     relationshipMatch?: string,
+		 *     deferrable?: "" | "DEFERRABLE" | "NOT DEFERRABLE",
+		 *     deferrableConstraintCheckTime?: "" | "INITIALLY IMMEDIATE" | "INITIALLY DEFERRED",
 		 * }}
 		 * @param primaryTableActivated {boolean}
 		 * @param foreignTableActivated {boolean}
@@ -376,7 +378,7 @@ module.exports = (baseProvider, options, app) => {
 				primaryTableActivated &&
 				foreignTableActivated;
 
-			const { foreignOnDelete, foreignOnUpdate, foreignMatch } =
+			const { foreignOnDelete, foreignOnUpdate, foreignMatch, deferrable, deferrableConstraintCheckTime } =
 				additionalPropertiesForForeignKey(customProperties);
 
 			const foreignKeyStatement = assignTemplates(templates.createForeignKeyConstraint, {
@@ -387,6 +389,9 @@ module.exports = (baseProvider, options, app) => {
 				onDelete: foreignOnDelete ? ` ON DELETE ${foreignOnDelete}` : '',
 				onUpdate: foreignOnUpdate ? ` ON UPDATE ${foreignOnUpdate}` : '',
 				match: foreignMatch ? ` MATCH ${foreignMatch}` : '',
+				deferrable: deferrable ? ` ${deferrable}` : '',
+				deferrableConstraintCheckTime: deferrable === 'DEFERRABLE' && deferrableConstraintCheckTime
+					? ` ${deferrableConstraintCheckTime}` : '',
 			});
 
 			return {
@@ -451,7 +456,7 @@ module.exports = (baseProvider, options, app) => {
 				primaryTableActivated &&
 				foreignTableActivated;
 
-			const { foreignOnDelete, foreignOnUpdate, foreignMatch } =
+			const { foreignOnDelete, foreignOnUpdate, foreignMatch, deferrable, deferrableConstraintCheckTime } =
 				additionalPropertiesForForeignKey(customProperties);
 
 			const foreignKeyStatement = assignTemplates(templates.createForeignKey, {
@@ -463,6 +468,9 @@ module.exports = (baseProvider, options, app) => {
 				onDelete: foreignOnDelete ? ` ON DELETE ${foreignOnDelete}` : '',
 				onUpdate: foreignOnUpdate ? ` ON UPDATE ${foreignOnUpdate}` : '',
 				match: foreignMatch ? ` MATCH ${foreignMatch}` : '',
+				deferrable: deferrable ? ` ${deferrable}` : '',
+				deferrableConstraintCheckTime: deferrable === 'DEFERRABLE' && deferrableConstraintCheckTime
+					? ` ${deferrableConstraintCheckTime}` : '',
 			});
 
 			return {

forward_engineering/ddlProvider/templates.js

@@ -20,7 +20,7 @@ module.exports = {
 
 	checkConstraint: '${name} CHECK (${expression})${noInherit}',
 
-	createForeignKeyConstraint: '${name} FOREIGN KEY (${foreignKey}) REFERENCES ${primaryTable} (${primaryKey})${match}${onDelete}${onUpdate}',
+	createForeignKeyConstraint: '${name} FOREIGN KEY (${foreignKey}) REFERENCES ${primaryTable} (${primaryKey})${match}${onDelete}${onUpdate}${deferrable}${deferrableConstraintCheckTime}',
 
 	createKeyConstraint: '${constraintName}${keyType}${columns}${includeNonKey}${storageParameters}${tablespace}',
 
@@ -37,7 +37,7 @@ module.exports = {
 	dropConstraint: 'ALTER TABLE IF EXISTS ${tableName} DROP CONSTRAINT IF EXISTS ${constraintName};',
 
 	createForeignKey:
-		'ALTER TABLE IF EXISTS ${foreignTable} ADD CONSTRAINT ${name} FOREIGN KEY (${foreignKey}) REFERENCES ${primaryTable}(${primaryKey})${match}${onDelete}${onUpdate};',
+		'ALTER TABLE IF EXISTS ${foreignTable} ADD CONSTRAINT ${name} FOREIGN KEY (${foreignKey}) REFERENCES ${primaryTable}(${primaryKey})${match}${onDelete}${onUpdate}${deferrable}${deferrableConstraintCheckTime};',
 
 	dropForeignKey: 'ALTER TABLE ${tableName} DROP CONSTRAINT ${fkConstraintName};',