Merge pull request #77 from ArzamastsevVladyslav/feature/generated-columns

Sasha · web-flow · commit d7e90aa95484 · 2023-11-23T15:44:06.000+02:00
Feature/generated columns
diff --git a/forward_engineering/alterScript/alterScriptFromDeltaHelper.js b/forward_engineering/alterScript/alterScriptFromDeltaHelper.js
@@ -120,7 +120,7 @@ const getAlterCollectionsScriptDtos = ({
         .filter(Boolean)
         .map(item => Object.values(item.properties)[0])
         .filter(collection => !collection.compMod)
-        .flatMap(getModifyColumnScriptDtos(app));
+        .flatMap(getModifyColumnScriptDtos({app, dbVersion, modelDefinitions, internalDefinitions, externalDefinitions}));
 
     return [
         ...createCollectionsScriptDtos,
diff --git a/forward_engineering/alterScript/alterScriptHelpers/alterEntityHelper.js b/forward_engineering/alterScript/alterScriptHelpers/alterEntityHelper.js
@@ -89,53 +89,63 @@ const getModifyCollectionScriptDtos = (app) => (collection) => {
     ].filter(Boolean);
 }
 
+/**
+ * @return {(collection: Object, predicate: ([name: string, jsonSchema: Object]) => boolean) => AlterScriptDto[]}
+ * */
+const getAddColumnsByConditionScriptDtos =  ({app, dbVersion, modelDefinitions, internalDefinitions, externalDefinitions}) =>
+    (collection, predicate) => {
+        const _ = app.require('lodash');
+        const {getEntityName, getNamePrefixedWithSchemaName} = require('../../utils/general')(_);
+        const {createColumnDefinitionBySchema} = require('./createColumnDefinition')(app);
+        const ddlProvider = require('../../ddlProvider/ddlProvider')(null, null, app);
+        const {getDefinitionByReference} = app.require('@hackolade/ddl-fe-utils');
+
+        const collectionSchema = {...collection, ...(_.omit(collection?.role, 'properties') || {})};
+        const tableName = getEntityName(collectionSchema);
+        const schemaName = collectionSchema.compMod?.keyspaceName;
+        const fullName = getNamePrefixedWithSchemaName(tableName, schemaName);
+        const schemaData = {schemaName, dbVersion};
+
+        return _.toPairs(collection.properties)
+            .filter(([name, jsonSchema]) => predicate([name, jsonSchema]))
+            .map(([name, jsonSchema]) => {
+                const definitionJsonSchema = getDefinitionByReference({
+                    propertySchema: jsonSchema,
+                    modelDefinitions,
+                    internalDefinitions,
+                    externalDefinitions,
+                });
+
+                return createColumnDefinitionBySchema({
+                    name,
+                    jsonSchema,
+                    parentJsonSchema: collectionSchema,
+                    ddlProvider,
+                    schemaData,
+                    definitionJsonSchema,
+                });
+            })
+            .map(ddlProvider.convertColumnDefinition)
+            .map(columnDefinition => ddlProvider.addColumn(fullName, columnDefinition))
+            .map(addColumnScript => AlterScriptDto.getInstance([addColumnScript], true, false))
+            .filter(Boolean);
+    };
+
 /**
  * @return {(collection: Object) => AlterScriptDto[]}
  * */
 const getAddColumnScriptDtos =
     ({app, dbVersion, modelDefinitions, internalDefinitions, externalDefinitions}) =>
         collection => {
-            const _ = app.require('lodash');
-            const {getEntityName, getNamePrefixedWithSchemaName} = require('../../utils/general')(_);
-            const {createColumnDefinitionBySchema} = require('./createColumnDefinition')(app);
-            const ddlProvider = require('../../ddlProvider/ddlProvider')(null, null, app);
-            const {getDefinitionByReference} = app.require('@hackolade/ddl-fe-utils');
-
-            const collectionSchema = {...collection, ...(_.omit(collection?.role, 'properties') || {})};
-            const tableName = getEntityName(collectionSchema);
-            const schemaName = collectionSchema.compMod?.keyspaceName;
-            const fullName = getNamePrefixedWithSchemaName(tableName, schemaName);
-            const schemaData = {schemaName, dbVersion};
-
-            return _.toPairs(collection.properties)
-                .filter(([name, jsonSchema]) => !jsonSchema.compMod)
-                .map(([name, jsonSchema]) => {
-                    const definitionJsonSchema = getDefinitionByReference({
-                        propertySchema: jsonSchema,
-                        modelDefinitions,
-                        internalDefinitions,
-                        externalDefinitions,
-                    });
-
-                    return createColumnDefinitionBySchema({
-                        name,
-                        jsonSchema,
-                        parentJsonSchema: collectionSchema,
-                        ddlProvider,
-                        schemaData,
-                        definitionJsonSchema,
-                    });
-                })
-                .map(ddlProvider.convertColumnDefinition)
-                .map(columnDefinition => ddlProvider.addColumn(fullName, columnDefinition))
-                .map(addColumnScript => AlterScriptDto.getInstance([addColumnScript], true, false))
-                .filter(Boolean);
-        };
+            return getAddColumnsByConditionScriptDtos({
+                app, dbVersion, modelDefinitions, internalDefinitions, externalDefinitions
+            })(collection, ([name, jsonSchema]) => !jsonSchema.compMod);
+        }
 
 /**
- * @return {(collection: Object) => AlterScriptDto[]}
+ * @return {(collection: Object, predicate: ([name: string, jsonSchema: Object]) => boolean) => AlterScriptDto[]}
  * */
-const getDeleteColumnScriptDtos = app => collection => {
+const getDeleteColumnsByConditionScriptDtos = app => (collection, predicate) => {
     const _ = app.require('lodash');
     const ddlProvider = require('../../ddlProvider/ddlProvider')(null, null, app);
     const {getEntityName, getNamePrefixedWithSchemaName, wrapInQuotes} = require('../../utils/general')(_);
@@ -146,7 +156,7 @@ const getDeleteColumnScriptDtos = app => collection => {
     const fullTableName = getNamePrefixedWithSchemaName(tableName, schemaName);
 
     return _.toPairs(collection.properties)
-        .filter(([name, jsonSchema]) => !jsonSchema.compMod)
+        .filter(([name, jsonSchema]) => predicate([name, jsonSchema]))
         .map(([name]) => {
             const columnNameForDDL = wrapInQuotes(name);
             return ddlProvider.dropColumn(fullTableName, columnNameForDDL)
@@ -158,11 +168,66 @@ const getDeleteColumnScriptDtos = app => collection => {
 /**
  * @return {(collection: Object) => AlterScriptDto[]}
  * */
-const getModifyColumnScriptDtos = app => collection => {
+const getDeleteColumnScriptDtos = app => collection => {
+    return getDeleteColumnsByConditionScriptDtos(app)(collection, ([name, jsonSchema]) => !jsonSchema.compMod)
+};
+
+/**
+ * @return {(collection: Object) => Array<AlterScriptDto>}
+ * */
+const getDropAndRecreateColumnsScriptDtos = ({app, dbVersion, modelDefinitions, internalDefinitions, externalDefinitions}) =>
+    (collection) => {
+        const _ = app.require('lodash');
+
+        return _.toPairs(collection.properties)
+            .filter(([name, jsonSchema]) => {
+                const oldName = jsonSchema.compMod.oldField.name;
+                const oldProperty = collection.role.properties[oldName];
+
+                const didGeneratedColumnChange = oldProperty.generatedColumn !== jsonSchema.generatedColumn
+                    || oldProperty.columnGenerationExpression !== jsonSchema.columnGenerationExpression;
+                // all conditions that require drop-and-recreate go here
+                return didGeneratedColumnChange;
+            })
+            .flatMap(([name, jsonSchema]) => {
+                const collectionWithJustThisProperty = {
+                    ...collection,
+                    properties: _.fromPairs([
+                        [name, jsonSchema]
+                    ]),
+                }
+                const deleteColumnsScriptDtos = getDeleteColumnsByConditionScriptDtos(app)(collectionWithJustThisProperty, () => true);
+                const addColumnsScriptDtos = getAddColumnsByConditionScriptDtos({
+                    app, dbVersion, modelDefinitions, internalDefinitions, externalDefinitions
+                })(collectionWithJustThisProperty, () => true);
+
+                return [
+                    ...deleteColumnsScriptDtos,
+                    ...addColumnsScriptDtos,
+                ]
+            })
+            .filter(Boolean);
+    }
+
+/**
+ * @return {(collection: Object) => AlterScriptDto[]}
+ * */
+const getModifyColumnScriptDtos = (
+    {app, dbVersion, modelDefinitions, internalDefinitions, externalDefinitions}
+) => collection => {
     const _ = app.require('lodash');
     const ddlProvider = require('../../ddlProvider/ddlProvider')(null, null, app);
 
     const renameColumnScriptDtos = getRenameColumnScriptDtos(_, ddlProvider)(collection);
+
+    const dropAndRecreateScriptDtos = getDropAndRecreateColumnsScriptDtos({app, dbVersion, modelDefinitions, internalDefinitions, externalDefinitions})(collection);
+    if (dropAndRecreateScriptDtos.length) {
+        return [
+            ...renameColumnScriptDtos,
+            ...dropAndRecreateScriptDtos,
+        ].filter(Boolean);
+    }
+
     const updateTypeScriptDtos = getUpdateTypesScriptDtos(_, ddlProvider)(collection);
     const modifyNotNullScriptDtos = getModifyNonNullColumnsScriptDtos(_, ddlProvider)(collection);
     const modifyCommentScriptDtos = getModifiedCommentOnColumnScriptDtos(_, ddlProvider)(collection);
diff --git a/forward_engineering/ddlProvider/ddlProvider.js b/forward_engineering/ddlProvider/ddlProvider.js
@@ -258,11 +258,17 @@ module.exports = (baseProvider, options, app) => {
 			const defaultValue = !_.isUndefined(columnDefinition.default)
 				? ' DEFAULT ' + decorateDefault(type, columnDefinition.default, isArrayType)
 				: '';
+			const generatedColumnClause = columnDefinition.generatedColumn && columnDefinition.columnGenerationExpression
+				? assignTemplates(templates.generatedColumnClause, {
+					generationExpression: columnDefinition.columnGenerationExpression,
+				})
+				: '';
 
 			return commentIfDeactivated(
 				assignTemplates(templates.columnDefinition, {
 					name: wrapInQuotes(columnDefinition.name),
 					type: decorateType(type, columnDefinition),
+					generatedColumnClause,
 					notNull,
 					primaryKey,
 					uniqueKey,
@@ -670,6 +676,8 @@ module.exports = (baseProvider, options, app) => {
 				timezone,
 				intervalOptions,
 				dbVersion,
+				generatedColumn: Boolean(jsonSchema.generatedColumn),
+				columnGenerationExpression: jsonSchema.columnGenerationExpression,
 			};
 		},
 
diff --git a/forward_engineering/ddlProvider/templates.js b/forward_engineering/ddlProvider/templates.js
@@ -16,7 +16,9 @@ module.exports = {
 		'${partitionOf} ${openParenthesis}${keyConstraints}${checkConstraints}${foreignKeyConstraints}\n' +
 		'${closeParenthesis}${options};\n\n${comment}${columnDescriptions}',
 
-	columnDefinition: '${name} ${type}${collation}${primaryKey}${uniqueKey}${defaultValue}${notNull}',
+	generatedColumnClause: ' GENERATED ALWAYS AS (${generationExpression}) STORED',
+
+	columnDefinition: '${name} ${type}${collation}${generatedColumnClause}${primaryKey}${uniqueKey}${defaultValue}${notNull}',
 
 	checkConstraint: '${name} CHECK (${expression})${noInherit}',
 
diff --git a/properties_pane/field_level/fieldLevelConfig.json b/properties_pane/field_level/fieldLevelConfig.json
