@sqb/postgres-dialect 5.0.6 → 6.0.0

package/README.md

@@ -6,30 +6,25 @@
 
 [![NPM Version][npm-image]][npm-url]
 [![NPM Downloads][downloads-image]][downloads-url]
-[![Build Status][travis-image]][travis-url]
+[![CI Tests][ci-test-image]][ci-test-url]
 [![Test Coverage][coveralls-image]][coveralls-url]
-[![Dependencies][dependencies-image]][dependencies-url]
-[![DevDependencies][devdependencies-image]][devdependencies-url]
-[![Package Quality][quality-image]][quality-url]
 
 ## About SQB
 
 SQB is an extensible, multi-dialect SQL query builder and Database connection wrapper for NodeJS.
 
-## Main goals
+## About @sqb/postgres-dialect
 
-- Single code base for any sql based database
-- Powerful and simplified query coding scheme
-- Fast applications with low memory requirements
-- Let applications work with large data tables efficiently
-- Support latest JavaScript language standards
-- Lightweight and extensible framework.
+This package registers the `postgres` SQL serialization dialect (a `SerializerExtension` for
+[`@sqb/builder`](../builder)) used by [`@sqb/postgres`](../postgres). It is loaded automatically
+when `@sqb/postgres` is imported, so you normally don't need to depend on it directly.
 
-You can report bugs and discuss features on the [GitHub issues](https://github.com/sqbjs/sqb/issues) page
-
-Thanks to all of the great [contributions](https://github.com/sqbjs/sqb/graphs/contributors) to the project.
-
-You may want to check detailed [DOCUMENTATION](https://sqbjs.github.io/sqb/)
+PostgreSQL already speaks close to standard SQL, so this dialect makes fewer changes than most:
+`LIMIT`/`OFFSET` for pagination, `= NULL`/`!= NULL` rewritten to `IS [NOT] NULL`, and Postgres's
+own reserved-word list. It also rewrites the builder's default `:name` named placeholders into
+Postgres's positional `$1, $2, ...` parameter syntax. `RETURNING` is left untouched — Postgres
+supports it natively on `INSERT`, `UPDATE` and `DELETE`, so `@sqb/postgres` reads affected rows
+straight from the statement response with no follow-up query needed.
 
 ## Installation
 
@@ -39,7 +34,7 @@ $ npm install @sqb/postgres-dialect --save
 
 ## Node Compatibility
 
-- node >= 16.x
+- node >= 20.x
 
 ### License
 
@@ -47,17 +42,9 @@ SQB is available under [MIT](LICENSE) license.
 
 [npm-image]: https://img.shields.io/npm/v/@sqb/postgres-dialect.svg
 [npm-url]: https://npmjs.org/package/@sqb/postgres-dialect
-[travis-image]: https://img.shields.io/travis/sqbjs/@sqb/postgres-dialect/master.svg
-[travis-url]: https://travis-ci.org/sqbjs/@sqb/postgres-dialect
-[coveralls-image]: https://img.shields.io/coveralls/sqbjs/@sqb/postgres-dialect/master.svg
-[coveralls-url]: https://coveralls.io/r/sqbjs/@sqb/postgres-dialect
 [downloads-image]: https://img.shields.io/npm/dm/@sqb/postgres-dialect.svg
 [downloads-url]: https://npmjs.org/package/@sqb/postgres-dialect
-[gitter-image]: https://badges.gitter.im/sqbjs/@sqb/postgres-dialect.svg
-[gitter-url]: https://gitter.im/sqbjs/@sqb/postgres-dialect?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
-[dependencies-image]: https://david-dm.org/sqbjs/@sqb/postgres-dialect/status.svg
-[dependencies-url]: https://david-dm.org/sqbjs/@sqb/postgres-dialect
-[devdependencies-image]: https://david-dm.org/sqbjs/@sqb/postgres-dialect/dev-status.svg
-[devdependencies-url]: https://david-dm.org/sqbjs/@sqb/postgres-dialect?type=dev
-[quality-image]: http://npm.packagequality.com/shield/@sqb/postgres-dialect.png
-[quality-url]: http://packagequality.com/#?package=@sqb/postgres-dialect
+[ci-test-image]: https://github.com/panates/sqb/actions/workflows/test.yml/badge.svg
+[ci-test-url]: https://github.com/panates/sqb/actions/workflows/test.yml
+[coveralls-image]: https://coveralls.io/repos/github/sqbjs/sqb/badge.svg?branch=master
+[coveralls-url]: https://coveralls.io/github/sqbjs/sqb?branch=master

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@sqb/postgres-dialect",
   "description": "SQB serialization extension for PostgreSQL database",
-  "version": "5.0.6",
+  "version": "6.0.0",
   "author": "Panates",
   "license": "Apache-2.0",
   "dependencies": {
     "tslib": "^2.8.1"
   },
   "peerDependencies": {
-    "@sqb/builder": "^5.0.6"
+    "@sqb/builder": "^6.0.0"
   },
   "type": "module",
   "module": "./index.js",

package/postgres-serializer.d.ts

@@ -1,7 +1,8 @@
 import { type DefaultSerializeFunction, SerializationType, SerializeContext, type SerializerExtension } from '@sqb/builder';
 export declare class PostgresSerializer implements SerializerExtension {
     dialect: string;
-    isReservedWord(ctx: any, s: any): any;
+    reservedWords: Set<string>;
+    isReservedWord(_: any, s: any): boolean;
     serialize(ctx: SerializeContext, type: SerializationType | string, o: any, defFn: DefaultSerializeFunction): string | undefined;
     private _serializeSelect;
     private _serializeComparison;

package/postgres-serializer.js

@@ -1,9 +1,69 @@
 import { OperatorType, SerializationType, SerializeContext, } from '@sqb/builder';
-const reservedWords = ['comment'];
+// PostgreSQL "reserved" and "reserved (can be function or type)" keywords
+// (https://www.postgresql.org/docs/current/sql-keywords-appendix.html)
+// that are not already covered by SerializeContext's base reservedWords list.
+// Keywords common to all SQL dialects (case, check, union, ...) live in
+// SerializeContext.reservedWords instead of being duplicated here.
+const reservedWords = new Set([
+    'analyse',
+    'analyze',
+    'any',
+    'array',
+    'asymmetric',
+    'binary',
+    'both',
+    'collate',
+    'collation',
+    'comment',
+    'concurrently',
+    'cross',
+    'current_catalog',
+    'current_date',
+    'current_role',
+    'current_schema',
+    'current_time',
+    'current_timestamp',
+    'current_user',
+    'deferrable',
+    'do',
+    'except',
+    'false',
+    'fetch',
+    'freeze',
+    'grant',
+    'initially',
+    'intersect',
+    'isnull',
+    'lateral',
+    'leading',
+    'limit',
+    'localtime',
+    'localtimestamp',
+    'natural',
+    'notnull',
+    'offset',
+    'only',
+    'overlaps',
+    'placing',
+    'returning',
+    'session_user',
+    'similar',
+    'some',
+    'symmetric',
+    'system_user',
+    'tablesample',
+    'trailing',
+    'true',
+    'using',
+    'variadic',
+    'verbose',
+    'window',
+]);
 export class PostgresSerializer {
     dialect = 'postgres';
-    isReservedWord(ctx, s) {
-        return (s && typeof s === 'string' && reservedWords.includes(s.toLowerCase()));
+    reservedWords = reservedWords;
+    isReservedWord(_, s) {
+        return s && typeof s === 'string' && reservedWords.has(s.toLowerCase());
     }
     serialize(ctx, type, o, defFn) {
         switch (type) {
@@ -48,7 +108,7 @@ export class PostgresSerializer {
                     o.right.expression = 'null';
                     o.right.isParam = false;
                 }
-                if (o.operatorType === 'eq')
+                if (o.operatorType === OperatorType.eq)
                     return defFn(ctx, {
                         ...o,
                         operatorType: OperatorType.is,
@@ -73,7 +133,8 @@ export class PostgresSerializer {
                 !Array.isArray(o.right.value)) {
                 o.right.value = [o.right.value];
             }
-            if (o.operatorType === 'in' || o.operatorType === 'notIn') {
+            if (o.operatorType === OperatorType.in ||
+                o.operatorType === OperatorType.notIn) {
                 if (o.left.isArray && !o.right.isArray && o.right.isParam) {
                     const left = o.left;
                     const right = o.right;
@@ -81,13 +142,13 @@ export class PostgresSerializer {
                     return defFn(ctx, {
                         ...o,
                         operatorType: OperatorType.eq,
-                        symbol: o.operatorType === 'notIn' ? '!=' : '=',
+                        symbol: o.operatorType === OperatorType.notIn ? '!=' : '=',
                         left: right,
                         right: left,
                     });
                 }
                 if (o.left.isArray && o.right.isArray) {
-                    if (o.operatorType === 'notIn')
+                    if (o.operatorType === OperatorType.notIn)
                         o.left.expression = 'not ' + o.left.expression;
                     return defFn(ctx, { ...o, symbol: '&&' });
                 }
@@ -96,10 +157,20 @@ export class PostgresSerializer {
                     return defFn(ctx, {
                         ...o,
                         operatorType: OperatorType.eq,
-                        symbol: o.operatorType === 'notIn' ? '!=' : '=',
+                        symbol: o.operatorType === OperatorType.notIn ? '!=' : '=',
                     });
                 }
             }
+            if (o.operatorType === OperatorType.match) {
+                const config = o.customArgs
+                    ? typeof o.customArgs === 'object'
+                        ? o.customArgs
+                        : String(o.customArgs)
+                    : undefined;
+                o.symbol = '@@';
+                o.right.expression = `plainto_tsquery('${(config || 'simple').replace(/'/g, '"')}', ${o.right.expression})`;
+                return defFn(ctx, o);
+            }
         }
         return defFn(ctx, o);
     }