sedentary-pg 0.0.16 → 0.0.17

package/README.md

@@ -29,6 +29,49 @@
 
 # under development
 
-https://www.postgresql.org/support/versioning/
+# Description
 
-https://bucardo.org/postgres_all_versions.html
+The **PostgreSQL** specilized package of [Sedentary](https://www.npmjs.com/package/sedentary).
+
+# Installation
+
+With [npm](https://www.npmjs.com/package/sedentary-pg):
+
+```sh
+$ npm install --save sedentary-pg
+```
+
+# Documentation
+
+The full documentation is on [sedentary.readthedocs.io](https://sedentary.readthedocs.io/).
+
+# Compatibility
+
+Requires:
+
+- Node.js: **v12**
+- TypeScript: **v4.1** (or none if used in a JavaScript project).
+
+The package is tested under [all version combinations](https://app.travis-ci.com/github/iccicci/sedentary-pg)
+of **Node.js** currently supported accordingly to [Node.js Release](https://github.com/nodejs/Release#readme) and of
+**PostgreSQL** currently supported accordingly to
+[PostgreSQL Versioning](https://www.postgresql.org/support/versioning/).
+
+To work with the package under Windows, be sure to configure `bash.exe` as your _script-shell_.
+
+```
+> npm config set script-shell bash.exe
+```
+
+# Licence
+
+[MIT Licence](https://github.com/iccicci/sedentary-pg/blob/master/LICENSE)
+
+# Bugs
+
+Do not hesitate to report any bug or inconsistency [@github](https://github.com/iccicci/sedentary-pg/issues).
+
+# Donating
+
+If you find useful this package, please consider the opportunity to donate some satoshis to this bitcoin address:
+**1Md9WFAHrXTb3yPBwQWmUfv2RmzrtbHioB**

package/index.js

@@ -15,9 +15,9 @@ class SedentaryPG extends sedentary_1.Sedentary {
         this.db = new pgdb_1.PGDB(connection, this.log);
     }
     FKEY(attribute) {
-        const { attributeName, tableName, unique } = attribute;
+        const { attributeName, modelName, unique } = attribute;
         if (!unique)
-            throw new Error(`Sedentary.FKEY: '${tableName}' table: '${attributeName}' attribute: is not unique: can't be used as FKEY target`);
+            throw new Error(`Sedentary.FKEY: '${modelName}' model: '${attributeName}' attribute: is not unique: can't be used as FKEY target`);
         return super.FKEY(attribute);
     }
 }

package/lib/adsrc.d.ts

@@ -0,0 +1 @@
+export declare function adsrc(version: number): "pg_get_expr(pg_attrdef.adbin, pg_attrdef.adrelid) AS adsrc" | "adsrc";

package/lib/adsrc.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adsrc = void 0;
+function adsrc(version) {
+    return version >= 12 ? "pg_get_expr(pg_attrdef.adbin, pg_attrdef.adrelid) AS adsrc" : "adsrc";
+}
+exports.adsrc = adsrc;

package/lib/adsrc.ts

@@ -0,0 +1,3 @@
+export function adsrc(version: number) {
+  return version >= 12 ? "pg_get_expr(pg_attrdef.adbin, pg_attrdef.adrelid) AS adsrc" : "adsrc";
+}

package/lib/pgdb.js

@@ -7,6 +7,7 @@ exports.PGDB = void 0;
 const pg_1 = require("pg");
 const pg_format_1 = __importDefault(require("pg-format"));
 const db_1 = require("sedentary/lib/db");
+const adsrc_1 = require("./adsrc");
 const needDrop = [
     ["DATETIME", "int2"],
     ["DATETIME", "int4"],
@@ -37,8 +38,9 @@ class PGDB extends db_1.DB {
             const constraint = table.constraints.filter(_ => _.constraintName === row.conname);
             if (constraint.length === 0) {
                 const statement = `ALTER TABLE ${table.tableName} DROP CONSTRAINT ${row.conname} CASCADE`;
-                this.log(statement);
-                await this.client.query(statement);
+                this.syncLog(statement);
+                if (this.sync)
+                    await this.client.query(statement);
             }
             else
                 indexes.push(row.conindid);
@@ -47,8 +49,9 @@ class PGDB extends db_1.DB {
     }
     async dropField(tableName, fieldName) {
         const statement = `ALTER TABLE ${tableName} DROP COLUMN ${fieldName}`;
-        this.log(statement);
-        await this.client.query(statement);
+        this.syncLog(statement);
+        if (this.sync)
+            await this.client.query(statement);
     }
     async dropFields(table) {
         const res = await this.client.query("SELECT attname FROM pg_attribute WHERE attrelid = $1 AND attnum > 0 AND attisdropped = false AND attinhcount = 0", [table.oid]);
@@ -79,8 +82,9 @@ class PGDB extends db_1.DB {
         }
         for (const index of Object.keys(iobject).sort()) {
             const statement = `DROP INDEX ${index}`;
-            this.log(statement);
-            await this.client.query(statement);
+            this.syncLog(statement);
+            if (this.sync)
+                await this.client.query(statement);
         }
     }
     async end() {
@@ -132,8 +136,9 @@ class PGDB extends db_1.DB {
                         break;
                 }
                 const statement = `ALTER TABLE ${table.tableName} ADD CONSTRAINT ${constraintName} ${query}`;
-                this.log(statement);
-                await this.client.query(statement);
+                this.syncLog(statement);
+                if (this.sync)
+                    await this.client.query(statement);
             }
         }
     }
@@ -143,34 +148,39 @@ class PGDB extends db_1.DB {
             const { fieldName, notNull, size } = attribute;
             const defaultValue = attribute.defaultValue === undefined ? undefined : (0, pg_format_1.default)("%L", attribute.defaultValue);
             const [base, type] = this.fieldType(attribute);
-            const adsrc = this.version >= 12 ? "pg_get_expr(pg_attrdef.adbin, pg_attrdef.adrelid) AS adsrc" : "adsrc";
-            const res = await this.client.query(`SELECT attnotnull, atttypmod, typname, ${adsrc} FROM pg_type, pg_attribute LEFT JOIN pg_attrdef ON adrelid = attrelid AND adnum = attnum WHERE attrelid = $1 AND attnum > 0 AND atttypid = pg_type.oid AND attislocal = 't' AND attname = $2`, [oid, fieldName]);
+            const where = "attrelid = $1 AND attnum > 0 AND atttypid = pg_type.oid AND attislocal = 't' AND attname = $2";
+            const res = await this.client.query(`SELECT attnotnull, atttypmod, typname, ${(0, adsrc_1.adsrc)(this.version)} FROM pg_type, pg_attribute LEFT JOIN pg_attrdef ON adrelid = attrelid AND adnum = attnum WHERE ${where}`, [oid, fieldName]);
             const addField = async () => {
                 const statement = `ALTER TABLE ${tableName} ADD COLUMN ${fieldName} ${type}`;
-                this.log(statement);
-                await this.client.query(statement);
+                this.syncLog(statement);
+                if (this.sync)
+                    await this.client.query(statement);
             };
             const dropDefault = async () => {
                 const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} DROP DEFAULT`;
-                this.log(statement);
-                await this.client.query(statement);
+                this.syncLog(statement);
+                if (this.sync)
+                    await this.client.query(statement);
             };
             const setNotNull = async (isNull) => {
                 if (isNull === notNull)
                     return;
                 const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} ${notNull ? "SET" : "DROP"} NOT NULL`;
-                this.log(statement);
-                await this.client.query(statement);
+                this.syncLog(statement);
+                if (this.sync)
+                    await this.client.query(statement);
             };
             const setDefault = async (isNull) => {
                 if (defaultValue !== undefined) {
                     let statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} SET DEFAULT ${defaultValue}`;
-                    this.log(statement);
-                    await this.client.query(statement);
+                    this.syncLog(statement);
+                    if (this.sync)
+                        await this.client.query(statement);
                     if (isNull) {
                         statement = `UPDATE ${tableName} SET ${fieldName} = ${defaultValue} WHERE ${fieldName} IS NULL`;
-                        this.log(statement);
-                        this.client.query(statement);
+                        this.syncLog(statement);
+                        if (this.sync)
+                            this.client.query(statement);
                     }
                 }
                 await setNotNull(isNull);
@@ -192,8 +202,9 @@ class PGDB extends db_1.DB {
                             dropDefault();
                         const using = needUsing.filter(([type, name]) => attribute.type === type && typname === name).length ? " USING " + fieldName + "::" + type : "";
                         const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} TYPE ${type}${using}`;
-                        this.log(statement);
-                        await this.client.query(statement);
+                        this.syncLog(statement);
+                        if (this.sync)
+                            await this.client.query(statement);
                         await setDefault(attnotnull);
                     }
                 }
@@ -213,8 +224,9 @@ class PGDB extends db_1.DB {
             const { fields, indexName, type, unique } = index;
             if (!this.indexes.includes(indexName)) {
                 const statement = `CREATE${unique ? " UNIQUE" : ""} INDEX ${indexName} ON ${tableName} USING ${type} (${fields.join(", ")})`;
-                this.log(statement);
-                await this.client.query(statement);
+                this.syncLog(statement);
+                if (this.sync)
+                    await this.client.query(statement);
             }
         }
     }
@@ -222,10 +234,12 @@ class PGDB extends db_1.DB {
         if (!table.autoIncrementOwn)
             return;
         const statement = `ALTER SEQUENCE ${table.tableName}_id_seq OWNED BY ${table.tableName}.id`;
-        this.log(statement);
-        await this.client.query(statement);
+        this.syncLog(statement);
+        if (this.sync)
+            await this.client.query(statement);
     }
     async syncTable(table) {
+        var _a;
         if (table.autoIncrement) {
             await (async () => {
                 try {
@@ -236,8 +250,9 @@ class PGDB extends db_1.DB {
                         return;
                     if (e.code === "42P01") {
                         const statement = `CREATE SEQUENCE ${table.tableName}_id_seq`;
-                        this.log(statement);
-                        await this.client.query(statement);
+                        this.syncLog(statement);
+                        if (this.sync)
+                            await this.client.query(statement);
                         table.autoIncrementOwn = true;
                         return;
                     }
@@ -263,8 +278,9 @@ class PGDB extends db_1.DB {
             if (drop) {
                 const statement = `DROP TABLE ${table.tableName} CASCADE`;
                 create = true;
-                this.log(statement);
-                await this.client.query(statement);
+                this.syncLog(statement);
+                if (this.sync)
+                    await this.client.query(statement);
             }
         }
         else
@@ -272,10 +288,11 @@ class PGDB extends db_1.DB {
         if (create) {
             const parent = table.parent ? ` INHERITS (${table.parent.tableName})` : "";
             const statement = `CREATE TABLE ${table.tableName} ()${parent}`;
-            this.log(statement);
-            await this.client.query(statement);
+            this.syncLog(statement);
+            if (this.sync)
+                await this.client.query(statement);
             const resTable = await this.client.query("SELECT oid FROM pg_class WHERE relname = $1", [table.tableName]);
-            table.oid = resTable.rows[0].oid;
+            table.oid = (_a = resTable.rows[0]) === null || _a === void 0 ? void 0 : _a.oid;
         }
     }
 }

package/lib/pgdb.ts

@@ -1,6 +1,7 @@
 import { Pool, PoolClient, PoolConfig } from "pg";
 import format from "pg-format";
 import { Attribute, DB, Index, Natural, Table } from "sedentary/lib/db";
+import { adsrc } from "./adsrc";
 
 const needDrop = [
   ["DATETIME", "int2"],
@@ -46,8 +47,8 @@ export class PGDB extends DB {
       if(constraint.length === 0) {
         const statement = `ALTER TABLE ${table.tableName} DROP CONSTRAINT ${row.conname} CASCADE`;
 
-        this.log(statement);
-        await this.client.query(statement);
+        this.syncLog(statement);
+        if(this.sync) await this.client.query(statement);
       } else indexes.push(row.conindid);
     }
 
@@ -57,8 +58,8 @@ export class PGDB extends DB {
   async dropField(tableName: string, fieldName: string): Promise<void> {
     const statement = `ALTER TABLE ${tableName} DROP COLUMN ${fieldName}`;
 
-    this.log(statement);
-    await this.client.query(statement);
+    this.syncLog(statement);
+    if(this.sync) await this.client.query(statement);
   }
 
   async dropFields(table: Table): Promise<void> {
@@ -97,8 +98,8 @@ export class PGDB extends DB {
     for(const index of Object.keys(iobject).sort()) {
       const statement = `DROP INDEX ${index}`;
 
-      this.log(statement);
-      await this.client.query(statement);
+      this.syncLog(statement);
+      if(this.sync) await this.client.query(statement);
     }
   }
 
@@ -162,8 +163,8 @@ export class PGDB extends DB {
 
         const statement = `ALTER TABLE ${table.tableName} ADD CONSTRAINT ${constraintName} ${query}`;
 
-        this.log(statement);
-        await this.client.query(statement);
+        this.syncLog(statement);
+        if(this.sync) await this.client.query(statement);
       }
     }
   }
@@ -175,25 +176,25 @@ export class PGDB extends DB {
       const { fieldName, notNull, size } = attribute;
       const defaultValue = attribute.defaultValue === undefined ? undefined : format("%L", attribute.defaultValue);
       const [base, type] = this.fieldType(attribute);
-      const adsrc = this.version >= 12 ? "pg_get_expr(pg_attrdef.adbin, pg_attrdef.adrelid) AS adsrc" : "adsrc";
+      const where = "attrelid = $1 AND attnum > 0 AND atttypid = pg_type.oid AND attislocal = 't' AND attname = $2";
 
       const res = await this.client.query(
-        `SELECT attnotnull, atttypmod, typname, ${adsrc} FROM pg_type, pg_attribute LEFT JOIN pg_attrdef ON adrelid = attrelid AND adnum = attnum WHERE attrelid = $1 AND attnum > 0 AND atttypid = pg_type.oid AND attislocal = 't' AND attname = $2`,
+        `SELECT attnotnull, atttypmod, typname, ${adsrc(this.version)} FROM pg_type, pg_attribute LEFT JOIN pg_attrdef ON adrelid = attrelid AND adnum = attnum WHERE ${where}`,
         [oid, fieldName]
       );
 
       const addField = async () => {
         const statement = `ALTER TABLE ${tableName} ADD COLUMN ${fieldName} ${type}`;
 
-        this.log(statement);
-        await this.client.query(statement);
+        this.syncLog(statement);
+        if(this.sync) await this.client.query(statement);
       };
 
       const dropDefault = async () => {
         const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} DROP DEFAULT`;
 
-        this.log(statement);
-        await this.client.query(statement);
+        this.syncLog(statement);
+        if(this.sync) await this.client.query(statement);
       };
 
       const setNotNull = async (isNull: boolean) => {
@@ -201,22 +202,22 @@ export class PGDB extends DB {
 
         const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} ${notNull ? "SET" : "DROP"} NOT NULL`;
 
-        this.log(statement);
-        await this.client.query(statement);
+        this.syncLog(statement);
+        if(this.sync) await this.client.query(statement);
       };
 
       const setDefault = async (isNull: boolean) => {
         if(defaultValue !== undefined) {
           let statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} SET DEFAULT ${defaultValue}`;
 
-          this.log(statement);
-          await this.client.query(statement);
+          this.syncLog(statement);
+          if(this.sync) await this.client.query(statement);
 
           if(isNull) {
             statement = `UPDATE ${tableName} SET ${fieldName} = ${defaultValue} WHERE ${fieldName} IS NULL`;
 
-            this.log(statement);
-            this.client.query(statement);
+            this.syncLog(statement);
+            if(this.sync) this.client.query(statement);
           }
         }
 
@@ -240,8 +241,8 @@ export class PGDB extends DB {
             const using = needUsing.filter(([type, name]) => attribute.type === type && typname === name).length ? " USING " + fieldName + "::" + type : "";
             const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} TYPE ${type}${using}`;
 
-            this.log(statement);
-            await this.client.query(statement);
+            this.syncLog(statement);
+            if(this.sync) await this.client.query(statement);
             await setDefault(attnotnull);
           }
         } else if(defaultValue === undefined) {
@@ -261,8 +262,8 @@ export class PGDB extends DB {
       if(! this.indexes.includes(indexName)) {
         const statement = `CREATE${unique ? " UNIQUE" : ""} INDEX ${indexName} ON ${tableName} USING ${type} (${fields.join(", ")})`;
 
-        this.log(statement);
-        await this.client.query(statement);
+        this.syncLog(statement);
+        if(this.sync) await this.client.query(statement);
       }
     }
   }
@@ -272,8 +273,8 @@ export class PGDB extends DB {
 
     const statement = `ALTER SEQUENCE ${table.tableName}_id_seq OWNED BY ${table.tableName}.id`;
 
-    this.log(statement);
-    await this.client.query(statement);
+    this.syncLog(statement);
+    if(this.sync) await this.client.query(statement);
   }
 
   async syncTable(table: Table): Promise<void> {
@@ -286,8 +287,8 @@ export class PGDB extends DB {
           if(e.code === "42P01") {
             const statement = `CREATE SEQUENCE ${table.tableName}_id_seq`;
 
-            this.log(statement);
-            await this.client.query(statement);
+            this.syncLog(statement);
+            if(this.sync) await this.client.query(statement);
             table.autoIncrementOwn = true;
 
             return;
@@ -318,8 +319,8 @@ export class PGDB extends DB {
         const statement = `DROP TABLE ${table.tableName} CASCADE`;
 
         create = true;
-        this.log(statement);
-        await this.client.query(statement);
+        this.syncLog(statement);
+        if(this.sync) await this.client.query(statement);
       }
     } else create = true;
 
@@ -327,12 +328,12 @@ export class PGDB extends DB {
       const parent = table.parent ? ` INHERITS (${table.parent.tableName})` : "";
       const statement = `CREATE TABLE ${table.tableName} ()${parent}`;
 
-      this.log(statement);
-      await this.client.query(statement);
+      this.syncLog(statement);
+      if(this.sync) await this.client.query(statement);
 
       const resTable = await this.client.query("SELECT oid FROM pg_class WHERE relname = $1", [table.tableName]);
 
-      table.oid = resTable.rows[0].oid;
+      table.oid = resTable.rows[0]?.oid;
     }
   }
 }

package/package.json

@@ -6,7 +6,7 @@
     "@types/pg-format": "1.0.2",
     "pg": "8.7.1",
     "pg-format": "1.0.4",
-    "sedentary": "0.0.16"
+    "sedentary": "0.0.17"
   },
   "description": "The ORM which never needs to migrate - PostgreSQL",
   "devDependencies": {
@@ -62,5 +62,5 @@
     "version": "node -r ts-node/register utils.ts version"
   },
   "types": "index.d.ts",
-  "version": "0.0.16"
+  "version": "0.0.17"
 }