@cap-js/postgres 1.5.0 → 1.6.0

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.6.0](https://github.com/cap-js/cds-dbs/compare/postgres-v1.5.1...postgres-v1.6.0) (2024-03-22)
+
+
+### Added
+
+* also support lowercase matchespattern function ([#528](https://github.com/cap-js/cds-dbs/issues/528)) ([6ea574e](https://github.com/cap-js/cds-dbs/commit/6ea574ee67ef5e42e4f8ccbe4fe91b46097de129))
+* forUpdate and forShareLock ([#148](https://github.com/cap-js/cds-dbs/issues/148)) ([99a1170](https://github.com/cap-js/cds-dbs/commit/99a1170e61de4fd0c505834c25a9c03fc34da85b))
+
+
+### Changed
+
+* use new cds build API @sap/cds-dk >= 7.5.0 ([#508](https://github.com/cap-js/cds-dbs/issues/508)) ([ef22ebe](https://github.com/cap-js/cds-dbs/commit/ef22ebe68c6a554d4042a0a19bae3b2e1d56cb01))
+* this package now requires `@cap-js/db-service >= v1.7.0` ([#545](https://github.com/cap-js/cds-dbs/issues/545)) ([2cec27d](https://github.com/cap-js/cds-dbs/commit/2cec27d91402804c3b2da25cc7169f0d81a7406a))
+
+## [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)
 
 

package/cds-plugin.js

@@ -1,11 +1,48 @@
 const cds = require('@sap/cds')
+const { fs, path } = cds.utils
 
 if (!cds.env.fiori.lean_draft) {
   throw new Error('"@cap-js/postgres" only works if cds.fiori.lean_draft is enabled. Please adapt your configuration.')
 }
 
-// requires @sap/cds-dk version >= 7.3.2
-cds.build?.register?.('postgres', {
-  impl: '@cap-js/postgres/lib/build.js',
-  taskDefaults: { src: cds.env.folders.db }
+// requires @sap/cds-dk version >= 7.5.0
+cds.build?.register?.('postgres', class PostgresBuildPlugin extends cds.build.Plugin {
+  
+  static taskDefaults = { src: cds.env.folders.db }
+  
+  static hasTask() { return cds.requires.db?.kind === 'postgres' }
+
+  init() {
+    // different from the default build output structure
+    this.task.dest = path.join(cds.root, cds.env.build.target !== '.' ? cds.env.build.target : 'gen', 'pg')
+  }
+
+  async build() {
+    const model = await this.model()
+    if (!model) return
+
+    const promises = []
+    if (fs.existsSync(path.join(this.task.src, 'package.json'))) {
+      promises.push(this.copy(path.join(this.task.src, 'package.json')).to('package.json'))
+    } else {
+      promises.push(
+        this.write({
+          dependencies: { '@sap/cds': '^7', '@cap-js/postgres': '^1' },
+          scripts: { start: 'cds-deploy' },
+        }).to('package.json'),
+      )
+    }
+    promises.push(this.write(cds.compile.to.json(model)).to(path.join('db', 'csn.json')))
+
+    let data
+    if (fs.existsSync(path.join(this.task.src, 'data'))) {
+      data = 'data'
+    } else if (fs.existsSync(path.join(this.task.src, 'csv'))) {
+      data = 'csv'
+    }
+    if (data) {
+      promises.push(this.copy(data).to(path.join('db', 'data')))
+    }
+    return Promise.all(promises)
+  }
 })

package/lib/PostgresService.js

@@ -308,14 +308,30 @@ GROUP BY k
     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'),
       )
     }
@@ -365,9 +381,8 @@ GROUP BY k
       })
       // 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 || SELECT.expand === 'root' ? obj : `coalesce(jsonb_agg (${obj}),'[]'::jsonb)`
+        } as _json_ FROM (SELECT ${cols} FROM (${sql}) as ${queryAlias}) as ${queryAlias}`
     }
 
     doubleQuote(name) {
@@ -402,6 +417,20 @@ GROUP BY k
       else return super.operator(x, i, xpr)
     }
 
+    // Postgres does not support locking columns only tables which makes of unapplicable
+    // Postgres does not support "wait n" it only supports "nowait"
+    forUpdate(update) {
+      const { wait } = update
+      if (wait === 0) return 'FOR UPDATE NOWAIT'
+      return 'FOR UPDATE'
+    }
+
+    forShareLock(lock) {
+      const { wait } = lock
+      if (wait === 0) return 'FOR SHARE NOWAIT'
+      return 'FOR SHARE'
+    }
+
     defaultValue(defaultValue = this.context.timestamp.toISOString()) {
       return this.string(`${defaultValue}`)
     }
@@ -455,6 +484,7 @@ 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"')`,
+      Association: e => `jsonb(${e})`,
       struct: e => `jsonb(${e})`,
       array: e => `jsonb(${e})`,
     }
@@ -551,14 +581,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)
@@ -739,4 +769,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/lib/func.js

@@ -11,6 +11,8 @@ const StandardFunctions = {
   indexof: (x, y) => `strpos(${x},${y}) - 1`, // sqlite instr is 1 indexed
   startswith: (x, y) => `strpos(${x},${y}) = 1`, // sqlite instr 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})`,
 
   // Date and Time Functions
   year: x => `date_part('year', ${castVal(x)})`,

package/package.json

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

package/lib/build.js

@@ -1,42 +0,0 @@
-const cds = require('@sap/cds')
-const { fs, path } = cds.utils
-
-module.exports = class PostgresBuildPlugin extends cds.build.BuildPlugin {
-  static hasTask() {
-    return cds.requires.db?.kind === 'postgres'
-  }
-
-  init() {
-    // different from the default build output structure
-    this.task.dest = path.join(cds.root, cds.env.build.target !== '.' ? cds.env.build.target : 'gen', 'pg')
-  }
-
-  async build() {
-    const model = await this.model()
-    if (!model) return
-
-    const promises = []
-    if (fs.existsSync(path.join(this.task.src, 'package.json'))) {
-      promises.push(this.copy(path.join(this.task.src, 'package.json')).to('package.json'))
-    } else {
-      promises.push(
-        this.write({
-          dependencies: { '@sap/cds': '^7', '@cap-js/postgres': '^1' },
-          scripts: { start: 'cds-deploy' },
-        }).to('package.json'),
-      )
-    }
-    promises.push(this.write(cds.compile.to.json(model)).to(path.join('db', 'csn.json')))
-
-    let data
-    if (fs.existsSync(path.join(this.task.src, 'data'))) {
-      data = 'data'
-    } else if (fs.existsSync(path.join(this.task.src, 'csv'))) {
-      data = 'csv'
-    }
-    if (data) {
-      promises.push(this.copy(data).to(path.join('db', 'data')))
-    }
-    return Promise.all(promises)
-  }
-}