HCK-15551: improve view column comments (#330)

* use refDescription if present for view column references

* add refDescription for script generation options

* do not populate columnList for basic use-cases

Author: taras-dubyk

forward_engineering/config.json

@@ -561,13 +561,23 @@
 								"exist": false
 							},
 							{
-								"key": "description",
-								"exist": true
+								"type": "or",
+								"values": [
+									{
+										"key": "description",
+										"exist": true
+									},
+									{
+										"key": "refDescription",
+										"exist": true
+									}
+								]
 							}
 						]
 					},
 					"defaultValue": {
-						"description": ""
+						"description": "",
+						"refDescription": ""
 					},
 					"applyToValue": "ignore"
 				},
@@ -593,8 +603,17 @@
 								"exist": false
 							},
 							{
-								"key": "description",
-								"exist": true
+								"type": "or",
+								"values": [
+									{
+										"key": "description",
+										"exist": true
+									},
+									{
+										"key": "refDescription",
+										"exist": true
+									}
+								]
 							},
 							{
 								"type": "not",
@@ -609,7 +628,8 @@
 						]
 					},
 					"defaultValue": {
-						"description": ""
+						"description": "",
+						"refDescription": ""
 					},
 					"applyToValue": "separate"
 				}

forward_engineering/helpers/viewHelper.js

@@ -101,7 +101,7 @@ function getDefaultColumnList(properties) {
 		.reduce((columnList, [name, property]) => {
 			columnList.push({
 				name: `${prepareName(name)}`,
-				comment: property.description,
+				comment: property.refDescription || property.description,
 				isActivated: property.isActivated,
 			});
 

reverse_engineering/hqlToCollectionsVisitor.js

@@ -396,9 +396,6 @@ class Visitor extends HiveParserVisitor {
 		const { table } = this.visitWhenExists(ctx, 'selectStatementWithCTE', {});
 		const columns = this.visitWhenExists(ctx, 'columnNameCommentList', []);
 		const jsonSchema = convertColumnsToJsonSchema(columns);
-		const columnList = columns
-			.map(column => column.name + (column.comment ? ` COMMENT '${column.comment}'` : ''))
-			.join(', ');
 		const columnNames = columns.map(column => column.name).join(', ');
 		const tableProperties = this.visitWhenExists(ctx, 'tablePropertiesPrefixed');
 
@@ -413,7 +410,7 @@ class Visitor extends HiveParserVisitor {
 			data: {
 				description,
 				tableProperties,
-				columnList,
+				columnList: '',
 			},
 		};
 	}