@cap-js/db-service 1.4.0 → 1.5.1

package/CHANGELOG.md

@@ -4,6 +4,32 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.5.1](https://github.com/cap-js/cds-dbs/compare/db-service-v1.5.0...db-service-v1.5.1) (2023-12-20)
+
+
+### Fixed
+
+* **cqn2sql:** supporting calculated elements ([#387](https://github.com/cap-js/cds-dbs/issues/387)) ([2153fb9](https://github.com/cap-js/cds-dbs/commit/2153fb9a3910cd4afa3a91918e6cf682646492b7))
+* do not rely on db constraints for deep delete ([#390](https://github.com/cap-js/cds-dbs/issues/390)) ([9623af6](https://github.com/cap-js/cds-dbs/commit/9623af64db97cfe15ef07b659635850fc908f77c))
+
+
+### Performance Improvements
+
+* HANA list placeholder ([#380](https://github.com/cap-js/cds-dbs/issues/380)) ([3eadfea](https://github.com/cap-js/cds-dbs/commit/3eadfea7b94f485030cc8bd0bd298ce088586422))
+
+## [1.5.0](https://github.com/cap-js/cds-dbs/compare/db-service-v1.4.0...db-service-v1.5.0) (2023-12-06)
+
+
+### Added
+
+* Improved connection pool for HANAService ([#349](https://github.com/cap-js/cds-dbs/issues/349)) ([1c284e6](https://github.com/cap-js/cds-dbs/commit/1c284e69cccd76daad52249c0462bc62aa4d11a8))
+
+
+### Fixed
+
+* **localized:** `ref`s in subqueries in `from` are translated ([#366](https://github.com/cap-js/cds-dbs/issues/366)) ([cfe4897](https://github.com/cap-js/cds-dbs/commit/cfe489715db0854d30b90b7f13c024e6e90be497))
+* wrong odata count in filter with groupby ([#352](https://github.com/cap-js/cds-dbs/issues/352)) ([70690a1](https://github.com/cap-js/cds-dbs/commit/70690a1a13e72bfbb66f03bf315d3f2d48672bf6))
+
 ## [1.4.0](https://github.com/cap-js/cds-dbs/compare/db-service-v1.3.2...db-service-v1.4.0) (2023-11-20)
 
 

package/lib/SQLService.js

@@ -153,7 +153,8 @@ class SQLService extends DatabaseService {
   }
 
   get onDELETE() {
-    return super.onDELETE = cds.env.features.assert_integrity === 'db' ? this.onSIMPLE : deep_delete
+    // REVISIT: It's not yet 100 % clear under which circumstances we can rely on db constraints
+    return super.onDELETE = /* cds.env.features.assert_integrity === 'db' ? this.onSIMPLE : */ deep_delete
     async function deep_delete(/** @type {Request} */ req) {
       let { compositions } = req.target
       if (compositions) {
@@ -230,16 +231,15 @@ class SQLService extends DatabaseService {
       if (max === undefined || (n < max && (n || !offset))) return n + offset
     }
     // REVISIT: made uppercase count because of HANA reserved word quoting
-    const cq = cds.ql.clone(query, {
-      columns: [{ func: 'count', as: 'COUNT' }],
+    const cq = SELECT.one([{ func: 'count', as: 'COUNT' }]).from(
+      cds.ql.clone(query, {
       localized: false,
       expand: false,
-      limit: 0,
-      orderBy: 0,
-    })
-    const { sql, values } = this.cqn2sql(cq)
-    const ps = await this.prepare(sql)
-    const { count, COUNT } = await ps.get(values)
+        limit: undefined,
+        orderBy: undefined,
+      }),
+    )
+    const { count, COUNT } = await this.onSELECT({ query: cq })
     return count ?? COUNT
   }
 
@@ -280,12 +280,12 @@ class SQLService extends DatabaseService {
    */
   cqn2sql(query, values) {
     let q = this.cqn4sql(query)
-    if (q.SELECT && q.elements) q.SELECT.expand = q.SELECT.expand ?? 'root'
+    if (q.SELECT && 'elements' in q) q.SELECT.expand ??= 'root'
 
-    let cmd = q.cmd || Object.keys(q)[0]
-    if (cmd in { INSERT: 1, DELETE: 1, UPSERT: 1, UPDATE: 1 } || q.STREAM?.into) {
+    let kind = q.kind || Object.keys(q)[0]
+    if (kind in { INSERT: 1, DELETE: 1, UPSERT: 1, UPDATE: 1 } || q.STREAM?.into) {
       q = resolveView(q, this.model, this) // REVISIT: before resolveView was called on flat cqn obtained from cqn4sql -> is it correct to call on original q instead?
-      let target = q[cmd]._transitions?.[0].target
+      let target = q[kind]._transitions?.[0].target
       if (target) q.target = target // REVISIT: Why isn't that done in resolveView?
     }
     let cqn2sql = new this.class.CQN2SQL(this)

package/lib/common/DatabaseService.js

@@ -63,6 +63,7 @@ class DatabaseService extends cds.Service {
 
     // Acquire a pooled connection
     this.dbc = await this.acquire()
+    this.dbc.destroy = this.destroy.bind(this)
 
     // Begin a session...
     try {
@@ -110,8 +111,20 @@ class DatabaseService extends cds.Service {
    */
   async release() {
     if (!this.dbc) return
-    await this.pool.release(this.dbc)
+    const dbc = this.dbc
     this.dbc = undefined
+    await this.pool.release(dbc)
+  }
+
+  /**
+   * Destroys own connection, i.e. tix.dbc, from this.pool
+   * This is for subclasses to intercept, if required.
+   */
+  async destroy() {
+    if (!this.dbc) return
+    const dbc = this.dbc
+    this.dbc = undefined
+    await this.pool.destroy(dbc)
   }
 
   // REVISIT: should happen automatically after a configurable time

package/lib/cqn2sql.js

@@ -27,7 +27,7 @@ class CQN2SQLRenderer {
     this.class._init() // is a noop for subsequent calls
   }
 
-  static _add_mixins (aspect, mixins) {
+  static _add_mixins(aspect, mixins) {
     const fqn = this.name + aspect
     const types = cds.builtin.types
     for (let each in mixins) {
@@ -52,7 +52,7 @@ class CQN2SQLRenderer {
       this.ReservedWords[each[0] + each.slice(1).toLowerCase()] = 1 // Order
       this.ReservedWords[each.toLowerCase()] = 1 // order
     }
-    this._init = () => {} // makes this a noop for subsequent calls
+    this._init = () => { } // makes this a noop for subsequent calls
   }
 
   /**
@@ -62,14 +62,14 @@ class CQN2SQLRenderer {
    * @returns {CQN2SQLRenderer|unknown}
    */
   render(q, vars) {
-    const cmd = q.cmd || Object.keys(q)[0] // SELECT, INSERT, ...
+    const kind = q.kind || Object.keys(q)[0] // SELECT, INSERT, ...
     /**
      * @type {string} the rendered SQL string
      */
     this.sql = '' // to have it as first property for debugging
     /** @type {unknown[]} */
     this.values = [] // prepare values, filled in by subroutines
-    this[cmd]((this.cqn = q)) // actual sql rendering happens here
+    this[kind]((this.cqn = q)) // actual sql rendering happens here
     if (vars?.length && !this.values?.length) this.values = vars
     const sanitize_values = process.env.NODE_ENV === 'production' && cds.env.log.sanitize_values !== false
     DEBUG?.(
@@ -208,9 +208,8 @@ class CQN2SQLRenderer {
     if (limit) sql += ` LIMIT ${this.limit(limit)}`
     // Expand cannot work without an inferred query
     if (expand) {
-      // REVISIT: Why don't we handle that as an error in SELECT_expand?
-      if (!q.elements) cds.error`Query was not inferred and includes expand. For which the metadata is missing.`
-      sql = this.SELECT_expand(q, sql)
+      if ('elements' in q) sql = this.SELECT_expand(q, sql)
+      else cds.error`Query was not inferred and includes expand. For which the metadata is missing.`
     }
     return (this.sql = sql)
   }
@@ -230,10 +229,12 @@ class CQN2SQLRenderer {
    * @param {string} sql
    * @returns {string} SQL
    */
-  SELECT_expand({ SELECT, elements }, sql) {
+  SELECT_expand(q, sql) {
+    if (!('elements' in q)) return sql
+
+    const SELECT = q.SELECT
     if (!SELECT.columns) return sql
-    if (!elements) return sql // REVISIT: Above we say this is an error condition, but here we say it's ok?
-    
+
     let cols = SELECT.columns.map(x => {
       const name = this.column_name(x)
       let col = `'${name}',${this.output_converter4(x.element, this.quote(name))}`
@@ -248,7 +249,7 @@ class CQN2SQLRenderer {
     // Prevent SQLite from hitting function argument limit of 100
     let obj = ''
 
-    if(cols.length < 50) obj =  `json_object(${cols.slice(0, 50)})`
+    if (cols.length < 50) obj = `json_object(${cols.slice(0, 50)})`
     else {
       const chunks = []
       for (let i = 0; i < cols.length; i += 50) {
@@ -256,7 +257,7 @@ class CQN2SQLRenderer {
       }
       // REVISIT: json_merge is a user defined function, bad performance!
       obj = `json_merge(${chunks})`
-    } 
+    }
 
 
     return `SELECT ${SELECT.one || SELECT.expand === 'root' ? obj : `json_group_array(${obj.includes('json_merge') ? `json_insert(${obj})` : obj})`} as _json_ FROM (${sql})`
@@ -341,9 +342,9 @@ class CQN2SQLRenderer {
     return orderBy.map(
       localized
         ? c =>
-            this.expr(c) +
-            (c.element?.[this.class._localized] ? ' COLLATE NOCASE' : '') +
-            (c.sort === 'desc' || c.sort === -1 ? ' DESC' : ' ASC')
+          this.expr(c) +
+          (c.element?.[this.class._localized] ? ' COLLATE NOCASE' : '') +
+          (c.sort === 'desc' || c.sort === -1 ? ' DESC' : ' ASC')
         : c => this.expr(c) + (c.sort === 'desc' || c.sort === -1 ? ' DESC' : ' ASC'),
     )
   }
@@ -371,12 +372,12 @@ class CQN2SQLRenderer {
     return INSERT.entries
       ? this.INSERT_entries(q)
       : INSERT.rows
-      ? this.INSERT_rows(q)
-      : INSERT.values
-      ? this.INSERT_values(q)
-      : INSERT.as
-      ? this.INSERT_select(q)
-      : cds.error`Missing .entries, .rows, or .values in ${q}`
+        ? this.INSERT_rows(q)
+        : INSERT.values
+          ? this.INSERT_values(q)
+          : INSERT.as
+            ? this.INSERT_select(q)
+            : cds.error`Missing .entries, .rows, or .values in ${q}`
   }
 
   /**
@@ -393,7 +394,7 @@ class CQN2SQLRenderer {
       return // REVISIT: mtx sends an insert statement without entries and no reference entity
     }
     const columns = elements
-      ? ObjectKeys(elements).filter(c => c in elements && !elements[c].virtual && !elements[c].isAssociation)
+      ? ObjectKeys(elements).filter(c => c in elements && !elements[c].virtual && !elements[c].value && !elements[c].isAssociation)
       : ObjectKeys(INSERT.entries[0])
 
     /** @type {string[]} */
@@ -426,9 +427,8 @@ class CQN2SQLRenderer {
     // Include this.values for placeholders
     /** @type {unknown[][]} */
     this.entries = [[...this.values, JSON.stringify(INSERT.entries)]]
-    return (this.sql = `INSERT INTO ${this.quote(entity)}${alias ? ' as ' + this.quote(alias) : ''} (${
-      this.columns
-    }) SELECT ${extraction} FROM json_each(?)`)
+    return (this.sql = `INSERT INTO ${this.quote(entity)}${alias ? ' as ' + this.quote(alias) : ''} (${this.columns
+      }) SELECT ${extraction} FROM json_each(?)`)
   }
 
   /**
@@ -442,21 +442,20 @@ class CQN2SQLRenderer {
     const alias = INSERT.into.as
     const elements = q.elements || q.target?.elements
     const columns = INSERT.columns
-    || cds.error`Cannot insert rows without columns or elements`
+      || cds.error`Cannot insert rows without columns or elements`
 
     const inputConverter = this.class._convertInput
-    const extraction = columns.map((c,i) => {
+    const extraction = columns.map((c, i) => {
       const extract = `value->>'$[${i}]'`
       const element = elements?.[c]
       const converter = element?.[inputConverter]
-      return converter?.(extract,element) || extract
+      return converter?.(extract, element) || extract
     })
 
     this.columns = columns.map(c => this.quote(c))
     this.entries = [[JSON.stringify(INSERT.rows)]]
-    return (this.sql = `INSERT INTO ${this.quote(entity)}${alias ? ' as ' + this.quote(alias) : ''} (${
-      this.columns
-    }) SELECT ${extraction} FROM json_each(?)`)
+    return (this.sql = `INSERT INTO ${this.quote(entity)}${alias ? ' as ' + this.quote(alias) : ''} (${this.columns
+      }) SELECT ${extraction} FROM json_each(?)`)
   }
 
   /**
@@ -551,9 +550,9 @@ class CQN2SQLRenderer {
     if (entity.as) sql += ` AS ${entity.as}`
 
     let columns = []
-    if (data) _add (data, val => this.val({val}))
-    if (_with) _add (_with, x => this.expr(x))
-    function _add (data, sql4) {
+    if (data) _add(data, val => this.val({ val }))
+    if (_with) _add(_with, x => this.expr(x))
+    function _add(data, sql4) {
       for (let c in data) {
         if (!elements || (c in elements && !elements[c].virtual)) {
           columns.push({ name: c, sql: sql4(data[c]) })
@@ -601,8 +600,8 @@ class CQN2SQLRenderer {
     return STREAM.from
       ? this.STREAM_from(q)
       : STREAM.into
-      ? this.STREAM_into(q)
-      : cds.error`Missing .form or .into in ${q}`
+        ? this.STREAM_into(q)
+        : cds.error`Missing .form or .into in ${q}`
   }
 
   /**
@@ -667,7 +666,7 @@ class CQN2SQLRenderer {
   expr(x) {
     const wrap = x.cast ? sql => `cast(${sql} as ${this.type4(x.cast)})` : sql => sql
     if (typeof x === 'string') throw cds.error`Unsupported expr: ${x}`
-    if ('param' in x) return wrap(this.param(x))
+    if (x.param) return wrap(this.param(x))
     if ('ref' in x) return wrap(this.ref(x))
     if ('val' in x) return wrap(this.val(x))
     if ('xpr' in x) return wrap(this.xpr(x))
@@ -703,15 +702,15 @@ class CQN2SQLRenderer {
   operator(x, i, xpr) {
 
     // Translate = to IS NULL for rhs operand being NULL literal
-    if (x === '=')  return xpr[i+1]?.val === null ? 'is' : '='
+    if (x === '=') return xpr[i + 1]?.val === null ? 'is' : '='
 
     // Translate == to IS NOT NULL for rhs operand being NULL literal, otherwise ...
     // Translate == to IS NOT DISTINCT FROM, unless both operands cannot be NULL
-    if (x === '==') return xpr[i+1]?.val === null ? 'is' : _not_null(i-1) && _not_null(i+1) ? '=' : this.is_not_distinct_from_
+    if (x === '==') return xpr[i + 1]?.val === null ? 'is' : _not_null(i - 1) && _not_null(i + 1) ? '=' : this.is_not_distinct_from_
 
     // Translate != to IS NULL for rhs operand being NULL literal, otherwise...
     // Translate != to IS DISTINCT FROM, unless both operands cannot be NULL
-    if (x === '!=') return xpr[i+1]?.val === null ? 'is not' : _not_null(i-1) && _not_null(i+1) ? '<>' : this.is_distinct_from_
+    if (x === '!=') return xpr[i + 1]?.val === null ? 'is not' : _not_null(i - 1) && _not_null(i + 1) ? '<>' : this.is_distinct_from_
 
     else return x
 
@@ -748,9 +747,9 @@ class CQN2SQLRenderer {
    */
   ref({ ref }) {
     switch (ref[0]) {
-      case '$now': return this.func({ func: 'session_context', args: [{ val: '$now' }]})
+      case '$now': return this.func({ func: 'session_context', args: [{ val: '$now', param: false }] })
       case '$user':
-      case '$user.id': return this.func({ func: 'session_context', args: [{ val: '$user.id' }]})
+      case '$user.id': return this.func({ func: 'session_context', args: [{ val: '$user.id', param: false }] })
       default: return ref.map(r => this.quote(r)).join('.')
     }
   }
@@ -760,7 +759,7 @@ class CQN2SQLRenderer {
    * @param {import('./infer/cqn').val} param0
    * @returns {string} SQL
    */
-  val({ val }) {
+  val({ val, param }) {
     switch (typeof val) {
       case 'function': throw new Error('Function values not supported.')
       case 'undefined': return 'NULL'
@@ -769,13 +768,13 @@ class CQN2SQLRenderer {
       case 'object':
         if (val === null) return 'NULL'
         if (val instanceof Date) return `'${val.toISOString()}'`
-        if (val instanceof Readable) ; // go on with default below
+        if (val instanceof Readable); // go on with default below
         else if (Buffer.isBuffer(val)) val = val.toString('base64')
         else if (is_regexp(val)) val = val.source
         else val = JSON.stringify(val)
       case 'string': // eslint-disable-line no-fallthrough
     }
-    if (!this.values) return this.string(val)
+    if (!this.values || param === false) return this.string(val)
     else this.values.push(val)
     return '?'
   }
@@ -859,12 +858,12 @@ class CQN2SQLRenderer {
     const requiredColumns = !elements
       ? []
       : Object.keys(elements)
-          .filter(
-            e =>
-              (elements[e]?.[annotation] || (!isUpdate && elements[e]?.default && !elements[e].virtual && !elements[e].isAssociation)) &&
-              !columns.find(c => c.name === e),
-          )
-          .map(name => ({ name, sql: 'NULL' }))
+        .filter(
+          e =>
+            (elements[e]?.[annotation] || (!isUpdate && elements[e]?.default && !elements[e].virtual && !elements[e].isAssociation)) &&
+            !columns.find(c => c.name === e),
+        )
+        .map(name => ({ name, sql: 'NULL' }))
 
     return [...columns, ...requiredColumns].map(({ name, sql }) => {
       let element = elements?.[name] || {}
@@ -874,14 +873,13 @@ class CQN2SQLRenderer {
       if (converter && sql[0] !== '$') sql = converter(sql, element)
 
       let val = _managed[element[annotation]?.['=']]
-      if (val) sql = `coalesce(${sql}, ${this.func({ func: 'session_context', args: [{ val }] })})`
+      if (val) sql = `coalesce(${sql}, ${this.func({ func: 'session_context', args: [{ val, param: false }] })})`
       else if (!isUpdate && element.default) {
         const d = element.default
         if (d.val !== undefined || d.ref?.[0] === '$now') {
           // REVISIT: d.ref is not used afterwards
-          sql = `(CASE WHEN json_type(value,'$."${name}"') IS NULL THEN ${
-            this.defaultValue(d.val) // REVISIT: this.defaultValue is a strange function
-          } ELSE ${sql} END)`
+          sql = `(CASE WHEN json_type(value,'$."${name}"') IS NULL THEN ${this.defaultValue(d.val) // REVISIT: this.defaultValue is a strange function
+            } ELSE ${sql} END)`
         }
       }
 

package/lib/cqn4sql.js

@@ -48,7 +48,7 @@ function cqn4sql(originalQuery, model = cds.context?.model || cds.model) {
   if (originalQuery.SELECT?.from.args && !originalQuery.joinTree) return inferred
 
   let transformedQuery = cds.ql.clone(inferred)
-  const kind = inferred.cmd || Object.keys(inferred)[0]
+  const kind = inferred.kind || Object.keys(inferred)[0]
 
   if (inferred.INSERT || inferred.UPSERT) {
     transformedQuery = transformQueryForInsertUpsert(kind)
@@ -415,7 +415,6 @@ function cqn4sql(originalQuery, model = cds.context?.model || cds.model) {
     return transformedColumns
 
     function handleSubquery(col) {
-      if (isLocalized(inferred.target)) col.SELECT.localized = true
       if (!col.SELECT.from.as) {
         const uniqueSubqueryAlias = inferred.joinTree.addNextAvailableTableAlias(
           getLastStringSegment(col.SELECT.from.ref[col.SELECT.from.ref.length - 1]),
@@ -830,7 +829,6 @@ function cqn4sql(originalQuery, model = cds.context?.model || cds.model) {
         one: column.$refLinks[column.$refLinks.length - 1].definition.is2one,
       },
     }
-    if (isLocalized(inferred.target)) subquery.SELECT.localized = true
     const expanded = transformSubquery(subquery)
     const correlated = _correlate({ ...expanded, as: columnAlias }, outerAlias)
     Object.defineProperty(correlated, 'elements', { value: subquery.elements, writable: true })
@@ -946,6 +944,7 @@ function cqn4sql(originalQuery, model = cds.context?.model || cds.model) {
       outerQueries.push(inferred)
       Object.defineProperty(q, 'outerQueries', { value: outerQueries })
     }
+    if (isLocalized(inferred.target)) q.SELECT.localized = true
     return cqn4sql(q, model)
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/db-service",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "CDS base database service",
   "homepage": "https://github.com/cap-js/cds-dbs/tree/main/db-service#cds-base-database-service",
   "repository": {