@sap/cds-compiler 2.11.4 → 2.12.0

package/lib/render/toSql.js

@@ -8,6 +8,7 @@ const {
 } = require('../model/csnUtils');
 const {
   renderFunc, beautifyExprArray, cdsToSqlTypes, getHanaComment, hasHanaComment,
+  getSqlSnippets,
 } = require('./utils/common');
 const {
   renderReferentialConstraint, getIdentifierUtils,
@@ -186,10 +187,10 @@ function toSqlDdl(csn, options) {
   checkCSNVersion(csn, options);
 
   // The final result in hdb-kind-specific form, without leading CREATE, without trailing newlines
-  // (note that the order here is relevant for transmission into 'resultObj.sql' below and that
+  // (note that the order here is relevant for transmission into 'mainResultObj.sql' below and that
   // the attribute names must be the HDI plugin names for --src hdi)
   // The result object may have a `sql` dictionary for `toSql`.
-  const resultObj = {
+  const mainResultObj = {
     hdbtabletype: Object.create(null),
     hdbtable: Object.create(null),
     hdbindex: Object.create(null),
@@ -215,12 +216,12 @@ function toSqlDdl(csn, options) {
       // Current indentation string
       indent: '',
     };
-    renderArtifactInto(artifactName, artifact, resultObj, env);
+    renderArtifactInto(artifactName, artifact, mainResultObj, env);
   });
 
   // Render each deleted artifact
   for (const artifactName in csn.deletions)
-    renderArtifactDeletionInto(artifactName, csn.deletions[artifactName], resultObj);
+    renderArtifactDeletionInto(artifactName, csn.deletions[artifactName], mainResultObj);
 
   // Render each artifact extension
   // Only HANA SQL is currently supported.
@@ -231,7 +232,7 @@ function toSqlDdl(csn, options) {
         const artifactName = extension.extend;
         const _artifact = csn.definitions[artifactName];
         const env = { indent: '', _artifact };
-        renderArtifactExtensionInto(artifactName, _artifact, extension, resultObj, env);
+        renderArtifactExtensionInto(artifactName, _artifact, extension, mainResultObj, env);
       }
     }
   }
@@ -244,7 +245,7 @@ function toSqlDdl(csn, options) {
         const artifactName = migration.migrate;
         const _artifact = csn.definitions[artifactName];
         const env = { indent: '', _artifact };
-        renderArtifactMigrationInto(artifactName, migration, resultObj, env);
+        renderArtifactMigrationInto(artifactName, migration, mainResultObj, env);
       }
     }
   }
@@ -265,22 +266,22 @@ function toSqlDdl(csn, options) {
 
   // Handle hdbKinds separately from alterTable case
   // eslint-disable-next-line no-unused-vars
-  const { deletions, migrations, ...hdbKinds } = resultObj;
+  const { deletions, migrations: _, ...hdbKinds } = mainResultObj;
   for (const hdbKind of Object.keys(hdbKinds)) {
-    for (const name in resultObj[hdbKind]) {
+    for (const name in mainResultObj[hdbKind]) {
       if (options.toSql.src === 'sql') {
-        let sourceString = resultObj[hdbKind][name];
+        let sourceString = mainResultObj[hdbKind][name];
         // Hack: Other than in 'hdbtable' files, in HANA SQL COLUMN is not mandatory but default.
         if (options.toSql.dialect === 'hana' && hdbKind === 'hdbtable' && sourceString.startsWith('COLUMN '))
           sourceString = sourceString.slice('COLUMN '.length);
         sql[name] = `${options.testMode ? '' : sqlVersionLine}CREATE ${sourceString};`;
       }
       else if (!options.testMode) {
-        resultObj[hdbKind][name] = sqlVersionLine + resultObj[hdbKind][name];
+        mainResultObj[hdbKind][name] = sqlVersionLine + mainResultObj[hdbKind][name];
       }
     }
     if (options.toSql.src === 'sql')
-      delete resultObj[hdbKind];
+      delete mainResultObj[hdbKind];
   }
 
   // add `ALTER TABLE ADD CONSTRAINT` statements if requested
@@ -289,18 +290,18 @@ function toSqlDdl(csn, options) {
 
     for ( const constraintName of Object.keys(alterStmts))
       sql[constraintName] = `${options.testMode ? '' : sqlVersionLine}${alterStmts[constraintName]}`;
-    resultObj.sql = sql;
+    mainResultObj.sql = sql;
   }
 
   if (options.toSql.src === 'sql')
-    resultObj.sql = sql;
+    mainResultObj.sql = sql;
 
   for (const name in deletions)
     deletions[name] = `${options.testMode ? '' : sqlVersionLine}${deletions[name]}`;
 
 
   timetrace.stop();
-  return resultObj;
+  return mainResultObj;
 
   /**
    * Render an artifact into the appropriate dictionary of 'resultObj'.
@@ -491,7 +492,9 @@ function toSqlDdl(csn, options) {
     env._artifact = art;
     const childEnv = increaseIndent(env);
     const hanaTc = art.technicalConfig && art.technicalConfig.hana;
-    let result = '';
+    // tables can have @sql.prepend and @sql.append
+    const { front, back } = getSqlSnippets(options, art);
+    let result = front;
     // Only HANA has row/column tables
     if (options.toSql.dialect === 'hana') {
       if (hanaTc && hanaTc.storeType) {
@@ -575,6 +578,9 @@ function toSqlDdl(csn, options) {
     if (options.toSql.dialect === 'hana' && hasHanaComment(art, options))
       result += ` COMMENT '${getHanaComment(art)}'`;
 
+    if (back)
+      result += back;
+
     resultObj.hdbtable[artifactName] = result;
   }
 
@@ -610,12 +616,12 @@ function toSqlDdl(csn, options) {
     if (!(artifactName in resultObj.migrations))
       resultObj.migrations[artifactName] = [];
 
-    const migrations = sqlArray.map(sql => ({ drop, sql }));
+    const migrations = sqlArray.map(migrationSql => ({ drop, sql: migrationSql }));
     resultObj.migrations[artifactName].push(...migrations);
   }
 
-  function addDeletion(resultObj, artifactName, sql) {
-    resultObj.deletions[artifactName] = sql;
+  function addDeletion(resultObj, artifactName, deletionSql) {
+    resultObj.deletions[artifactName] = deletionSql;
   }
 
   /**
@@ -672,9 +678,15 @@ function toSqlDdl(csn, options) {
     if (fzindex && options.toSql.dialect === 'hana')
       result += ` ${renderExpr(fzindex, env)}`;
 
-    if (options.toSql.dialect === 'hana' && hasHanaComment(elm, options, env._artifact))
+    if (options.toSql.dialect === 'hana' && hasHanaComment(elm, options))
       result += ` COMMENT '${getHanaComment(elm)}'`;
 
+    // (table) elements can only have a @sql.append
+    const { back } = getSqlSnippets(options, elm);
+
+    if (back !== '')
+      result += back;
+
     return result;
   }
 
@@ -984,7 +996,7 @@ function toSqlDdl(csn, options) {
    * @param {object} node with `args` to render
    * @param {string} sep Separator between args
    * @param {object} env Render environment
-   * @param {string} syntax Some magic A2J paramter - for calcview parameter rendering
+   * @param {string|null} syntax Some magic A2J parameter - for calcview parameter rendering
    * @returns {string} Rendered arguments
    * @throws Throws if args is not an array or object.
    */
@@ -1007,14 +1019,13 @@ function toSqlDdl(csn, options) {
      * Render the given argument/parameter correctly.
      *
      * @param {string} arg Argument to render
-     * @param {string} syntax Some magic A2J paramter - for calcview parameter rendering
+     * @param {string|null} parameterSyntax Some magic A2J parameter - for calcview parameter rendering
      * @returns {string} Rendered argument
      */
-    function decorateParameter(arg, syntax) {
-      if (syntax === 'calcview')
+    function decorateParameter(arg, parameterSyntax) {
+      if (parameterSyntax === 'calcview')
         return `PLACEHOLDER."$$${arg}$$"`;
 
-
       return quoteSqlId(arg);
     }
   }
@@ -1075,6 +1086,11 @@ function toSqlDdl(csn, options) {
       result += `${env.indent})`;
     }
 
+    // views can only have a @sql.append
+    const { back } = getSqlSnippets(options, art);
+    if (back)
+      result += back;
+
     return result;
   }
 
@@ -1082,7 +1098,7 @@ function toSqlDdl(csn, options) {
    * Render the parameter definition of a view if any. Return the parameters in parentheses, or an empty string
    *
    * @param {string} artifactName Name of the view
-   * @param {Array} params Array of parameters
+   * @param {Object} params Dictionary of parameters
    * @returns {string} Rendered parameters
    */
   function renderParameterDefinitions(artifactName, params) {
@@ -1338,27 +1354,27 @@ function toSqlDdl(csn, options) {
    * (no trailing LF, don't indent if inline)
    *
    * @todo Reuse this with toCdl
-   * @param {Array|object|string} x Expression to render
+   * @param {Array|object|string} expr Expression to render
    * @param {object} env Render environment
    * @param {boolean} inline Wether to render the expression inline
    * @param {boolean} nestedExpr Wether to treat the expression as nested
    * @returns {string} Rendered expression
    */
-  function renderExpr(x, env, inline = true, nestedExpr = false) {
+  function renderExpr(expr, env, inline = true, nestedExpr = false) {
     // Compound expression
-    if (Array.isArray(x)) {
-      const tokens = x.map(item => renderExpr(item, env, inline, nestedExpr));
+    if (Array.isArray(expr)) {
+      const tokens = expr.map(item => renderExpr(item, env, inline, nestedExpr));
       return beautifyExprArray(tokens);
     }
-    else if (typeof x === 'object' && x !== null) {
-      if (nestedExpr && x.cast && x.cast.type)
-        return renderExplicitTypeCast(renderExprObject());
-      return renderExprObject();
+    else if (typeof expr === 'object' && expr !== null) {
+      if (nestedExpr && expr.cast && expr.cast.type)
+        return renderExplicitTypeCast(expr, renderExprObject(expr));
+      return renderExprObject(expr);
     }
     // Not a literal value but part of an operator, function etc - just leave as it is
     // FIXME: For the sake of simplicity, we should get away from all this uppercasing in toSql
 
-    return String(x).toUpperCase();
+    return String(expr).toUpperCase();
 
 
     /**
@@ -1366,7 +1382,7 @@ function toSqlDdl(csn, options) {
      *
      * @returns {string} String representation of the expression
      */
-    function renderExprObject() {
+    function renderExprObject(x) {
       if (x.list) {
         return `(${x.list.map(item => renderExpr(item)).join(', ')})`;
       }
@@ -1412,10 +1428,10 @@ function toSqlDdl(csn, options) {
       throw new Error(`Unknown expression: ${JSON.stringify(x)}`);
     }
 
-    function renderWindowFunction(funcName, node, env) {
-      const suffix = node.xpr.shift(); // OVER
-      let r = `${funcName}(${renderArgs(node, '=>', env, null)})`;
-      r += ` ${suffix} (${renderExpr(node.xpr, env)})`;
+    function renderWindowFunction(funcName, node, fctEnv) {
+      const suffix = node.xpr[0]; // OVER
+      let r = `${funcName}(${renderArgs(node, '=>', fctEnv, null)})`;
+      r += ` ${suffix} (${renderExpr(node.xpr.slice(1), fctEnv)})`; // do not pass suffix in renderExpr
       return r;
     }
 
@@ -1570,10 +1586,11 @@ function toSqlDdl(csn, options) {
     /**
      * Renders an explicit `cast()` inside an 'xpr'.
      *
+     * @param {object} x Expression with cast
      * @param {string} value Value to cast
      * @returns {string} CAST statement
      */
-    function renderExplicitTypeCast(value) {
+    function renderExplicitTypeCast(x, value) {
       const typeRef = renderBuiltinType(x.cast.type) + renderTypeParameters(x.cast);
       return `CAST(${value} AS ${typeRef})`;
     }

package/lib/render/utils/common.js

@@ -19,6 +19,7 @@ const {
 } = require('../../model/csnUtils');
 
 const { implicitAs } = require('../../model/csnRefs');
+const { isBetaEnabled } = require('../../base/model');
 
 
 /**
@@ -205,12 +206,11 @@ function addMissingChildContexts(csn, artifactName, killList) {
       addPossibleGaps(name.slice(artifactName.length + 1).split('.'), artifactName);
   }
 
-  function addPossibleGaps(possibleGaps, artifactName) {
-    let possibleGap = artifactName;
+  function addPossibleGaps(possibleGaps, gapArtifactName) {
     for (const gap of possibleGaps) {
-      possibleGap += `.${gap}`;
-      if (!csn.definitions[possibleGap]) {
-        const contextName = possibleGap;
+      gapArtifactName += `.${gap}`;
+      if (!csn.definitions[gapArtifactName]) {
+        const contextName = gapArtifactName;
         csn.definitions[contextName] = {
           kind: 'context',
         };
@@ -355,6 +355,24 @@ function getHanaComment(obj) {
   return obj.doc.split('\n\n')[0].trim().replace(/'/g, "''");
 }
 
+/**
+ * Get the @sql.prepend/append if set - already add a space after/before.
+ * If no value is set, use '';
+ *
+ * @param {CSN.Options} options
+ * @param {object} obj
+ * @returns {object} object with .front and .back
+ */
+function getSqlSnippets(options, obj) {
+  if (isBetaEnabled(options, 'sqlSnippets')) {
+    const front = obj['@sql.prepend'] ? `${obj['@sql.prepend']} ` : '';
+    const back = obj['@sql.append'] ? ` ${obj['@sql.append']}` : '';
+
+    return { front, back };
+  }
+  return { front: '', back: '' };
+}
+
 /**
  * @typedef CdlRenderEnvironment Rendering environment used throughout the render process.
  *
@@ -383,4 +401,5 @@ module.exports = {
   getHanaComment,
   findElement,
   funcWithoutParen,
+  getSqlSnippets,
 };

package/lib/render/utils/sql.js

@@ -13,11 +13,11 @@ const { smartId, delimitedId } = require('../../sql-identifier');
  * @param {boolean} toUpperCase Wether to uppercase the identifier
  * @param {CSN.Model} csn CSN
  * @param {CSN.Options} options is needed for the naming mode and the sql dialect
- * @param {boolean} alterConstraint whether the constraint should be rendered as part of an ALTER TABLE statement
+ * @param {boolean} [alterConstraint=false] whether the constraint should be rendered as part of an ALTER TABLE statement
  *
  * @returns {string} SQL statement which can be used to create the referential constraint on the db.
  */
-function renderReferentialConstraint(constraint, indent, toUpperCase, csn, options, alterConstraint) {
+function renderReferentialConstraint(constraint, indent, toUpperCase, csn, options, alterConstraint = false) {
   let quoteId;
   // for to.hana we can't utilize the sql identifier utils
   if (options.transformation === 'hdbcds') {
@@ -51,14 +51,16 @@ function renderReferentialConstraint(constraint, indent, toUpperCase, csn, optio
   if (!alterConstraint) {
     result += `${indent}FOREIGN KEY(${constraint.foreignKey.map(quoteId).join(', ')})\n`;
     result += `${indent}REFERENCES ${quoteId(getResultingName(csn, names, constraint.parentTable))}(${constraint.parentKey.map(quoteId).join(', ')})\n`;
+    const onDeleteRemark = constraint.onDeleteRemark ? ` -- ${constraint.onDeleteRemark}` : '';
+
     // omit 'RESTRICT' action for ON UPDATE / ON DELETE, because it interferes with deferred constraint check
     if (forSqlite) {
       if (constraint.onDelete === 'CASCADE' )
-        result += `${indent}ON DELETE ${constraint.onDelete}${constraint.onDeleteRemark ? ` -- ${constraint.onDeleteRemark}` : ''}\n`;
+        result += `${indent}ON DELETE ${constraint.onDelete}${onDeleteRemark}\n`;
     }
     else {
       result += `${indent}ON UPDATE RESTRICT\n`;
-      result += `${indent}ON DELETE ${constraint.onDelete}${constraint.onDeleteRemark ? ` -- ${constraint.onDeleteRemark}` : ''}\n`;
+      result += `${indent}ON DELETE ${constraint.onDelete}${onDeleteRemark}\n`;
     }
   }
   // constraint enforcement / validation must be switched off using sqlite pragma statement

package/lib/transform/braceExpression.js

@@ -1,8 +1,10 @@
 'use strict';
 
 function isAlreadyBraced(expression, start, end){
-  const isBraced = start - 1 > -1 && end + 1 < expression.length && expression[start-1] === '(' && expression[end+1] === ')';
-  return isBraced;
+  return start - 1 > -1 &&
+    end + 1 < expression.length &&
+    expression[start-1] === '(' &&
+    expression[end+1] === ')';
 }
 
 function binarycomparison(expression, token, index){