@platformatic/sql-mapper 3.52.0 → 3.52.2

package/index.js

@@ -223,6 +223,12 @@ export async function connect ({
     if (!dbschema) {
       dbschema = await queries.listTables(db, sql, schemaList)
 
+      // Also introspect database views
+      if (queries.listViews) {
+        const views = await queries.listViews(db, sql, schemaList)
+        dbschema = dbschema.concat(views)
+      }
+
       // TODO make this parallel or a single query
       for (const wrap of dbschema) {
         const { table, schema } = wrap
@@ -271,7 +277,7 @@ export async function connect ({
       }
     }
 
-    for (const { table, schema, columns, constraints } of dbschema) {
+    for (const { table, schema, columns, constraints, isView } of dbschema) {
       // The following line is a safety net when developing this module,
       // it should never happen.
       /* istanbul ignore next */
@@ -298,10 +304,11 @@ export async function connect ({
         limit,
         schemaList,
         columns,
-        constraints
+        constraints,
+        isView
       )
-      // Check for primary key of all entities
-      if (entity.primaryKeys.size === 0) {
+      // Check for primary key of all entities (views are allowed without PKs)
+      if (entity.primaryKeys.size === 0 && !isView) {
         log.warn({ table }, 'Cannot find any primary keys for table')
         continue
       }
@@ -386,7 +393,19 @@ async function dropTable (db, sql, table) {
     }
     return table
   } catch (err) {
-    // ignore, it will be dropped on the next roundon the next roundon the next roundon the next round
+    // ignore, it will be dropped on the next round
+  }
+}
+
+async function dropView (db, sql, view) {
+  try {
+    if (db.isSQLite) {
+      await db.query(sql`DROP VIEW ${sql(view)};`)
+    } else {
+      await db.query(sql`DROP VIEW ${sql(view)} CASCADE;`)
+    }
+  } catch {
+    // ignore
   }
 }
 
@@ -403,6 +422,20 @@ export async function dropAllTables (db, sql, schemas) {
     queries = queriesFactory.sqlite
   }
 
+  // Drop views first since they may depend on tables
+  if (queries.listViews) {
+    const views = (await queries.listViews(db, sql, schemas)).map(v => {
+      /* istanbul ignore next */
+      if (v.schema) {
+        return `${v.schema}.${v.table}`
+      }
+      return v.table
+    })
+    for (const view of views) {
+      await dropView(db, sql, view)
+    }
+  }
+
   const tables = new Set(
     (await queries.listTables(db, sql, schemas)).map(t => {
       /* istanbul ignore next */

package/lib/entity.js

@@ -29,7 +29,8 @@ function createMapper (
   useSchemaInName,
   limitConfig,
   columns,
-  constraintsList
+  constraintsList,
+  isView
 ) {
   /* istanbul ignore next */ // Ignoring because this won't be fully covered by DB not supporting schemas (SQLite)
   const entityName = useSchemaInName ? toUpperFirst(`${camelcase(schema)}${toSingular(table)}`) : toSingular(table)
@@ -430,7 +431,7 @@ function createMapper (
     return res.map(fixOutput)
   }
 
-  return {
+  const entity = {
     name: entityName,
     singularName,
     pluralName,
@@ -443,11 +444,17 @@ function createMapper (
     fixOutput,
     find,
     count,
-    insert,
-    save,
-    delete: _delete,
-    updateMany
+    isView: !!isView
   }
+
+  if (!isView) {
+    entity.insert = insert
+    entity.save = save
+    entity.delete = _delete
+    entity.updateMany = updateMany
+  }
+
+  return entity
 }
 
 export function buildEntity (
@@ -463,7 +470,8 @@ export function buildEntity (
   limitConfig,
   schemaList,
   columns,
-  constraintsList
+  constraintsList,
+  isView
 ) {
   const columnsNames = columns.map(c => c.column_name)
   for (const ignoredColumn of Object.keys(ignore)) {
@@ -623,7 +631,10 @@ export function buildEntity (
     autoTimestamp,
     schema,
     useSchemaInName,
-    limitConfig
+    limitConfig,
+    undefined,
+    undefined,
+    isView
   )
   entity.relations = currentRelations
 

package/lib/queries/mariadb.js

@@ -1,2 +1,2 @@
-export { listColumns, listConstraints, listTables, updateMany, updateOne } from './mysql-shared.js'
+export { listColumns, listConstraints, listTables, listViews, updateMany, updateOne } from './mysql-shared.js'
 export { deleteAll, insertMany, insertOne } from './shared.js'

package/lib/queries/mysql-shared.js

@@ -7,6 +7,7 @@ export async function listTables (db, sql, schemas) {
       SELECT TABLE_SCHEMA, TABLE_NAME
       FROM information_schema.tables
       WHERE table_schema in (${schemaList})
+      AND TABLE_TYPE = 'BASE TABLE'
     `)
     return res.map(r => ({ schema: r.TABLE_SCHEMA, table: r.TABLE_NAME }))
   } else {
@@ -14,6 +15,7 @@ export async function listTables (db, sql, schemas) {
       SELECT TABLE_SCHEMA, TABLE_NAME
       FROM information_schema.tables
       WHERE table_schema = (SELECT DATABASE())
+      AND TABLE_TYPE = 'BASE TABLE'
     `)
     return res.map(r => ({ schema: r.TABLE_SCHEMA, table: r.TABLE_NAME }))
   }
@@ -106,4 +108,23 @@ export async function updateMany (db, sql, table, schema, criteria, input, field
   return res
 }
 
+export async function listViews (db, sql, schemas) {
+  if (schemas) {
+    const schemaList = sql.__dangerous__rawValue(schemas.map(s => `'${s}'`))
+    const res = await db.query(sql`
+      SELECT TABLE_SCHEMA, TABLE_NAME
+      FROM information_schema.views
+      WHERE table_schema in (${schemaList})
+    `)
+    return res.map(r => ({ schema: r.TABLE_SCHEMA, table: r.TABLE_NAME, isView: true }))
+  } else {
+    const res = await db.query(sql`
+      SELECT TABLE_SCHEMA, TABLE_NAME
+      FROM information_schema.views
+      WHERE table_schema = (SELECT DATABASE())
+    `)
+    return res.map(r => ({ schema: r.TABLE_SCHEMA, table: r.TABLE_NAME, isView: true }))
+  }
+}
+
 export const hasILIKE = false

package/lib/queries/pg.js

@@ -111,4 +111,23 @@ export async function listEnumValues (db, sql, table, schema) {
   return db.query(query)
 }
 
+export async function listViews (db, sql, schemas) {
+  if (schemas) {
+    const schemaList = sql.__dangerous__rawValue(schemas.map(s => `'${s}'`))
+    const res = await db.query(sql`
+    SELECT viewname, schemaname
+    FROM pg_catalog.pg_views
+    WHERE
+      schemaname in (${schemaList})`)
+    return res.map(r => ({ schema: r.schemaname, table: r.viewname, isView: true }))
+  }
+  const res = await db.query(sql`
+    SELECT viewname, schemaname
+    FROM pg_catalog.pg_views
+    WHERE
+      schemaname = current_schema()
+  `)
+  return res.map(r => ({ schema: r.schemaname, table: r.viewname, isView: true }))
+}
+
 export const hasILIKE = true

package/lib/queries/sqlite.js

@@ -231,4 +231,12 @@ export async function updateMany (db, sql, table, schema, criteria, input, field
   return res
 }
 
+export async function listViews (db, sql) {
+  const res = await db.query(sql`
+    SELECT name FROM sqlite_master
+    WHERE type='view'
+  `)
+  return res.map(r => ({ schema: null, table: r.name, isView: true }))
+}
+
 export const hasILIKE = false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/sql-mapper",
-  "version": "3.52.0",
+  "version": "3.52.2",
   "description": "A data mapper utility for SQL databases",
   "main": "index.js",
   "type": "module",
@@ -35,8 +35,8 @@
     "camelcase": "^6.3.0",
     "fastify-plugin": "^5.0.0",
     "inflected": "^2.1.0",
-    "@platformatic/foundation": "3.52.0",
-    "@platformatic/telemetry": "3.52.0"
+    "@platformatic/foundation": "3.52.2",
+    "@platformatic/telemetry": "3.52.2"
   },
   "tsd": {
     "directory": "test/types"