@travetto/model-mysql 7.0.0-rc.2 → 7.0.0-rc.3

package/README.md

@@ -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-mysql",
-  "version": "7.0.0-rc.2",
+  "version": "7.0.0-rc.3",
   "description": "MySQL backing for the travetto model module, with real-time modeling support for SQL schemas.",
   "keywords": [
     "sql",
@@ -27,12 +27,12 @@
     "directory": "module/model-mysql"
   },
   "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.3",
+    "@travetto/config": "^7.0.0-rc.3",
+    "@travetto/context": "^7.0.0-rc.3",
+    "@travetto/model": "^7.0.0-rc.3",
+    "@travetto/model-query": "^7.0.0-rc.3",
+    "@travetto/model-sql": "^7.0.0-rc.3",
     "mysql2": "^3.15.3"
   },
   "travetto": {

package/src/connection.ts

@@ -1,7 +1,7 @@
 import { createPool } from 'mysql2';
 import { PoolConnection, Pool, OkPacket, ResultSetHeader } from 'mysql2/promise';
 
-import { castTo, ShutdownManager } from '@travetto/runtime';
+import { castTo, JSONUtil, ShutdownManager } from '@travetto/runtime';
 import { AsyncContext } from '@travetto/context';
 import { ExistsError } from '@travetto/model';
 import { Connection, SQLModelConfig } from '@travetto/model-sql';
@@ -52,7 +52,7 @@ export class MySQLConnection extends Connection<PoolConnection> {
     if (typeof result === 'string' && (field && typeof field === 'object' && 'type' in field) && (field.type === 'JSON' || field.type === 'BLOB')) {
       if (result.charAt(0) === '{' && result.charAt(result.length - 1) === '}') {
         try {
-          return JSON.parse(result);
+          return JSONUtil.parseSafe(result);
         } catch { }
       }
     }
@@ -76,10 +76,11 @@ export class MySQLConnection extends Connection<PoolConnection> {
       }
     } catch (error) {
       console.debug('Failed query', { error, query });
-      if (error instanceof Error && error.message.startsWith('Duplicate entry')) {
-        throw new ExistsError('query', query);
-      } else {
-        throw error;
+      const code = error && typeof error === 'object' && 'code' in error ? error.code : undefined;
+      switch (code) {
+        case 'ER_DUP_ENTRY': throw new ExistsError('query', query);
+        case 'ER_DUP_KEYNAME': throw new ExistsError('index', query);
+        default: throw error;
       }
     } finally {
       try {

package/src/dialect.ts

@@ -3,8 +3,8 @@ import { Injectable } from '@travetto/di';
 import { AsyncContext } from '@travetto/context';
 import { WhereClause } from '@travetto/model-query';
 import { castTo, Class } from '@travetto/runtime';
-import { ModelType } from '@travetto/model';
-import { SQLModelConfig, SQLDialect, VisitStack } from '@travetto/model-sql';
+import { ModelType, type IndexConfig } from '@travetto/model';
+import { SQLModelConfig, SQLDialect, VisitStack, type SQLTableDescription, SQLModelUtil } from '@travetto/model-sql';
 
 import { MySQLConnection } from './connection.ts';
 
@@ -61,6 +61,85 @@ export class MySQLDialect extends SQLDialect {
     return `SHA2('${value}', '256')`;
   }
 
+  /**
+   * Get DROP INDEX sql
+   */
+  getDropIndexSQL<T extends ModelType>(cls: Class<T>, idx: IndexConfig<T> | string): string {
+    const constraint = typeof idx === 'string' ? idx : this.getIndexName(cls, idx);
+    return `DROP INDEX ${this.identifier(constraint)} ON ${this.table(SQLModelUtil.classToStack(cls))};`;
+  }
+
+  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 
+        COLUMN_NAME AS name, 
+        COLUMN_TYPE AS type, 
+        IS_NULLABLE <> 'YES' AS is_notnull
+      FROM information_schema.COLUMNS 
+      WHERE TABLE_NAME = '${table}' 
+      AND TABLE_SCHEMA = DATABASE()
+      AND COLUMN_NAME NOT IN (${IGNORE_FIELDS.join(',')})
+      ORDER BY ORDINAL_POSITION
+    `),
+
+      // 2. Foreign Keys
+      this.executeSQL<{ name: string, from_column: string, to_column: string, to_table: string }>(`
+      SELECT 
+        CONSTRAINT_NAME AS name, 
+        COLUMN_NAME AS from_column, 
+        REFERENCED_COLUMN_NAME AS to_column, 
+        REFERENCED_TABLE_NAME AS to_table
+      FROM information_schema.KEY_COLUMN_USAGE 
+      WHERE TABLE_NAME = '${table}' 
+      AND TABLE_SCHEMA = DATABASE()
+      AND REFERENCED_TABLE_NAME IS NOT NULL
+    `),
+
+      // 3. Indices
+      this.executeSQL<{ name: string, is_unique: number, columns: string }>(`
+      SELECT 
+        stat.INDEX_NAME AS name, 
+        stat.NON_UNIQUE = 0 AS is_unique, 
+        GROUP_CONCAT(CONCAT(stat.COLUMN_NAME, ' ', stat.COLLATION, ' ') ORDER BY stat.SEQ_IN_INDEX) AS columns
+      FROM information_schema.STATISTICS stat
+      LEFT OUTER JOIN information_schema.TABLE_CONSTRAINTS AS tc
+        ON tc.CONSTRAINT_NAME = stat.INDEX_NAME
+        AND tc.TABLE_NAME = stat.TABLE_NAME
+        AND tc.TABLE_SCHEMA = stat.TABLE_SCHEMA
+      WHERE 
+        stat.TABLE_NAME = '${table}' 
+        AND stat.TABLE_SCHEMA = DATABASE()
+        AND tc.CONSTRAINT_TYPE IS NULL
+        AND stat.COLUMN_NAME NOT IN (${IGNORE_FIELDS.join(',')})
+      GROUP BY stat.INDEX_NAME, stat.NON_UNIQUE
+    `)
+    ]);
+
+    if (!columns.count) {
+      return undefined;
+    }
+
+    return {
+      columns: columns.records.map(col => ({
+        ...col,
+        type: col.type.toUpperCase(),
+        is_notnull: !!col.is_notnull
+      })),
+      foreignKeys: foreignKeys.records,
+      indices: indices.records.map(idx => ({
+        name: idx.name,
+        is_unique: !!idx.is_unique,
+        columns: idx.columns
+          .split(',')
+          .map(column => column.split(' '))
+          .map(([name, desc]) => ({ name, desc: desc === 'D' }))
+      }))
+    };
+  }
+
   /**
    * Create table, adding in specific engine options
    */

package/support/service.mysql.ts

@@ -8,7 +8,9 @@ export const service: ServiceDescriptor = {
   image: `mysql:${version}`,
   port: 3306,
   env: {
-    MYSQL_ROOT_PASSWORD: 'password',
+    MYSQL_RANDOM_ROOT_PASSWORD: '1',
+    MYSQL_PASSWORD: 'travetto',
+    MYSQL_USER: 'travetto',
     MYSQL_DATABASE: 'app'
   },
 };