@cap-js/postgres 1.11.1 → 1.13.0

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.13.0](https://github.com/cap-js/cds-dbs/compare/postgres-v1.12.0...postgres-v1.13.0) (2025-03-31)
+
+
+### Added
+
+* **collate:** only collate if locale is provided ([#1060](https://github.com/cap-js/cds-dbs/issues/1060)) ([dedd768](https://github.com/cap-js/cds-dbs/commit/dedd768c085aa29be0e38db11f11678ff55d5b7b))
+* **forUpdate:** ignore locked ([#1074](https://github.com/cap-js/cds-dbs/issues/1074)) ([163480b](https://github.com/cap-js/cds-dbs/commit/163480b245b18a2829cd871c2f053c82bcc1abef))
+
+
+### Fixed
+
+* consider `nulls first | last` on `orderBy` ([#1064](https://github.com/cap-js/cds-dbs/issues/1064)) ([c6bed60](https://github.com/cap-js/cds-dbs/commit/c6bed60f0d93b9f4a73c976727f30172707c60d9)), closes [#1062](https://github.com/cap-js/cds-dbs/issues/1062)
+* Persist assert_integrity feature ([#1032](https://github.com/cap-js/cds-dbs/issues/1032)) ([2956279](https://github.com/cap-js/cds-dbs/commit/2956279777ac94330c98373d8bca32cf0f8e967e))
+
+## [1.12.0](https://github.com/cap-js/cds-dbs/compare/postgres-v1.11.1...postgres-v1.12.0) (2025-03-04)
+
+
+### Added
+
+* pass through of  arbitrary client options ([#1024](https://github.com/cap-js/cds-dbs/issues/1024)) ([b090ccd](https://github.com/cap-js/cds-dbs/commit/b090ccda2dfd4fa535aa0fd5be9d2fc27531db05))
+
+
+### Fixed
+
+* `expand@odata.count` queries ([#966](https://github.com/cap-js/cds-dbs/issues/966)) ([6607a84](https://github.com/cap-js/cds-dbs/commit/6607a8404aa70f2f3f7c6c65c7e9b1c324a5230b))
+
 ## [1.11.1](https://github.com/cap-js/cds-dbs/compare/postgres-v1.11.0...postgres-v1.11.1) (2025-02-09)
 
 

package/cds-plugin.js

@@ -25,11 +25,23 @@ cds.build?.register?.('postgres', class PostgresBuildPlugin extends cds.build.Pl
     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': '^8', '@cap-js/postgres': '^1' },
-          scripts: { start: 'cds-deploy' },
-        }).to('package.json'),
+      const packageJson = {
+        dependencies: {
+          '@sap/cds': '^8',
+          '@cap-js/postgres': '^1'
+        },
+        scripts: {
+          start: 'cds-deploy'
+        }
+      }
+      const assertIntegrity = cds.env?.features?.assert_integrity
+      if (assertIntegrity) {
+        packageJson.cds ??= {}
+        packageJson.cds.features ??= {}
+        packageJson.cds.features.assert_integrity = assertIntegrity
+      }
+      promises.push(        
+        this.write(packageJson).to('package.json')
       )
     }
     promises.push(this.write(cds.compile.to.json(model)).to(path.join('db', 'csn.json')))

package/lib/PostgresService.js

@@ -28,7 +28,7 @@ class PostgresService extends SQLService {
         ...this.options.pool,
       },
       create: async () => {
-        const cr = this.options.credentials || {}
+        const { credentials: cr = {}, client: clientOptions = {} } = this.options
         const credentials = {
           // Cloud Foundry provides the user in the field username the pg npm module expects user
           user: cr.username || cr.user,
@@ -49,7 +49,7 @@ class PostgresService extends SQLService {
               ca: cr.sslrootcert,
             }),
         }
-        const dbc = new Client(credentials)
+        const dbc = new Client({...credentials, ...clientOptions})
         await dbc.connect()
         return dbc
       },
@@ -344,14 +344,15 @@ GROUP BY k
 
   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?.toLowerCase() === 'desc' || c.sort === -1 ? ' DESC NULLS LAST' : ' ASC NULLS FIRST')
-          : c => this.expr(c) + (c.sort?.toLowerCase() === 'desc' || c.sort === -1 ? ' DESC NULLS LAST' : ' ASC NULLS FIRST'),
-      )
+      return orderBy.map(c => {
+        const nulls = c.nulls || (c.sort?.toLowerCase() === 'desc' || c.sort === -1 ? 'LAST' : 'FIRST')
+        const o = localized
+          ? this.expr(c) +
+            (c.element?.[this.class._localized] && locale ? ` COLLATE "${locale}"` : '') +
+            (c.sort?.toLowerCase() === 'desc' || c.sort === -1 ? ' DESC' : ' ASC')
+          : this.expr(c) + (c.sort?.toLowerCase() === 'desc' || c.sort === -1 ? ' DESC' : ' ASC')
+        return o + ' NULLS ' + (nulls.toLowerCase() === 'first' ? 'FIRST' : 'LAST')
+      })
     }
 
     orderBy(orderBy) {
@@ -389,14 +390,7 @@ GROUP BY k
       const cols = SELECT.columns.map(x => {
         const name = this.column_name(x)
         const outputConverter = this.output_converter4(x.element, `${queryAlias}.${this.quote(name)}`)
-        let col = `${outputConverter} as ${this.doubleQuote(name)}`
-
-        if (x.SELECT?.count) {
-          // Return both the sub select and the count for @odata.count
-          const qc = cds.ql.clone(x, { columns: [{ func: 'count' }], one: 1, limit: 0, orderBy: 0 })
-          col += `,${this.expr(qc)} as ${this.doubleQuote(`${name}@odata.count`)}`
-        }
-        return col
+        return `${outputConverter} as ${this.doubleQuote(name)}`
       })
       const isRoot = SELECT.expand === 'root'
       const isSimple = cds.env.features.sql_simple_queries &&
@@ -472,9 +466,11 @@ GROUP BY k
     // 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'
+      const { wait, ignoreLocked } = update
+      let sql = 'FOR UPDATE'
+      if (wait === 0) sql += ' NOWAIT'
+      if (ignoreLocked) sql += ' SKIP LOCKED'
+      return sql
     }
 
     forShareLock(lock) {

package/lib/cql-functions.js

@@ -1,66 +1,175 @@
+'use strict'
+
 const session = require('./session.json')
 
 const StandardFunctions = {
+  // ==============================
+  // Session Context Functions
+  // ==============================
+
+  /**
+   * Generates SQL statement to retrieve session context
+   * @param {Object} x - Object containing the session variable
+   * @returns {string} - SQL statement
+   */
   session_context: x => {
     let sql = `current_setting('${session[x.val] || x.val}')`
     if (x.val === '$now') sql += '::timestamp'
     return sql
   },
-  count: x => `count(${x?.val || x || '*'})`,
-  countdistinct: x => `count(distinct ${x.val || x || '*'})`,
+
+  // ==============================
+  // String Functions
+  // ==============================
+
+  /**
+   * Generates SQL statement that checks if one string contains another
+   * @param  {...string} args - The strings to evaluate
+   * @returns {string} - SQL statement
+   */
   contains: (...args) => `(coalesce(strpos(${args}),0) > 0)`,
+
+  /**
+   * Generates SQL statement for the index of the first occurrence of one string in another
+   * @param {string} x - The string to search
+   * @param {string} y - The substring to find
+   * @returns {string} - SQL statement
+   */
   indexof: (x, y) => `strpos(${x},${y}) - 1`, // strpos is 1 indexed
-  startswith: (x, y) => `coalesce(strpos(${x},${y}) = 1,false)`, // strpos is 1 indexed
+
+  /**
+   * Generates SQL statement that checks if a string starts with another string
+   * @param {string} x - The string to evaluate
+   * @param {string} y - The prefix to check
+   * @returns {string} - SQL statement
+   */
+  startswith: (x, y) => `coalesce(strpos(${x},${y}) = 1,false)`,
+
+  /**
+   * Generates SQL statement that checks if a string ends with another string
+   * @param {string} x - The string to evaluate
+   * @param {string} y - The suffix to check
+   * @returns {string} - SQL statement
+   */
   endswith: (x, y) => `coalesce(substr(${x},length(${x}) + 1 - length(${y})) = ${y},false)`,
+
+  /**
+   * Generates SQL statement to match a string against a regular expression
+   * @param {string} x - The string to match
+   * @param {string} y - The regular expression
+   * @returns {string} - SQL statement
+   */
   matchesPattern: (x, y) => `regexp_like(${x}, ${y})`,
+
+  /**
+   * Alias for matchesPattern
+   * @param {string} x - The string to match
+   * @param {string} y - The regular expression
+   * @returns {string} - SQL statement
+   */
   matchespattern: (x, y) => `regexp_like(${x}, ${y})`,
 
+  // ==============================
   // Date and Time Functions
+  // ==============================
+
+  /**
+   * Generates SQL statement for the year part of a date
+   * @param {string} x - The date input
+   * @returns {string} - SQL statement
+   */
   year: x => `date_part('year', ${castVal(x)})`,
+
+  /**
+   * Generates SQL statement for the month part of a date
+   * @param {string} x - The date input
+   * @returns {string} - SQL statement
+   */
   month: x => `date_part('month', ${castVal(x)})`,
+
+  /**
+   * Generates SQL statement for the day part of a date
+   * @param {string} x - The date input
+   * @returns {string} - SQL statement
+   */
   day: x => `date_part('day', ${castVal(x)})`,
+
+  /**
+   * Generates SQL statement to extract time from a date
+   * @param {string} x - The date input
+   * @returns {string} - SQL statement
+   */
   time: x => `to_char(${castVal(x)}, 'HH24:MI:SS')`,
+
+  /**
+   * Generates SQL statement for the hour part of a date
+   * @param {string} x - The date input
+   * @returns {string} - SQL statement
+   */
   hour: x => `date_part('hour', ${castVal(x)})`,
+
+  /**
+   * Generates SQL statement for the minute part of a date
+   * @param {string} x - The date input
+   * @returns {string} - SQL statement
+   */
   minute: x => `date_part('minute', ${castVal(x)})`,
+
+  /**
+   * Generates SQL statement for the second part of a date
+   * @param {string} x - The date input
+   * @returns {string} - SQL statement
+   */
   second: x => `floor(date_part('second', ${castVal(x)}))`,
-  fractionalseconds: x => `CAST(date_part('second', ${castVal(x)}) - floor(date_part('second', ${castVal(x)})) AS DECIMAL)`,
-  totalseconds: x => `(
-    (
-      (
-        CAST(substring(${x},2,strpos(${x},'DT') - 2) AS INTEGER)
-      ) + (
-        EXTRACT (EPOCH FROM 
-          CAST(
-            replace(
-            replace(
-            replace(
-              substring(${x},strpos(${x},'DT') + 2),
-              'H',':'
-            ),'M',':'
-            ),'S','Z'
-            )
-          as TIME)
-        ) - 0.5
-      )
-    ) * 86400
-  )`,
-  now: function() {
-    return this.session_context({val: '$now'})
-  }
+
+  /**
+   * Generates SQL statement for fractional seconds
+   * @param {string} x - The date input
+   * @returns {string} - SQL statement
+   */
+  fractionalseconds: x =>
+    `CAST(date_part('second', ${castVal(x)}) - floor(date_part('second', ${castVal(x)})) AS DECIMAL)`,
 }
 
 const isTime = /^\d{1,2}:\d{1,2}:\d{1,2}$/
 const isVal = x => x && 'val' in x
-const castVal = (x) => `${x}${isVal(x) ? isTime.test(x.val) ? '::TIME' : '::TIMESTAMP' : ''}`
+const castVal = x => `${x}${isVal(x) ? (isTime.test(x.val) ? '::TIME' : '::TIMESTAMP') : ''}`
 
 const HANAFunctions = {
-  // https://help.sap.com/docs/SAP_HANA_PLATFORM/4fe29514fd584807ac9f2a04f6754767/f12b86a6284c4aeeb449e57eb5dd3ebd.html
+  // ==============================
+  // Time Difference Functions
+  // ==============================
 
-  // Time functions
+  /**
+   * Generates SQL statement for the difference in 100-nanoseconds between two timestamps
+   * @param {string} x - Start timestamp
+   * @param {string} y - End timestamp
+   * @returns {string} - SQL statement
+   */
   nano100_between: (x, y) => `EXTRACT(EPOCH FROM ${y} - ${x}) * 10000000`,
+
+  /**
+   * Generates SQL statement for the difference in seconds between two timestamps
+   * @param {string} x - Start timestamp
+   * @param {string} y - End timestamp
+   * @returns {string} - SQL statement
+   */
   seconds_between: (x, y) => `EXTRACT(EPOCH FROM ${y} - ${x})`,
-  days_between: (x, y) => `EXTRACT(DAY FROM ${y} - ${x})`,
 
+  /**
+   * Generates SQL statement for the difference in days between two timestamps
+   * @param {string} x - Start timestamp
+   * @param {string} y - End timestamp
+   * @returns {string} - SQL statement
+   */
+  days_between: (x, y) => `EXTRACT(DAY FROM ${y}::timestamp - ${x}::timestamp)::integer`,
+
+  /**
+   * Generates SQL statement for the difference in months between two timestamps
+   * @param {string} x - Start timestamp
+   * @param {string} y - End timestamp
+   * @returns {string} - SQL statement
+   */
   months_between: (x, y) => `((
         (EXTRACT(YEAR FROM ${y}) - EXTRACT(YEAR FROM ${x})) * 12
     )+(
@@ -72,6 +181,13 @@ const HANAFunctions = {
             cast((cast( to_char(${y},'DDHH24MISSFF3') as bigint ) < cast( to_char(${x},'DDHH24MISSFF3') as bigint )) as Integer) * -1
         end
     ))`,
+
+  /**
+   * Generates SQL statement for the difference in years between two timestamps
+   * @param {string} x - Start timestamp
+   * @param {string} y - End timestamp
+   * @returns {string} - SQL statement
+   */
   years_between(x, y) {
     return `TRUNC(${this.months_between(x, y)} / 12,0)`
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/postgres",
-  "version": "1.11.1",
+  "version": "1.13.0",
   "description": "CDS database service for Postgres",
   "homepage": "https://github.com/cap-js/cds-dbs/tree/main/postgres#cds-database-service-for-postgres",
   "repository": {
@@ -27,7 +27,7 @@
     "start": "docker compose -f pg-stack.yml up -d"
   },
   "dependencies": {
-    "@cap-js/db-service": "^1.17.0",
+    "@cap-js/db-service": "^1.19.0",
     "pg": "^8"
   },
   "peerDependencies": {