sedentary-pg 0.0.8 → 0.0.12

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2020 Daniele Ricci
+Copyright (c) 2017 Daniele Ricci
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,15 +1,15 @@
 # sedentary-pg
 
-[![NPM version][npm-badge]][npm-url]
-[![Types][types-badge]][npm-url]
-[![NPM downloads][npm-downloads-badge]][npm-url]
-
 [![Build Status][travis-badge]][travis-url]
 [![Code Climate][code-badge]][code-url]
 [![Test Coverage][cover-badge]][code-url]
 
-[![Dependents][deps-badge]][npm-url]
+[![NPM version][npm-badge]][npm-url]
+[![NPM downloads][npm-downloads-badge]][npm-url]
 [![Stars][stars-badge]][github-url]
+
+[![Types][types-badge]][npm-url]
+[![Dependents][deps-badge]][npm-url]
 [![Donate][donate-badge]][donate-url]
 
 [code-badge]: https://codeclimate.com/github/iccicci/sedentary-pg/badges/gpa.svg
@@ -24,7 +24,7 @@
 [npm-url]: https://www.npmjs.com/package/sedentary-pg
 [stars-badge]: https://badgen.net/github/stars/iccicci/sedentary-pg?icon=github&cache=300
 [travis-badge]: https://badgen.net/travis/iccicci/sedentary-pg?icon=travis&cache=300
-[travis-url]: https://travis-ci.com/iccicci/sedentary-pg
+[travis-url]: https://app.travis-ci.com/github/iccicci/sedentary-pg
 [types-badge]: https://badgen.net/npm/types/sedentary-pg?color=green&icon=typescript&cache=300
 
 # under development

package/index.js

@@ -6,6 +6,8 @@ const pgdb_1 = require("./lib/pgdb");
 class SedentaryPG extends sedentary_1.Sedentary {
     constructor(connection, options) {
         super("", options);
+        if (!(connection instanceof Object))
+            throw new Error("SedentaryPG.constructor: 'connection' argument: Wrong type, expected 'Object'");
         this.db = new pgdb_1.PGDB(connection, this.log);
     }
 }

package/lib/pgdb.d.ts

@@ -1,18 +1,22 @@
 import { PoolConfig } from "pg";
-import { DB, Field, Table, native } from "sedentary/lib/db";
+import { DB, Field, Table } from "sedentary/lib/db";
 export declare class PGDB extends DB {
     private client;
+    private indexes;
     private pool;
+    private version;
     constructor(connection: PoolConfig, log: (message: string) => void);
     connect(): Promise<void>;
     dropConstraints(table: Table): Promise<void>;
+    dropField(tableName: string, fieldName: string): Promise<void>;
     dropFields(table: Table): Promise<void>;
     dropIndexes(table: Table): Promise<void>;
     end(): Promise<void>;
-    fieldType(field: Field<native, unknown>): string;
+    fieldType(field: Field<unknown, unknown>): string[];
     sync(): Promise<void>;
     syncConstraints(table: Table): Promise<void>;
     syncFields(table: Table): Promise<void>;
+    syncIndexes(table: Table): Promise<void>;
     syncSequence(table: Table): Promise<void>;
     syncTable(table: Table): Promise<void>;
 }

package/lib/pgdb.js

@@ -1,8 +1,25 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 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 needDrop = [
+    ["DATETIME", "int2"],
+    ["DATETIME", "int4"],
+    ["DATETIME", "int8"],
+    ["INT", "timestamptz"],
+    ["INT8", "timestamptz"]
+];
+const needUsing = [
+    ["DATETIME", "varchar"],
+    ["INT", "varchar"],
+    ["INT8", "varchar"]
+];
+const types = { int2: "SMALLINT", int4: "INTEGER", int8: "BIGINT", varchar: "VARCHAR" };
 class PGDB extends db_1.DB {
     constructor(connection, log) {
         super(log);
@@ -10,6 +27,8 @@ class PGDB extends db_1.DB {
     }
     async connect() {
         this.client = await this.pool.connect();
+        const res = await this.client.query("SELECT version()");
+        this.version = parseInt(res.rows[0].version.split(" ")[1].split(".")[0], 10);
     }
     async dropConstraints(table) {
         let place = 1;
@@ -41,28 +60,58 @@ class PGDB extends db_1.DB {
             await this.client.query(statement);
         }
     }
+    async dropField(tableName, fieldName) {
+        const statement = `ALTER TABLE ${tableName} DROP COLUMN ${fieldName}`;
+        this.log(statement);
+        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]);
-        for (const i in res.rows) {
-            if (table.fields.filter(f => f.fieldName === res.rows[i].attname).length === 0) {
-                const statement = `ALTER TABLE ${table.tableName} DROP COLUMN ${res.rows[i].attname}`;
-                this.log(statement);
-                await this.client.query(statement);
+        for (const i in res.rows)
+            if (table.fields.filter(f => f.fieldName === res.rows[i].attname).length === 0)
+                await this.dropField(table.tableName, res.rows[i].attname);
+    }
+    async dropIndexes(table) {
+        const { indexes, oid } = table;
+        const iobject = {};
+        const res = await this.client.query("SELECT amname, attname, indisunique, relname FROM pg_class, pg_index, pg_attribute, pg_am WHERE indrelid = $1 AND indexrelid = pg_class.oid AND attrelid = pg_class.oid AND relam = pg_am.oid ORDER BY attnum", [oid]);
+        for (const row of res.rows) {
+            const { amname, attname, indisunique, relname } = row;
+            if (iobject[relname])
+                iobject[relname].fields.push(attname);
+            else
+                iobject[relname] = { fields: [attname], name: relname, type: amname, unique: indisunique };
+        }
+        this.indexes = [];
+        for (const index of indexes) {
+            const { name } = index;
+            if (iobject[name] && this.indexesEq(index, iobject[name])) {
+                this.indexes.push(name);
+                delete iobject[name];
             }
         }
+        for (const index of Object.keys(iobject).sort()) {
+            const statement = `DROP INDEX ${index}`;
+            this.log(statement);
+            await this.client.query(statement);
+        }
     }
-    async dropIndexes(table) { }
     async end() {
         await this.pool.end();
     }
     fieldType(field) {
         const { size, type } = field;
-        if (type === "INT") {
-            if (size === 2)
-                return "SMALLINT";
-            if (size === 4)
-                return "INTEGER";
-            return "BIGINT";
+        let ret;
+        switch (type) {
+            case "DATETIME":
+                return ["DATETIME", "TIMESTAMP (3) WITH TIME ZONE"];
+            case "INT":
+                ret = size === 2 ? "SMALLINT" : "INTEGER";
+                return [ret, ret];
+            case "INT8":
+                return ["BIGINT", "BIGINT"];
+            case "VARCHAR":
+                return ["VARCHAR", "VARCHAR" + (size ? `(${size})` : "")];
         }
         throw new Error(`Unknown type: '${type}', '${size}'`);
     }
@@ -93,16 +142,82 @@ class PGDB extends db_1.DB {
         }
     }
     async syncFields(table) {
-        for (const i in table.fields) {
-            const field = table.fields[i];
-            const res = await this.client.query("SELECT * 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", [table.oid, field.fieldName]);
+        const { fields, oid, tableName } = table;
+        for (const field of fields) {
+            const { fieldName, notNull, size } = field;
+            const defaultValue = field.defaultValue === undefined ? undefined : (0, pg_format_1.default)("%L", field.defaultValue);
+            const [base, type] = this.fieldType(field);
+            const res = await this.client.query(`SELECT *${this.version >= 12 ? ", pg_get_expr(pg_attrdef.adbin, pg_attrdef.adrelid) AS 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 addField = async () => {
+                const statement = `ALTER TABLE ${tableName} ADD COLUMN ${fieldName} ${type}`;
+                this.log(statement);
+                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);
+            };
+            const setDefault = async () => {
+                if (defaultValue === undefined)
+                    return;
+                const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} SET DEFAULT ${defaultValue}`;
+                this.log(statement);
+                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);
+            };
             if (!res.rowCount) {
-                const statement = `ALTER TABLE ${table.tableName} ADD COLUMN ${field.fieldName} ${this.fieldType(field)}`;
+                await addField();
+                await setDefault();
+                await setNotNull(false);
+            }
+            else {
+                const { adsrc, attnotnull, atttypmod, typname } = res.rows[0];
+                if (types[typname] !== base || (base === "VARCHAR" && (size ? size + 4 !== atttypmod : atttypmod !== -1))) {
+                    if (needDrop.filter(([type, name]) => field.type === type && typname === name).length) {
+                        await this.dropField(tableName, fieldName);
+                        await addField();
+                        await setDefault();
+                        await setNotNull(false);
+                    }
+                    else {
+                        if (adsrc)
+                            dropDefault();
+                        const using = needUsing.filter(([type, name]) => field.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);
+                        await setDefault();
+                        await setNotNull(attnotnull);
+                    }
+                }
+                else if (defaultValue === undefined) {
+                    if (adsrc)
+                        dropDefault();
+                    await setNotNull(attnotnull);
+                }
+                else if (!adsrc || adsrc.split("::")[0] !== defaultValue) {
+                    await setDefault();
+                    await setNotNull(attnotnull);
+                }
+            }
+        }
+    }
+    async syncIndexes(table) {
+        const { indexes, tableName } = table;
+        for (const index of indexes) {
+            const { fields, name, type, unique } = index;
+            if (this.indexes.indexOf(name) === -1) {
+                const statement = `CREATE${unique ? " UNIQUE" : ""} INDEX ${name} ON ${tableName} USING ${type} (${fields.join(", ")})`;
                 this.log(statement);
                 await this.client.query(statement);
             }
-            else
-                console.log(res.rows[0].typname);
         }
     }
     async syncSequence(table) {

package/lib/pgdb.ts

@@ -1,9 +1,26 @@
 import { Pool, PoolClient, PoolConfig } from "pg";
-import { DB, Field, Table, native } from "sedentary/lib/db";
+import format from "pg-format";
+import { DB, Field, IndexDef, Table } from "sedentary/lib/db";
+
+const needDrop = [
+  ["DATETIME", "int2"],
+  ["DATETIME", "int4"],
+  ["DATETIME", "int8"],
+  ["INT", "timestamptz"],
+  ["INT8", "timestamptz"]
+];
+const needUsing = [
+  ["DATETIME", "varchar"],
+  ["INT", "varchar"],
+  ["INT8", "varchar"]
+];
+const types = { int2: "SMALLINT", int4: "INTEGER", int8: "BIGINT", varchar: "VARCHAR" };
 
 export class PGDB extends DB {
   private client: PoolClient;
+  private indexes: string[];
   private pool: Pool;
+  private version: number;
 
   constructor(connection: PoolConfig, log: (message: string) => void) {
     super(log);
@@ -13,6 +30,10 @@ export class PGDB extends DB {
 
   async connect(): Promise<void> {
     this.client = await this.pool.connect();
+
+    const res = await this.client.query("SELECT version()");
+
+    this.version = parseInt(res.rows[0].version.split(" ")[1].split(".")[0], 10);
   }
 
   async dropConstraints(table: Table): Promise<void> {
@@ -50,32 +71,71 @@ 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);
+  }
+
   async dropFields(table: Table): Promise<void> {
     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]);
 
-    for(const i in res.rows) {
-      if(table.fields.filter(f => f.fieldName === res.rows[i].attname).length === 0) {
-        const statement = `ALTER TABLE ${table.tableName} DROP COLUMN ${res.rows[i].attname}`;
+    for(const i in res.rows) if(table.fields.filter(f => f.fieldName === res.rows[i].attname).length === 0) await this.dropField(table.tableName, res.rows[i].attname);
+  }
 
-        this.log(statement);
-        await this.client.query(statement);
+  async dropIndexes(table: Table): Promise<void> {
+    const { indexes, oid } = table;
+    const iobject: { [key: string]: IndexDef } = {};
+    const res = await this.client.query(
+      "SELECT amname, attname, indisunique, relname FROM pg_class, pg_index, pg_attribute, pg_am WHERE indrelid = $1 AND indexrelid = pg_class.oid AND attrelid = pg_class.oid AND relam = pg_am.oid ORDER BY attnum",
+      [oid]
+    );
+
+    for(const row of res.rows) {
+      const { amname, attname, indisunique, relname } = row;
+
+      if(iobject[relname]) iobject[relname].fields.push(attname);
+      else iobject[relname] = { fields: [attname], name: relname, type: amname, unique: indisunique };
+    }
+
+    this.indexes = [];
+    for(const index of indexes) {
+      const { name } = index;
+
+      if(iobject[name] && this.indexesEq(index, iobject[name])) {
+        this.indexes.push(name);
+        delete iobject[name];
       }
     }
-  }
 
-  async dropIndexes(table: Table): Promise<void> {}
+    for(const index of Object.keys(iobject).sort()) {
+      const statement = `DROP INDEX ${index}`;
+
+      this.log(statement);
+      await this.client.query(statement);
+    }
+  }
 
   async end(): Promise<void> {
     await this.pool.end();
   }
 
-  fieldType(field: Field<native, unknown>): string {
+  fieldType(field: Field<unknown, unknown>): string[] {
     const { size, type } = field;
-
-    if(type === "INT") {
-      if(size === 2) return "SMALLINT";
-      if(size === 4) return "INTEGER";
-      return "BIGINT";
+    let ret;
+
+    switch(type) {
+    case "DATETIME":
+      return ["DATETIME", "TIMESTAMP (3) WITH TIME ZONE"];
+    case "INT":
+      ret = size === 2 ? "SMALLINT" : "INTEGER";
+
+      return [ret, ret];
+    case "INT8":
+      return ["BIGINT", "BIGINT"];
+    case "VARCHAR":
+      return ["VARCHAR", "VARCHAR" + (size ? `(${size})` : "")];
     }
 
     throw new Error(`Unknown type: '${type}', '${size}'`);
@@ -114,19 +174,99 @@ export class PGDB extends DB {
   }
 
   async syncFields(table: Table): Promise<void> {
-    for(const i in table.fields) {
-      const field = table.fields[i];
+    const { fields, oid, tableName } = table;
+
+    for(const field of fields) {
+      const { fieldName, notNull, size } = field;
+      const defaultValue = field.defaultValue === undefined ? undefined : format("%L", field.defaultValue);
+      const [base, type] = this.fieldType(field);
+
       const res = await this.client.query(
-        "SELECT * 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",
-        [table.oid, field.fieldName]
+        `SELECT *${
+          this.version >= 12 ? ", pg_get_expr(pg_attrdef.adbin, pg_attrdef.adrelid) AS 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 addField = async () => {
+        const statement = `ALTER TABLE ${tableName} ADD COLUMN ${fieldName} ${type}`;
+
+        this.log(statement);
+        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);
+      };
+
+      const setDefault = async () => {
+        if(defaultValue === undefined) return;
+
+        const statement = `ALTER TABLE ${tableName} ALTER COLUMN ${fieldName} SET DEFAULT ${defaultValue}`;
+
+        this.log(statement);
+        await this.client.query(statement);
+      };
+
+      const setNotNull = async (isNull: boolean) => {
+        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);
+      };
+
       if(! res.rowCount) {
-        const statement = `ALTER TABLE ${table.tableName} ADD COLUMN ${field.fieldName} ${this.fieldType(field)}`;
+        await addField();
+        await setDefault();
+        await setNotNull(false);
+      } else {
+        const { adsrc, attnotnull, atttypmod, typname } = res.rows[0];
+
+        if(types[typname] !== base || (base === "VARCHAR" && (size ? size + 4 !== atttypmod : atttypmod !== -1))) {
+          if(needDrop.filter(([type, name]) => field.type === type && typname === name).length) {
+            await this.dropField(tableName, fieldName);
+            await addField();
+            await setDefault();
+            await setNotNull(false);
+          } else {
+            if(adsrc) dropDefault();
+
+            const using = needUsing.filter(([type, name]) => field.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);
+            await setDefault();
+            await setNotNull(attnotnull);
+          }
+        } else if(defaultValue === undefined) {
+          if(adsrc) dropDefault();
+          await setNotNull(attnotnull);
+        } else if(! adsrc || adsrc.split("::")[0] !== defaultValue) {
+          await setDefault();
+          await setNotNull(attnotnull);
+        }
+      }
+    }
+  }
+
+  async syncIndexes(table: Table): Promise<void> {
+    const { indexes, tableName } = table;
+
+    for(const index of indexes) {
+      const { fields, name, type, unique } = index;
+
+      if(this.indexes.indexOf(name) === -1) {
+        const statement = `CREATE${unique ? " UNIQUE" : ""} INDEX ${name} ON ${tableName} USING ${type} (${fields.join(", ")})`;
 
         this.log(statement);
         await this.client.query(statement);
-      } else console.log(res.rows[0].typname);
+      }
     }
   }
 

package/package.json

@@ -2,27 +2,29 @@
   "author": "Daniele Ricci <daniele.icc@gmail.com> (https://github.com/iccicci)",
   "bugs": "https://github.com/iccicci/sedentary-pg/issues",
   "dependencies": {
-    "@types/pg": "7.14.7",
-    "pg": "8.5.1",
-    "sedentary": "0.0.8"
+    "@types/pg": "8.6.1",
+    "@types/pg-format": "1.0.2",
+    "pg": "8.7.1",
+    "pg-format": "1.0.4",
+    "sedentary": "0.0.12"
   },
   "description": "The ORM which never needs to migrate - PostgreSQL",
   "devDependencies": {
-    "@types/mocha": "8.0.4",
-    "@types/node": "14.14.9",
+    "@types/mocha": "9.0.0",
+    "@types/node": "16.11.6",
     "@types/yamljs": "0.2.31",
-    "@typescript-eslint/eslint-plugin": "4.8.2",
-    "@typescript-eslint/parser": "4.8.2",
-    "eslint": "7.14.0",
-    "mocha": "8.2.1",
+    "@typescript-eslint/eslint-plugin": "5.3.0",
+    "@typescript-eslint/parser": "5.3.0",
+    "eslint": "8.2.0",
+    "mocha": "9.1.3",
     "nyc": "15.1.0",
-    "prettier": "2.2.0",
-    "ts-node": "9.0.0",
-    "typescript": "4.1.2",
+    "prettier": "2.4.1",
+    "ts-node": "10.4.0",
+    "typescript": "4.4.4",
     "yamljs": "0.3.0"
   },
   "engines": {
-    "node": ">=10.0"
+    "node": ">=12.0"
   },
   "homepage": "https://github.com/iccicci/sedentary-pg#readme",
   "keywords": [
@@ -47,15 +49,15 @@
   "readmeFilename": "README.md",
   "repository": "https://github.com/iccicci/sedentary-pg",
   "scripts": {
-    "coverage": "nyc -r lcov -r text -r text-summary -r html mocha -r ts-node/register test/*js test/*ts",
+    "coverage": "nyc -r lcov -r text -r text-summary -r html mocha -r ts-node/register test/*ts",
     "gitignore": "node -r ts-node/register utils.ts gitignore",
     "npmignore": "node -r ts-node/register utils.ts npmignore",
     "packagejson": "node -r ts-node/register utils.ts packagejson",
-    "test": "mocha -r ts-node/register test/*js test/*ts",
+    "test": "mocha -r ts-node/register test/*ts",
     "travis": "node -r ts-node/register utils.ts travis",
     "tsc": "tsc --declaration",
     "version": "node -r ts-node/register utils.ts version"
   },
   "types": "index.d.ts",
-  "version": "0.0.8"
-}
+  "version": "0.0.12"
+}