@travetto/model-postgres 7.0.0-rc.2 → 7.0.0-rc.4

package/README.md

@@ -60,11 +60,11 @@ export class SQLModelConfig<T extends {} = {}> {
   /**
    * Username
    */
-  user = '';
+  user = Runtime.production ? '' : 'travetto';
   /**
    * Password
    */
-  password = '';
+  password = Runtime.production ? '' : 'travetto';
   /**
    * Table prefix
    */
@@ -74,9 +74,9 @@ export class SQLModelConfig<T extends {} = {}> {
    */
   database = 'app';
   /**
-   * Auto schema creation
+   * Allow storage modification at runtime
    */
-  autoCreate?: boolean;
+  modifyStorage?: boolean;
   /**
    * Db version
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-postgres",
-  "version": "7.0.0-rc.2",
+  "version": "7.0.0-rc.4",
   "description": "PostgreSQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
     "sql",
@@ -27,12 +27,12 @@
     "directory": "module/model-postgres"
   },
   "dependencies": {
-    "@travetto/cli": "^7.0.0-rc.2",
-    "@travetto/config": "^7.0.0-rc.2",
-    "@travetto/context": "^7.0.0-rc.2",
-    "@travetto/model": "^7.0.0-rc.2",
-    "@travetto/model-query": "^7.0.0-rc.2",
-    "@travetto/model-sql": "^7.0.0-rc.2",
+    "@travetto/cli": "^7.0.0-rc.4",
+    "@travetto/config": "^7.0.0-rc.4",
+    "@travetto/context": "^7.0.0-rc.4",
+    "@travetto/model": "^7.0.0-rc.4",
+    "@travetto/model-query": "^7.0.0-rc.4",
+    "@travetto/model-sql": "^7.0.0-rc.4",
     "@types/pg": "^8.15.6",
     "pg": "^8.16.3"
   },

package/src/connection.ts

@@ -59,10 +59,13 @@ export class PostgreSQLConnection extends Connection<PoolClient> {
       const records: T[] = [...out.rows].map(value => ({ ...value }));
       return { count: out.rowCount!, records };
     } catch (error) {
-      if (error instanceof Error && error.message.includes('duplicate key value')) {
-        throw new ExistsError('query', query);
-      } else {
-        throw error;
+      const code = error && typeof error === 'object' && 'code' in error ? error.code : undefined;
+      switch (code) {
+        // Index already exists
+        case '42P07': throw new ExistsError('index', query);
+        // Unique violation
+        case '23505': throw new ExistsError('query', query);
+        default: throw error;
       }
     }
   }

package/src/dialect.ts

@@ -4,7 +4,7 @@ import { AsyncContext } from '@travetto/context';
 import { ModelType } from '@travetto/model';
 import { castTo, Class } from '@travetto/runtime';
 
-import { SQLDialect, SQLModelConfig, SQLModelUtil, VisitStack } from '@travetto/model-sql';
+import { SQLDialect, SQLModelConfig, SQLModelUtil, VisitStack, type SQLTableDescription } from '@travetto/model-sql';
 
 import { PostgreSQLConnection } from './connection.ts';
 
@@ -44,6 +44,90 @@ export class PostgreSQLDialect extends SQLDialect {
     return `encode(digest('${value}', 'sha1'), 'hex')`;
   }
 
+  async describeTable(table: string): Promise<SQLTableDescription | undefined> {
+    const IGNORE_FIELDS = [this.pathField.name, this.parentPathField.name, this.idxField.name].map(field => `'${field}'`);
+
+    const [columns, foreignKeys, indices] = await Promise.all([
+      // 1. Columns
+      this.executeSQL<{ name: string, type: string, is_notnull: boolean }>(`
+      SELECT
+        a.attname AS name,
+        pg_catalog.format_type(a.atttypid, a.atttypmod) AS type,
+        a.attnotnull AS is_notnull
+      FROM pg_catalog.pg_attribute a
+      JOIN pg_catalog.pg_class c ON c.oid = a.attrelid
+      JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+      LEFT JOIN
+        pg_catalog.pg_attrdef ad ON ad.adrelid = c.oid AND ad.adnum = a.attnum
+      WHERE
+        c.relname = '${table}'
+        AND a.attnum > 0
+        AND NOT a.attisdropped
+        AND a.attname NOT IN (${IGNORE_FIELDS.join(',')})
+      ORDER BY
+        a.attnum;
+    `),
+
+      // 2. Foreign Keys
+      this.executeSQL<{ name: string, from_column: string, to_column: string, to_table: string }>(`
+      SELECT
+        tc.constraint_name AS name, 
+        kcu.column_name AS from_column,
+        ccu.column_name AS to_column,
+        ccu.table_name AS to_table
+      FROM information_schema.table_constraints AS tc 
+      JOIN information_schema.key_column_usage AS kcu
+        ON tc.constraint_name = kcu.constraint_name
+      JOIN information_schema.constraint_column_usage AS ccu
+        ON ccu.constraint_name = tc.constraint_name
+      WHERE tc.constraint_type = 'FOREIGN KEY' 
+        AND tc.table_name = '${table}'
+    `),
+
+      // 3. Indices
+      this.executeSQL<{ name: string, is_unique: boolean, columns: string[] }>(`
+      SELECT
+        i.relname AS name,
+        ix.indisunique AS is_unique,
+        ARRAY_AGG(a.attname || ' '|| CAST((o.OPTION & 1) AS VARCHAR) ORDER BY array_position(ix.indkey, a.attnum)) AS columns
+      FROM pg_class t
+      JOIN pg_index ix ON t.oid = ix.indrelid
+      JOIN pg_class i ON i.oid = ix.indexrelid
+      CROSS JOIN LATERAL UNNEST(ix.indkey)    WITH ordinality AS c (colnum, ordinality)
+      LEFT  JOIN LATERAL UNNEST(ix.indoption) WITH ordinality AS o (OPTION, ordinality) ON c.ordinality = o.ordinality 
+      LEFT JOIN pg_catalog.pg_constraint co ON co.conindid = ix.indexrelid
+      JOIN pg_attribute a ON a.attrelid = t.oid AND a.attnum = c.colnum 
+      WHERE t.relname = '${table}'
+        AND NOT ix.indisprimary
+        AND co.conindid IS NULL
+      GROUP BY i.relname, ix.indisunique
+    `)
+    ]);
+
+    if (!columns.count) {
+      return undefined;
+    }
+
+    return {
+      columns: columns.records.map(col => ({
+        ...col,
+        type: col.type.toUpperCase()
+          .replace('CHARACTER VARYING', 'VARCHAR')
+          .replace('INTEGER', 'INT'),
+        is_notnull: !!col.is_notnull
+      })),
+      foreignKeys: foreignKeys.records,
+      indices: indices.records
+        .map(idx => ({
+          name: idx.name,
+          is_unique: idx.is_unique,
+          columns: idx.columns
+            .map(column => column.split(' '))
+            .map(([name, desc]) => ({ name, desc: desc === '1' }))
+        }))
+    };
+  }
+
   /**
    * Define column modification
    */

package/support/service.postgresql.ts

@@ -8,8 +8,8 @@ export const service: ServiceDescriptor = {
   port: 5432,
   image: `postgres:${version}-alpine`,
   env: {
-    POSTGRES_USER: 'root',
-    POSTGRES_PASSWORD: 'password',
+    POSTGRES_USER: 'travetto',
+    POSTGRES_PASSWORD: 'travetto',
     POSTGRES_DB: 'app'
   }
 };