@cap-js/postgres 1.7.0 → 1.9.1

package/CHANGELOG.md

@@ -4,6 +4,35 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.9.1](https://github.com/cap-js/cds-dbs/compare/postgres-v1.9.0...postgres-v1.9.1) (2024-07-09)
+
+
+### Fixed
+
+* expand reach of `cds.features.ieee754compatible` to `int64` ([#722](https://github.com/cap-js/cds-dbs/issues/722)) ([7eef5e9](https://github.com/cap-js/cds-dbs/commit/7eef5e9c5ec286285b2552abd1e673175c59fdc1))
+
+## [1.9.0](https://github.com/cap-js/cds-dbs/compare/postgres-v1.8.0...postgres-v1.9.0) (2024-05-29)
+
+
+### Added
+
+* Add simple queries feature flag ([#660](https://github.com/cap-js/cds-dbs/issues/660)) ([3335202](https://github.com/cap-js/cds-dbs/commit/33352024201a96cc6bdfa30a0fe3fff4227dee10))
+
+## [1.8.0](https://github.com/cap-js/cds-dbs/compare/postgres-v1.7.0...postgres-v1.8.0) (2024-05-08)
+
+
+### Added
+
+* select decimals as strings if cds.env.features.string_decimals ([#616](https://github.com/cap-js/cds-dbs/issues/616)) ([39addbf](https://github.com/cap-js/cds-dbs/commit/39addbfe01da757d86a4d65e62eda86e59fc9b87))
+
+
+### Fixed
+
+* Align all quote functions with @sap/cds-compiler ([#619](https://github.com/cap-js/cds-dbs/issues/619)) ([42e9828](https://github.com/cap-js/cds-dbs/commit/42e9828baf11ec55281ea634ce56ce93e6741b91))
+* Change `sql` property to `query` for errors ([#611](https://github.com/cap-js/cds-dbs/issues/611)) ([585577a](https://github.com/cap-js/cds-dbs/commit/585577a9817e7749fb71958c26c4bfa20981c663))
+* Improved placeholders and limit clause ([#567](https://github.com/cap-js/cds-dbs/issues/567)) ([d5d5dbb](https://github.com/cap-js/cds-dbs/commit/d5d5dbb7219bcef6134440715cf756fdd439f076))
+* Use json datatype for `INSERT` ([#582](https://github.com/cap-js/cds-dbs/issues/582)) ([f1c9c89](https://github.com/cap-js/cds-dbs/commit/f1c9c89036a7f8e4709c67d713d06926630aa36d))
+
 ## [1.7.0](https://github.com/cap-js/cds-dbs/compare/postgres-v1.6.0...postgres-v1.7.0) (2024-04-12)
 
 

package/README.md

@@ -47,7 +47,7 @@ However, some preliminary checks and cleanups help:
 
 ### schema migration
 
-`@cap-js/postgres` brings the same schema evolution capabilities to PostgreSQL known from HANA and SQLite.  
+`@cap-js/postgres` brings the same schema evolution capabilities to PostgreSQL known from SAP HANA and SQLite.  
 Enabling schema migration in an existing `cds-pg`-based project consists of generating and deploying a "csn-snapshot" of your database structure.
 
 #### local development

package/lib/PostgresService.js

@@ -1,6 +1,6 @@
 const { SQLService } = require('@cap-js/db-service')
 const { Client, Query } = require('pg')
-const cds = require('@sap/cds/lib')
+const cds = require('@sap/cds')
 const crypto = require('crypto')
 const { Writable, Readable } = require('stream')
 const sessionVariableMap = require('./session.json')
@@ -144,18 +144,29 @@ GROUP BY k
       text: sql,
       name: sha,
     }
+
+    const enhanceError = (err, sql) => Object.assign(err, { query: sql + '\n' + new Array(err.position).fill(' ').join('') + '^' })
+
     return {
       run: async values => {
-        // REVISIT: SQLService provides empty values as {} for plain SQL statements - PostgreSQL driver expects array or nothing - see issue #78
-        let newQuery = this._prepareStreams(query, values)
-        if (typeof newQuery.then === 'function') newQuery = await newQuery
-        const result = await this.dbc.query(newQuery)
-        return { changes: result.rowCount }
+        try {
+          // REVISIT: SQLService provides empty values as {} for plain SQL statements - PostgreSQL driver expects array or nothing - see issue #78
+          let newQuery = this._prepareStreams(query, values)
+          if (typeof newQuery.then === 'function') newQuery = await newQuery
+          const result = await this.dbc.query(newQuery)
+          return { changes: result.rowCount }
+        } catch (e) {
+          throw enhanceError(e, sql)
+        }
       },
       get: async values => {
-        // REVISIT: SQLService provides empty values as {} for plain SQL statements - PostgreSQL driver expects array or nothing - see issue #78
-        const result = await this.dbc.query({ ...query, values: this._getValues(values) })
-        return result.rows[0]
+        try {
+          // REVISIT: SQLService provides empty values as {} for plain SQL statements - PostgreSQL driver expects array or nothing - see issue #78
+          const result = await this.dbc.query({ ...query, values: this._getValues(values) })
+          return result.rows[0]
+        } catch (e) {
+          throw enhanceError(e, sql)
+        }
       },
       all: async values => {
         // REVISIT: SQLService provides empty values as {} for plain SQL statements - PostgreSQL driver expects array or nothing - see issue #78
@@ -163,7 +174,7 @@ GROUP BY k
           const result = await this.dbc.query({ ...query, values: this._getValues(values) })
           return result.rows
         } catch (e) {
-          throw Object.assign(e, { sql: sql + '\n' + new Array(e.position).fill(' ').join('') + '^' })
+          throw enhanceError(e, sql)
         }
       },
       stream: async (values, one) => {
@@ -171,7 +182,7 @@ GROUP BY k
           const streamQuery = new QueryStream({ ...query, values: this._getValues(values) }, one)
           return await this.dbc.query(streamQuery)
         } catch (e) {
-          throw Object.assign(e, { sql: sql + '\n' + new Array(e.position).fill(' ').join('') + '^' })
+          throw enhanceError(e, sql)
         }
       },
     }
@@ -206,8 +217,7 @@ GROUP BY k
           sql = sql.replace(
             new RegExp(`\\$${i + 1}`, 'g'),
             // Don't ask about the dollar signs
-            `(SELECT ${isBinary ? `DECODE(PARAM,'base64')` : 'PARAM'} FROM "$$$$PARAMETER_BUFFER$$$$" WHERE NAME='${
-              query.name
+            `(SELECT ${isBinary ? `DECODE(PARAM,'base64')` : 'PARAM'} FROM "$$$$PARAMETER_BUFFER$$$$" WHERE NAME='${query.name
             }' AND ID=$${i + 1})`,
           )
           return
@@ -288,21 +298,17 @@ GROUP BY k
     if (query.SELECT?.columns?.find(col => col.as === '$mediaContentType')) {
       const columns = query.SELECT.columns
       const index = columns.findIndex(col => query.elements[col.ref?.[col.ref.length - 1]].type === 'cds.LargeBinary')
-      const binary = columns[index]
+      const binary = columns.splice(index, 1)
       // SELECT without binary column
-      columns.splice(index, 1)
-      const { sql, values } = this.cqn2sql(query, data)
-      let ps = this.prepare(sql)
-      let res = await ps.all(values)
-      if (res.length === 0) return
-      res = res.map(r => (typeof r._json_ === 'string' ? JSON.parse(r._json_) : r._json_ || r))[0]
+      let res = await super.onSELECT({ query, data })
+      if (!res) return res
       // SELECT only binary column
-      query.SELECT.columns = [binary]
+      query.SELECT.columns = binary
       const { sql: streamSql, values: valuesStream } = this.cqn2sql(query, data)
-      ps = this.prepare(streamSql)
+      const ps = this.prepare(streamSql)
       const stream = await ps.stream(valuesStream, true)
       // merge results
-      res[binary.as || binary.ref[binary.ref.length - 1]] = stream
+      res[this.class.CQN2SQL.prototype.column_name(binary[0])] = stream
       return res
     }
     return super.onSELECT({ query, data })
@@ -364,7 +370,8 @@ GROUP BY k
       return super.column_alias4(x, q)
     }
 
-    SELECT_expand({ SELECT }, sql) {
+    SELECT_expand(q, sql) {
+      const { SELECT } = q
       if (!SELECT.columns) return sql
       const queryAlias = this.quote(SELECT.from?.as || (SELECT.expand === 'root' && 'root'))
       const cols = SELECT.columns.map(x => {
@@ -379,10 +386,22 @@ GROUP BY k
         }
         return col
       })
+      const isRoot = SELECT.expand === 'root'
+      const isSimple = cds.env.features.sql_simple_queries &&
+        isRoot && // Simple queries are only allowed to have a root
+        !Object.keys(q.elements).some(e =>
+          q.elements[e].isAssociation || // Indicates columns contains an expand
+          q.elements[e].$assocExpand || // REVISIT: sometimes associations are structs
+          q.elements[e].items // Array types require to be inlined with a json result
+        )
+
+      const subQuery = `SELECT ${cols} FROM (${sql}) as ${queryAlias}`
+      if (isSimple) return subQuery
+
       // REVISIT: Remove SELECT ${cols} by adjusting SELECT_columns
       let obj = `to_jsonb(${queryAlias}.*)`
-      return `SELECT ${SELECT.one || SELECT.expand === 'root' ? obj : `coalesce(jsonb_agg (${obj}),'[]'::jsonb)`
-        } as _json_ FROM (SELECT ${cols} FROM (${sql}) as ${queryAlias}) as ${queryAlias}`
+      return `SELECT ${SELECT.one || isRoot ? obj : `coalesce(jsonb_agg (${obj}),'[]'::jsonb)`
+        } as _json_ FROM (${subQuery}) as ${queryAlias}`
     }
 
     doubleQuote(name) {
@@ -397,8 +416,8 @@ GROUP BY k
         // Adjusts json path expressions to be postgres specific
         .replace(/->>'\$(?:(?:\."(.*?)")|(?:\[(\d*)\]))'/g, (a, b, c) => (b ? `->>'${b}'` : `->>${c}`))
         // Adjusts json function to be postgres specific
-        .replace('json_each(?)', 'jsonb_array_elements($1::jsonb)')
-        .replace(/json_type\((\w+),'\$\."(\w+)"'\)/g, (_a, b, c) => `jsonb_typeof(${b}->'${c}')`))
+        .replace('json_each(?)', 'json_array_elements($1::json)')
+        .replace(/json_type\((\w+),'\$\."(\w+)"'\)/g, (_a, b, c) => `json_typeof(${b}->'${c}')`))
     }
 
     param({ ref }) {
@@ -431,11 +450,19 @@ GROUP BY k
       return 'FOR SHARE'
     }
 
+    // Postgres requires own quote function, becuase the effective name is lower case
+    quote(s) {
+      if (typeof s !== 'string') return '"' + s + '"'
+      if (s.includes('"')) return '"' + s.replace(/"/g, '""').toLowerCase() + '"'
+      if (s in this.class.ReservedWords || !/^[A-Za-z_][A-Za-z_$0-9]*$/.test(s)) return '"' + s.toLowerCase() + '"'
+      return s
+    }
+
     defaultValue(defaultValue = this.context.timestamp.toISOString()) {
       return this.string(`${defaultValue}`)
     }
 
-    static Functions = { ...super.Functions, ...require('./func') }
+    static Functions = { ...super.Functions, ...require('./cql-functions') }
 
     static ReservedWords = { ...super.ReservedWords, ...require('./ReservedWords.json') }
 
@@ -443,6 +470,7 @@ GROUP BY k
       ...super.TypeMap,
       // REVISIT: check whether we should use native UUID support
       UUID: () => `VARCHAR(36)`,
+      UInt8: () => `INT`,
       String: e => `VARCHAR(${e.length || 5000})`,
       Binary: () => `BYTEA`,
       Double: () => 'FLOAT8',
@@ -452,6 +480,13 @@ GROUP BY k
       Time: () => 'TIME',
       DateTime: () => 'TIMESTAMP',
       Timestamp: () => 'TIMESTAMP',
+
+      // HANA Types
+      'cds.hana.CLOB': () => 'BYTEA',
+      'cds.hana.BINARY': () => 'BYTEA',
+      'cds.hana.TINYINT': () => 'SMALLINT',
+      'cds.hana.ST_POINT': () => 'POINT',
+      'cds.hana.ST_GEOMETRY': () => 'POLYGON',
     }
 
     // Used for INSERT statements
@@ -472,6 +507,12 @@ GROUP BY k
       DecimalFloat: (e, t) => `CAST(${e} as decimal${t.precision && t.scale ? `(${t.precision},${t.scale})` : ''})`,
       Binary: e => `DECODE(${e},'base64')`,
       LargeBinary: e => `DECODE(${e},'base64')`,
+
+      // HANA Types
+      'cds.hana.CLOB': e => `DECODE(${e},'base64')`,
+      'cds.hana.BINARY': e => `DECODE(${e},'base64')`,
+      'cds.hana.ST_POINT': e => `POINT(((${e})::json->>'x')::float, ((${e})::json->>'y')::float)`,
+      'cds.hana.ST_GEOMETRY': e => `POLYGON(${e})`,
     }
 
     static OutputConverters = {
@@ -487,6 +528,14 @@ GROUP BY k
       Association: e => `jsonb(${e})`,
       struct: e => `jsonb(${e})`,
       array: e => `jsonb(${e})`,
+      // Reading int64 as string to not loose precision
+      Int64: cds.env.features.ieee754compatible ? expr => `cast(${expr} as varchar)` : undefined,
+      // REVISIT: always cast to string in next major
+      // Reading decimal as string to not loose precision
+      Decimal: cds.env.features.ieee754compatible ? expr => `cast(${expr} as varchar)` : undefined,
+
+      // Convert point back to json format
+      'cds.hana.ST_POINT': expr => `CASE WHEN (${expr}) IS NOT NULL THEN json_object('x':(${expr})[0],'y':(${expr})[1])::varchar END`,
     }
   }
 
@@ -517,7 +566,7 @@ GROUP BY k
         GRANT "${creds.usergroup}" TO "${creds.user}" WITH ADMIN OPTION;
       `)
       await this.exec(`CREATE DATABASE "${creds.database}" OWNER="${creds.user}" TEMPLATE=template0`)
-    } catch (e) {
+    } catch {
       // Failed to reset database
     } finally {
       await this.dbc.end()
@@ -561,7 +610,7 @@ GROUP BY k
       // Create new schema using schema owner
       await this.tx(async tx => {
         await tx.run(`DROP SCHEMA IF EXISTS "${creds.schema}" CASCADE`)
-        if (!clean) await tx.run(`CREATE SCHEMA "${creds.schema}" AUTHORIZATION "${creds.user}"`).catch(() => {})
+        if (!clean) await tx.run(`CREATE SCHEMA "${creds.schema}" AUTHORIZATION "${creds.user}"`).catch(() => { })
       })
     } finally {
       await this.disconnect()
@@ -589,7 +638,7 @@ class QueryStream extends Query {
           })
           this.connection.flush()
         }
-        : () => {},
+        : () => { },
     })
     this.push = this.stream.push.bind(this.stream)
 
@@ -704,7 +753,7 @@ class ParameterStream extends Writable {
   }
 
   // Used by the client to handle timeouts
-  callback() {}
+  callback() { }
 
   _write(chunk, enc, cb) {
     return this.flush(chunk, cb)

package/lib/{func.js → cql-functions.js}

@@ -6,10 +6,11 @@ const StandardFunctions = {
     if (x.val === '$now') sql += '::timestamp'
     return sql
   },
-  countdistinct: x => `count(distinct ${x || '*'})`,
+  count: x => `count(${x?.val || x || '*'})`,
+  countdistinct: x => `count(distinct ${x.val || x || '*'})`,
   contains: (...args) => `(coalesce(strpos(${args}),0) > 0)`,
-  indexof: (x, y) => `strpos(${x},${y}) - 1`, // sqlite instr is 1 indexed
-  startswith: (x, y) => `strpos(${x},${y}) = 1`, // sqlite instr is 1 indexed
+  indexof: (x, y) => `strpos(${x},${y}) - 1`, // strpos is 1 indexed
+  startswith: (x, y) => `strpos(${x},${y}) = 1`, // strpos is 1 indexed
   endswith: (x, y) => `substr(${x},length(${x}) + 1 - length(${y})) = ${y}`,
   matchesPattern: (x, y) => `regexp_like(${x}, ${y})`,
   matchespattern: (x, y) => `regexp_like(${x}, ${y})`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/postgres",
-  "version": "1.7.0",
+  "version": "1.9.1",
   "description": "CDS database service for Postgres",
   "homepage": "https://github.com/cap-js/cds-dbs/tree/main/postgres#cds-database-service-for-postgres",
   "repository": {
@@ -22,16 +22,12 @@
     "lib",
     "CHANGELOG.md"
   ],
-  "engines": {
-    "node": ">=16",
-    "npm": ">=8"
-  },
   "scripts": {
     "test": "npm start && jest --silent",
     "start": "docker-compose -f pg-stack.yml up -d"
   },
   "dependencies": {
-    "@cap-js/db-service": "^1.7.0",
+    "@cap-js/db-service": "^1.9.0",
     "pg": "^8"
   },
   "peerDependencies": {