@cap-js/postgres 1.4.1 → 1.5.1

package/CHANGELOG.md

@@ -4,6 +4,27 @@
 - 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/postgres-v1.5.0...postgres-v1.5.1) (2024-02-16)
+
+
+### Fixed
+
+* **`sqlite`:** Retain Error object for unique constraint violation ([#446](https://github.com/cap-js/cds-dbs/issues/446)) ([d27ee79](https://github.com/cap-js/cds-dbs/commit/d27ee79b4c4eea8522bf5dd2a288638f54029567))
+
+## [1.5.0](https://github.com/cap-js/cds-dbs/compare/postgres-v1.4.1...postgres-v1.5.0) (2024-02-02)
+
+
+### Added
+
+* SELECT returns LargeBinaries as streams unless feature flag "stream_compat" is set ([#251](https://github.com/cap-js/cds-dbs/issues/251)) ([8165a4a](https://github.com/cap-js/cds-dbs/commit/8165a4a3f6bb21c970668c8873f9d9c662b43780))
+* Support Readable Streams inside INSERT.entries ([#343](https://github.com/cap-js/cds-dbs/issues/343)) ([f6faf89](https://github.com/cap-js/cds-dbs/commit/f6faf8955b7888479c66f1727ade65b382611c2f))
+
+
+### Fixed
+
+* switch Postgres from json to jsonb ([#402](https://github.com/cap-js/cds-dbs/issues/402)) ([c98a964](https://github.com/cap-js/cds-dbs/commit/c98a964a34232267aece337dc6f6bedf03e9891a))
+* UPSERT for @cap-js/hana for entities with multiple keys ([#418](https://github.com/cap-js/cds-dbs/issues/418)) ([9bbac6e](https://github.com/cap-js/cds-dbs/commit/9bbac6ebbbddfa2f620833ce195eedeb0a79f43e))
+
 ## [1.4.1](https://github.com/cap-js/cds-dbs/compare/postgres-v1.4.0...postgres-v1.4.1) (2023-11-24)
 
 

package/lib/PostgresService.js

@@ -13,6 +13,7 @@ class PostgresService extends SQLService {
       cds.options.dialect = 'postgres'
     }
     this.kind = 'postgres'
+    this._queryCache = {}
     return super.init(...arguments)
   }
 
@@ -78,7 +79,7 @@ class PostgresService extends SQLService {
     }
 
     return Promise.all([
-      (await this.prepare(`SELECT set_config(key::text,$1->>key,false) FROM json_each($1);`)).run([
+      (await this.prepare(`SELECT set_config(key::text,$1->>key,false) FROM jsonb_each($1);`)).run([
         JSON.stringify(env),
       ]),
       ...(this.options?.credentials?.schema
@@ -135,12 +136,13 @@ GROUP BY k
   }
 
   prepare(sql) {
-    const query = {
+    // Track queries name for postgres referencing prepare statements
+    // sha1 as it needs to be less then 63 character
+    const sha = crypto.createHash('sha1').update(sql).digest('hex')
+    const query = this._queryCache[sha] = this._queryCache[sha] || {
       _streams: 0,
       text: sql,
-      // Track queries name for postgres referencing prepare statements
-      // sha1 as it needs to be less then 63 characters
-      name: crypto.createHash('sha1').update(sql).digest('hex'),
+      name: sha,
     }
     return {
       run: async values => {
@@ -194,7 +196,7 @@ GROUP BY k
       values.forEach((value, i) => {
         if (value instanceof Readable) {
           const streamID = query._streams++
-          const isBinary = value.type === 'binary'
+          const isBinary = value.type !== 'json'
           const paramStream = new ParameterStream(query.name, streamID)
           if (isBinary) value.setEncoding('base64')
           value.pipe(paramStream)
@@ -281,14 +283,55 @@ GROUP BY k
     return super.onPlainSQL(req, next)
   }
 
+  async onSELECT({ query, data }) {
+    // workaround for chunking odata streaming
+    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]
+      // 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]
+      // SELECT only binary column
+      query.SELECT.columns = [binary]
+      const { sql: streamSql, values: valuesStream } = this.cqn2sql(query, data)
+      ps = this.prepare(streamSql)
+      const stream = await ps.stream(valuesStream, true)
+      // merge results
+      res[binary.as || binary.ref[binary.ref.length - 1]] = stream
+      return res
+    }
+    return super.onSELECT({ query, data })
+  }
+
+  async onINSERT(req) {
+    try {
+      return await super.onINSERT(req)
+    } catch (err) {
+      throw _not_unique(err, 'ENTITY_ALREADY_EXISTS')
+    }
+  }
+
+  async onUPDATE(req) {
+    try {
+      return await super.onUPDATE(req)
+    } catch (err) {
+      throw _not_unique(err, 'UNIQUE_CONSTRAINT_VIOLATION')
+    }
+  }
+
   static CQN2SQL = class CQN2Postgres extends SQLService.CQN2SQL {
     _orderBy(orderBy, localized, locale) {
       return orderBy.map(
         localized
           ? c =>
-              this.expr(c) +
-              (c.element?.[this.class._localized] ? ` COLLATE "${locale}"` : '') +
-              (c.sort === 'desc' || c.sort === -1 ? ' DESC' : ' ASC')
+            this.expr(c) +
+            (c.element?.[this.class._localized] ? ` COLLATE "${locale}"` : '') +
+            (c.sort === 'desc' || c.sort === -1 ? ' DESC' : ' ASC')
           : c => this.expr(c) + (c.sort === 'desc' || c.sort === -1 ? ' DESC' : ' ASC'),
       )
     }
@@ -337,10 +380,9 @@ GROUP BY k
         return col
       })
       // REVISIT: Remove SELECT ${cols} by adjusting SELECT_columns
-      let obj = `row_to_json(${queryAlias}.*)`
-      return `SELECT ${
-        SELECT.one || SELECT.expand === 'root' ? obj : `coalesce(json_agg(${obj}),'[]'::json)`
-      } as _json_ FROM (SELECT ${cols} FROM (${sql}) as ${queryAlias}) as ${queryAlias}`
+      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}`
     }
 
     doubleQuote(name) {
@@ -355,8 +397,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(?)', 'json_array_elements($1::JSON)')
-        .replace(/json_type\((\w+),'\$\."(\w+)"'\)/g, (_a, b, c) => `json_typeof(${b}->'${c}')`))
+        .replace('json_each(?)', 'jsonb_array_elements($1::jsonb)')
+        .replace(/json_type\((\w+),'\$\."(\w+)"'\)/g, (_a, b, c) => `jsonb_typeof(${b}->'${c}')`))
     }
 
     param({ ref }) {
@@ -428,8 +470,9 @@ GROUP BY k
       Timestamp: e => `to_char(${e}, 'YYYY-MM-DD"T"HH24:MI:SS.FF3"Z"')`,
       UTCDateTime: e => `to_char(${e}, 'YYYY-MM-DD"T"HH24:MI:SS"Z"')`,
       UTCTimestamp: e => `to_char(${e}, 'YYYY-MM-DD"T"HH24:MI:SS.FF3"Z"')`,
-      struct: e => `json(${e})`,
-      array: e => `json(${e})`,
+      Association: e => `jsonb(${e})`,
+      struct: e => `jsonb(${e})`,
+      array: e => `jsonb(${e})`,
     }
   }
 
@@ -457,6 +500,7 @@ GROUP BY k
         DROP USER IF EXISTS "${creds.user}";
         CREATE GROUP "${creds.usergroup}";
         CREATE USER "${creds.user}" WITH CREATEROLE IN GROUP "${creds.usergroup}" PASSWORD '${creds.user}';
+        GRANT "${creds.usergroup}" TO "${creds.user}" WITH ADMIN OPTION;
       `)
       await this.exec(`CREATE DATABASE "${creds.database}" OWNER="${creds.user}" TEMPLATE=template0`)
     } catch (e) {
@@ -523,14 +567,14 @@ class QueryStream extends Query {
     this.stream = new Readable({
       read: this.rows
         ? () => {
-            this.stream.pause()
-            // Request more rows
-            this.connection.execute({
-              portal: this.portal,
-              rows: this.rows,
-            })
-            this.connection.flush()
-          }
+          this.stream.pause()
+          // Request more rows
+          this.connection.execute({
+            portal: this.portal,
+            rows: this.rows,
+          })
+          this.connection.flush()
+        }
         : () => {},
     })
     this.push = this.stream.push.bind(this.stream)
@@ -711,4 +755,14 @@ class ParameterStream extends Writable {
   }
 }
 
+function _not_unique(err, code) {
+  if (err.code === '23505')
+    return Object.assign(err, {
+      originalMessage: err.message, // FIXME: required because of next line
+      message: code, // FIXME: misusing message as code
+      code: 400, // FIXME: misusing code as (http) status
+    })
+  return err
+}
+
 module.exports = PostgresService

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/postgres",
-  "version": "1.4.1",
+  "version": "1.5.1",
   "description": "CDS database service for Postgres",
   "homepage": "https://github.com/cap-js/cds-dbs/tree/main/postgres#cds-database-service-for-postgres",
   "repository": {
@@ -31,11 +31,11 @@
     "start": "docker-compose -f pg-stack.yml up -d"
   },
   "dependencies": {
-    "@cap-js/db-service": "^1.3.1",
+    "@cap-js/db-service": "^1.6.0",
     "pg": "^8"
   },
   "peerDependencies": {
-    "@sap/cds": ">=7",
+    "@sap/cds": ">=7.6",
     "@sap/cds-dk": ">=7"
   },
   "peerDependenciesMeta": {