Skip to content

Feature/generated columns #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
5 commits merged into from
Nov 23, 2023
Merged

Feature/generated columns #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
510125b
- Added "generated"-related stuff on PP
Nov 23, 2023
81986b3
- Added FE for generated columns
Nov 23, 2023
d5df0bc
Added ability to modify generated columns
Nov 23, 2023
cfae34f
Fixed drop-and-recreate related problems
Nov 23, 2023
cb2caa9
Removed obsolete function
Nov 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion forward_engineering/alterScript/alterScriptFromDeltaHelper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
145 changes: 105 additions & 40 deletions forward_engineering/alterScript/alterScriptHelpers/alterEntityHelper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')(_);
Expand All @@ -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)
Expand All @@ -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);
Expand Down
8 changes: 8 additions & 0 deletions forward_engineering/ddlProvider/ddlProvider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -670,6 +676,8 @@ module.exports = (baseProvider, options, app) => {
timezone,
intervalOptions,
dbVersion,
generatedColumn: Boolean(jsonSchema.generatedColumn),
columnGenerationExpression: jsonSchema.columnGenerationExpression,
};
},

Expand Down
4 changes: 3 additions & 1 deletion forward_engineering/ddlProvider/templates.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}',

Expand Down
Loading