Skip to content

Commit 3b88ca1

Browse files
jung-thomasjung-thomas
committed
Finish #83 - Add view parameter support
1 parent cf2fc98 commit 3b88ca1

File tree

5 files changed

+231
-17
lines changed

5 files changed

+231
-17
lines changed

‎CHANGELOG.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
"date": "2023-08-25",
44
"version": "3.202308.1",
55
"Changed": [
6-
"Major CAP version 7.1.2",
6+
"[CAP version 7.1.2](https://cap.cloud.sap/docs/releases/jul23)",
77
"Fixed Web Socket Error Handling",
8-
"Upgrade to SAPUI5 1.117.1"
8+
"Upgrade to [SAPUI5 1.117.1](https://sapui5.hana.ondemand.com/#/topic/029d3b4a39c84384be6398c444f7e06a)",
9+
"Fix [Issue #111](https://github.com/SAP-samples/hana-developer-cli-tool-example/issues/111) - add checks on container and group names for createContainer",
10+
"Complete [Issue #83](https://github.com/SAP-samples/hana-developer-cli-tool-example/issues/83) - add support for SQL and Calculation view parameters"
911
]
1012
},
1113
{

‎CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](http://keepachangelog.com/).
66

7+
## [3.202308.1] - 2023-08-25
8+
9+
**Changed**
10+
11+
- [CAP version 7.1.2](https://cap.cloud.sap/docs/releases/jul23)
12+
- Fixed Web Socket Error Handling
13+
- Upgrade to [SAPUI5 1.117.1](https://sapui5.hana.ondemand.com/#/topic/029d3b4a39c84384be6398c444f7e06a)
14+
- Fix [Issue #111](https://github.com/SAP-samples/hana-developer-cli-tool-example/issues/111) - add checks on container and group names for createContainer
15+
- Complete [Issue #83](https://github.com/SAP-samples/hana-developer-cli-tool-example/issues/83) - add support for SQL and Calculation view parameters
16+
717
## [3.202307.1] - 2023-07-10
818

919
**Changed**

‎bin/inspectView.js‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,13 @@ export async function viewInspect(prompts) {
114114

115115
let object = await dbInspect.getView(db, schema, prompts.view)
116116
let fields = []
117+
let parameters = []
117118
if (await dbInspect.isCalculationView(db, schema, prompts.view)) {
118119
fields = await dbInspect.getCalcViewFields(db, schema, prompts.view, object[0].VIEW_OID)
120+
parameters = await dbInspect.getCalcViewParameters(db, schema, prompts.view, object[0].VIEW_OID)
119121
} else {
120122
fields = await dbInspect.getViewFields(db, object[0].VIEW_OID)
123+
parameters = await dbInspect.getViewParameters(db, object[0].VIEW_OID)
121124
}
122125

123126
// @ts-ignore
@@ -130,6 +133,10 @@ export async function viewInspect(prompts) {
130133
results.basic = object[0]
131134
console.log("\n")
132135
base.outputTableFancy(fields)
136+
if (parameters && parameters.length > 0){
137+
results.parameters = parameters
138+
base.outputTableFancy(parameters)
139+
}
133140
results.fields = fields
134141
break
135142
case 'sql': {
@@ -153,13 +160,13 @@ export async function viewInspect(prompts) {
153160
break
154161
}
155162
case 'cds': {
156-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
163+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
157164
results.cds = cdsSource
158165
console.log(highlight(cdsSource))
159166
break
160167
}
161168
case 'json': {
162-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
169+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
163170
cdsSource = `service HanaCli { ${cdsSource} } `
164171
console.log(highlight(cds.compile.to.json(cds.parse(cdsSource))))
165172
break
@@ -185,27 +192,27 @@ export async function viewInspect(prompts) {
185192
break
186193
}
187194
case 'yaml': {
188-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
195+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
189196
cdsSource = `service HanaCli { ${cdsSource} } `
190197
console.log(highlight(cds.compile.to.yaml(cds.parse(cdsSource))))
191198
break
192199
}
193200
case 'cdl': {
194-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
201+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
195202
cdsSource = `service HanaCli { ${cdsSource} } `
196203
// @ts-ignore
197204
console.log(highlight(cds.compile.to.cdl(cds.parse(cdsSource))))
198205
break
199206
}
200207
case 'graphql': {
201-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
208+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
202209
cdsSource = `service HanaCli { ${cdsSource} } `
203210
// @ts-ignore
204211
console.log(highlight(cds.compile.to.gql(cds.parse(cdsSource))))
205212
break
206213
}
207214
case 'edmx': {
208-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
215+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
209216
cdsSource = `service HanaCli { ${cdsSource} } `
210217
let metadata = await cds.compile.to.edmx(cds.parse(cdsSource), {
211218
version: 'v4',
@@ -215,7 +222,7 @@ export async function viewInspect(prompts) {
215222
break
216223
}
217224
case 'annos': {
218-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
225+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
219226
cdsSource = `service HanaCli { ${cdsSource} } `
220227
let metadata = await cds.compile.to.edmx(cds.parse(cdsSource), {
221228
// @ts-ignore
@@ -226,7 +233,7 @@ export async function viewInspect(prompts) {
226233
break
227234
}
228235
case 'edm': {
229-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
236+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
230237
cdsSource = `service HanaCli { ${cdsSource} } `
231238
console.log(highlight(JSON.stringify(cds.compile.to.edm(cds.parse(cdsSource)), null, 4)))
232239
break
@@ -247,7 +254,7 @@ export async function viewInspect(prompts) {
247254
break
248255
}
249256
case 'openapi': {
250-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
257+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
251258
cdsSource = `service HanaCli { ${cdsSource} } `
252259
try {
253260
// @ts-ignore
@@ -269,7 +276,7 @@ export async function viewInspect(prompts) {
269276
}
270277
}
271278
case 'jsdoc': {
272-
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema)
279+
let cdsSource = await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
273280
cdsSource = `service HanaCli { ${cdsSource} } `
274281
try {
275282
// @ts-ignore

‎utils/dbInspect.js‎

Lines changed: 195 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,58 @@ export async function getViewFields(db, viewOid) {
195195
return fields
196196
}
197197

198+
/**
199+
* Get View Parameters and Metadata
200+
* @param {object} db - Database Connection
201+
* @param {string} schema - Schema
202+
* @param {string} viewId - View Unique ID
203+
* @param {string} viewOid - View Unique ID
204+
* @returns {Promise<object>}
205+
*/
206+
export async function getCalcViewParameters(db, schema, viewId, viewOid) {
207+
base.debug(`getCalcViewParameters ${schema} ${viewId}`)
208+
//Select Fields
209+
const statement = await db.preparePromisified(
210+
`SELECT SCHEMA_NAME, QUALIFIED_NAME as "VIEW_NAME", VARIABLE_NAME AS "PARAMETER_NAME",
211+
COLUMN_TYPE, COLUMN_TYPE_D as "DATA_TYPE_NAME",
212+
COLUMN_SQL_TYPE, VALUE_TYPE, MANDATORY, DESCRIPTION,
213+
PLACEHOLDER_NAME, DEFAULT_VALUE, SCHEMA_NAME, QUALIFIED_NAME, IS_INPUT_ENABLED,
214+
VARIABLE_TYPE, VARIABLE_SUB_TYPE
215+
FROM _SYS_BI.BIMC_VARIABLE_VIEW
216+
WHERE SCHEMA_NAME LIKE ?
217+
AND QUALIFIED_NAME = ?`)
218+
let parameters = await db.statementExecPromisified(statement, [schema, viewId])
219+
for (let parameter of parameters) {
220+
let temp1 = parameter.COLUMN_SQL_TYPE.split("(")
221+
if(temp1.length > 1){
222+
let temp2 = temp1[1].split(")")
223+
parameter.LENGTH = temp2[0]
224+
}else{
225+
parameter.LENGTH = 0
226+
}
227+
}
228+
229+
return parameters
230+
}
231+
232+
/**
233+
* Get View Parameters and Metadata
234+
* @param {object} db - Database Connection
235+
* @param {string} viewOid - View Unique ID
236+
* @returns {Promise<object>}
237+
*/
238+
export async function getViewParameters(db, viewOid) {
239+
base.debug(`getViewParameters ${viewOid}`)
240+
//Select Fields
241+
const statement = await db.preparePromisified(
242+
`SELECT SCHEMA_NAME, VIEW_NAME, VIEW_OID, PARAMETER_NAME, DATA_TYPE_ID, DATA_TYPE_NAME,
243+
LENGTH, SCALE, POSITION, HAS_DEFAULT_VALUE
244+
FROM VIEW_PARAMETERS
245+
WHERE VIEW_OID = ?`)
246+
let parameters = await db.statementExecPromisified(statement, [viewOid])
247+
return parameters
248+
}
249+
198250
/**
199251
* Get DB Table Details
200252
* @param {object} db - Database Connection
@@ -442,9 +494,10 @@ export let results = {
442494
* @param {string} type - DB Object type
443495
* @param {string} [schema] - Schema
444496
* @param {string} [parent] - Calling context which impacts formatting
497+
* @param {object} [parameters] - View Parameters
445498
* @returns {Promise<string>}
446499
*/
447-
export async function formatCDS(db, object, fields, constraints, type, schema, parent) {
500+
export async function formatCDS(db, object, fields, constraints, type, schema, parent, parameters) {
448501
base.debug(`formatCDS ${type}`)
449502
let cdstable = ""
450503
let originalName
@@ -477,11 +530,150 @@ export async function formatCDS(db, object, fields, constraints, type, schema, p
477530
}
478531
}
479532
if (options.useQuoted){
480-
newName && (cdstable += `Entity ![${newName}] {\n`)
533+
newName && (cdstable += `Entity ![${newName}] `)
481534
}else{
482-
newName && (cdstable += `Entity ${newName} {\n`)
535+
newName && (cdstable += `Entity ${newName} `)
483536
}
484537

538+
if (parameters && parameters.length > 0){
539+
cdstable += `(`
540+
for (let parameter of parameters) {
541+
cdstable += `${parameter.PARAMETER_NAME} : `
542+
if (options.useHanaTypes) {
543+
switch (parameter.DATA_TYPE_NAME) {
544+
case "NVARCHAR":
545+
cdstable += `String(${parameter.LENGTH})`
546+
break
547+
case "NCLOB":
548+
cdstable += "LargeString"
549+
break
550+
case "VARBINARY":
551+
cdstable += `Binary(${parameter.LENGTH})`
552+
break
553+
case "BLOB":
554+
cdstable += "LargeBinary"
555+
break
556+
case "INTEGER":
557+
cdstable += "Integer"
558+
break
559+
case "BIGINT":
560+
cdstable += "Integer64"
561+
break
562+
case "DECIMAL":
563+
cdstable += parameter.SCALE ? `Decimal(${parameter.LENGTH}, ${parameter.SCALE})` : `Decimal(${parameter.LENGTH})`
564+
break
565+
case "DOUBLE":
566+
cdstable += "Double"
567+
break
568+
case "DATE":
569+
cdstable += "Date"
570+
break
571+
case "TIME":
572+
cdstable += "Time"
573+
break
574+
case "SECONDDATE":
575+
cdstable += "String"
576+
break
577+
case "TIMESTAMP":
578+
if (parent === 'preview') {
579+
cdstable += "String"
580+
} else {
581+
cdstable += "Timestamp"
582+
}
583+
break
584+
case "BOOLEAN":
585+
cdstable += "Boolean"
586+
break
587+
// hana types
588+
case "SMALLINT":
589+
case "TINYINT":
590+
case "SMALLDECIMAL":
591+
case "REAL":
592+
case "CLOB":
593+
cdstable += `hana.${parameter.DATA_TYPE_NAME}`
594+
break
595+
case "CHAR":
596+
case "NCHAR":
597+
case "BINARY":
598+
cdstable += `hana.${parameter.DATA_TYPE_NAME}(${parameter.LENGTH})`
599+
break
600+
case "VARCHAR":
601+
cdstable += `hana.${parameter.DATA_TYPE_NAME}(${parameter.LENGTH})`
602+
break
603+
case "ST_POINT":
604+
case "ST_GEOMETRY":
605+
cdstable += `hana.${parameter.DATA_TYPE_NAME}(${await getGeoColumns(db, object[0], parameter, type)})`
606+
break
607+
default:
608+
cdstable += `**UNSUPPORTED TYPE - ${parameter.DATA_TYPE_NAME}`
609+
}
610+
} else {
611+
switch (parameter.DATA_TYPE_NAME) {
612+
case "NVARCHAR":
613+
cdstable += `String(${parameter.LENGTH})`
614+
break
615+
case "NCLOB":
616+
cdstable += "LargeString"
617+
break
618+
case "VARBINARY":
619+
cdstable += `Binary(${parameter.LENGTH})`
620+
break
621+
case "BLOB":
622+
cdstable += "LargeBinary"
623+
break
624+
case "INTEGER":
625+
cdstable += "Integer"
626+
break
627+
case "BIGINT":
628+
cdstable += "Integer64"
629+
break
630+
case "TINYINT":
631+
cdstable += "UInt8"
632+
break
633+
case "SMALLINT":
634+
cdstable += "Int16"
635+
break
636+
case "DECIMAL":
637+
cdstable += parameter.SCALE ? `Decimal(${parameter.LENGTH}, ${parameter.SCALE})` : `Decimal(${parameter.LENGTH})`
638+
break
639+
case "DOUBLE":
640+
cdstable += "Double"
641+
break
642+
case "DATE":
643+
cdstable += "Date"
644+
break
645+
case "TIME":
646+
cdstable += "Time"
647+
break
648+
case "SECONDDATE":
649+
cdstable += "String"
650+
break
651+
case "TIMESTAMP":
652+
if (parent === 'preview') {
653+
cdstable += "String"
654+
} else {
655+
cdstable += "Timestamp"
656+
}
657+
break
658+
case "BOOLEAN":
659+
cdstable += "Boolean"
660+
break
661+
case "VARCHAR":
662+
// backward compatible change
663+
cdstable += `String(${parameter.LENGTH})`
664+
break
665+
default:
666+
cdstable += `**UNSUPPORTED TYPE - ${parameter.DATA_TYPE_NAME}`
667+
}
668+
}
669+
cdstable += ", "
670+
}
671+
cdstable = cdstable.slice(0, -2)
672+
cdstable += `)`
673+
674+
}
675+
//closing entity
676+
cdstable += `{\n`
485677

486678
// if modified real table names will be stored in synonyms
487679
if (newName !== originalName) {

‎utils/massConvert.js‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ async function hdbtableViews(prompts, viewResults, wss, db, schema, replacer, zi
205205
let object = await dbInspect.getView(db, schema, view.VIEW_NAME)
206206
let fields = []
207207
if (await dbInspect.isCalculationView(db, schema, view.VIEW_NAME)) {
208-
fields = await dbInspect.getCalcViewFields(db, schema, view.VIEW_NAME, object[0].VIEW_OID)
208+
fields = await dbInspect.getCalcViewFields(db, schema, view.VIEW_NAME, object[0].VIEW_OID)
209209
} else {
210210
fields = await dbInspect.getViewFields(db, object[0].VIEW_OID)
211211
}
@@ -399,12 +399,15 @@ async function cdsViews(prompts, viewResults, wss, db, schema, cdsSource, logOut
399399
broadcast(wss, view.VIEW_NAME, i / viewResults.length * 100)
400400
let object = await dbInspect.getView(db, schema, view.VIEW_NAME)
401401
let fields = []
402+
let parameters = []
402403
if (await dbInspect.isCalculationView(db, schema, view.VIEW_NAME)) {
403404
fields = await dbInspect.getCalcViewFields(db, schema, view.VIEW_NAME, object[0].VIEW_OID)
405+
parameters = await dbInspect.getCalcViewParameters(db, schema, view.VIEW_NAME, object[0].VIEW_OID)
404406
} else {
405407
fields = await dbInspect.getViewFields(db, object[0].VIEW_OID)
408+
parameters = await dbInspect.getViewParameters(db, object[0].VIEW_OID)
406409
}
407-
cdsSource += await dbInspect.formatCDS(db, object, fields, null, "view", schema)
410+
cdsSource += await dbInspect.formatCDS(db, object, fields, null, "view", schema, null, parameters)
408411

409412
viewProgressBar.itemDone(view.VIEW_NAME)
410413
logOutput.push({ object: view.VIEW_NAME, status: 'Success' })

0 commit comments

Comments
 (0)