Merge pull request #333 from supabase/feat/views-columns

feat(views): add `is_updatable` & `columns`

Author: soedirgo

src/lib/PostgresMetaViews.ts

@@ -1,6 +1,7 @@
 import { literal } from 'pg-format'
 import { DEFAULT_SYSTEM_SCHEMAS } from './constants'
-import { viewsSql } from './sql'
+import { coalesceRowsToArray } from './helpers'
+import { columnsSql, viewsSql } from './sql'
 import { PostgresMetaResult, PostgresView } from './types'
 
 export default class PostgresMetaViews {
@@ -19,9 +20,9 @@ export default class PostgresMetaViews {
     limit?: number
     offset?: number
   } = {}): Promise<PostgresMetaResult<PostgresView[]>> {
-    let sql = viewsSql
+    let sql = enrichedViewsSql
     if (!includeSystemSchemas) {
-      sql = `${sql} AND n.nspname NOT IN (${DEFAULT_SYSTEM_SCHEMAS.map(literal).join(',')})`
+      sql = `${sql} WHERE schema NOT IN (${DEFAULT_SYSTEM_SCHEMAS.map(literal).join(',')})`
     }
     if (limit) {
       sql = `${sql} LIMIT ${limit}`
@@ -32,3 +33,11 @@ export default class PostgresMetaViews {
     return await this.query(sql)
   }
 }
+
+const enrichedViewsSql = `
+WITH views AS (${viewsSql}),
+  columns AS (${columnsSql})
+SELECT
+  *,
+  ${coalesceRowsToArray('columns', 'columns.table_id = views.id')}
+FROM views`

src/lib/sql/views.sql

@@ -2,6 +2,8 @@ SELECT
   c.oid :: int8 AS id,
   n.nspname AS schema,
   c.relname AS name,
+  -- See definition of information_schema.views
+  (pg_relation_is_updatable(c.oid, false) & 20) = 20 AS is_updatable,
   obj_description(c.oid) AS comment
 FROM
   pg_class c

src/lib/types.ts

@@ -279,6 +279,8 @@ export const postgresViewSchema = Type.Object({
   id: Type.Integer(),
   schema: Type.String(),
   name: Type.String(),
+  is_updatable: Type.Boolean(),
   comment: Type.Union([Type.String(), Type.Null()]),
+  columns: Type.Array(postgresColumnSchema),
 })
 export type PostgresView = Static<typeof postgresViewSchema>

test/lib/views.ts

@@ -6,8 +6,68 @@ test('list', async () => {
     { id: expect.any(Number) },
     `
     Object {
+      "columns": Array [
+        Object {
+          "comment": null,
+          "data_type": "bigint",
+          "default_value": null,
+          "enums": Array [],
+          "format": "int8",
+          "id": "16420.1",
+          "identity_generation": null,
+          "is_generated": false,
+          "is_identity": false,
+          "is_nullable": true,
+          "is_unique": false,
+          "is_updatable": true,
+          "name": "id",
+          "ordinal_position": 1,
+          "schema": "public",
+          "table": "todos_view",
+          "table_id": 16420,
+        },
+        Object {
+          "comment": null,
+          "data_type": "text",
+          "default_value": null,
+          "enums": Array [],
+          "format": "text",
+          "id": "16420.2",
+          "identity_generation": null,
+          "is_generated": false,
+          "is_identity": false,
+          "is_nullable": true,
+          "is_unique": false,
+          "is_updatable": true,
+          "name": "details",
+          "ordinal_position": 2,
+          "schema": "public",
+          "table": "todos_view",
+          "table_id": 16420,
+        },
+        Object {
+          "comment": null,
+          "data_type": "bigint",
+          "default_value": null,
+          "enums": Array [],
+          "format": "int8",
+          "id": "16420.3",
+          "identity_generation": null,
+          "is_generated": false,
+          "is_identity": false,
+          "is_nullable": true,
+          "is_unique": false,
+          "is_updatable": true,
+          "name": "user-id",
+          "ordinal_position": 3,
+          "schema": "public",
+          "table": "todos_view",
+          "table_id": 16420,
+        },
+      ],
       "comment": null,
       "id": Any<Number>,
+      "is_updatable": true,
       "name": "todos_view",
       "schema": "public",
     }