feat: adds /functions

Returns all the database functions and stored procedures

Author: kiwicopple

src/api.ts

@@ -7,6 +7,7 @@ router.use(cors())
 router.use('/config', addConnectionToRequest, require('./api/config'))
 router.use('/columns', addConnectionToRequest, require('./api/columns'))
 router.use('/extensions', addConnectionToRequest, require('./api/extensions'))
+router.use('/functions', addConnectionToRequest, require('./api/functions'))
 router.use('/query', addConnectionToRequest, require('./api/query'))
 router.use('/schemas', addConnectionToRequest, require('./api/schemas'))
 router.use('/tables', addConnectionToRequest, require('./api/tables'))

src/api/functions.ts

@@ -0,0 +1,40 @@
+import { Router } from 'express'
+
+import sql = require('../lib/sql')
+const { functions } = sql
+import { RunQuery } from '../lib/connectionPool'
+import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
+import { Functions } from '../lib/interfaces'
+
+const router = Router()
+router.get('/', async (req, res) => {
+  try {
+    const { data } = await RunQuery(req.headers.pg, functions)
+    const query: Fetch.QueryParams = req.query
+    let payload: Functions.Function[] = data
+    if (!query?.includeSystemSchemas) payload = removeSystemSchemas(data)
+    return res.status(200).json(payload)
+  } catch (error) {
+    console.log('throwing error')
+    res.status(500).json({ error: 'Database error', status: 500 })
+  }
+})
+
+const removeSystemSchemas = (data: Functions.Function[]) => {
+  return data.filter((x) => !DEFAULT_SYSTEM_SCHEMAS.includes(x.schema))
+}
+
+export = router
+
+/**
+ * Types
+ */
+
+namespace Fetch {
+  /**
+   * @param {boolean} [includeSystemSchemas=false] - Return system schemas as well as user schemas
+   */
+  export interface QueryParams {
+    includeSystemSchemas?: boolean
+  }
+}

src/lib/interfaces.ts

@@ -30,6 +30,18 @@ export namespace Roles {
   }
 }
 
+export namespace Functions {
+  export interface Function {
+    id: number
+    schema: string
+    name: string
+    language: string
+    definition: string
+    argument_types: string
+    return_type: string
+  }
+}
+
 export namespace Schemas {
   export interface Schema {
     id: number
@@ -98,6 +110,18 @@ export namespace Tables {
     is_updatable: boolean
   }
 
+  export interface Policy {
+    id: number
+    schema: string
+    table: string
+    table_id: number
+    permissive: boolean
+    roles: string[]
+    cmd: string
+    definition: string
+    with_check: string
+  }
+
   export interface PrimaryKey {
     schema: string
     table_name: string

src/lib/sql/functions.sql

@@ -0,0 +1,16 @@
+select
+    p.oid as id,
+    n.nspname as schema,
+    p.proname as name,
+    l.lanname as language,
+    case
+        when l.lanname = 'internal' then p.prosrc
+        else pg_get_functiondef(p.oid)
+    end as definition,
+    pg_get_function_arguments(p.oid) as argument_types,
+    t.typname as return_type
+from
+    pg_proc p
+    left join pg_namespace n on p.pronamespace = n.oid
+    left join pg_language l on p.prolang = l.oid
+    left join pg_type t on t.oid = p.prorettype

test/integration/index.spec.js

@@ -132,6 +132,26 @@ describe('/types', () => {
     assert.equal(true, !!included)
   })
 })
+describe('/functions', () => {
+  it('GET', async () => {
+    const res = await axios.get(`${URL}/functions`)
+    // console.log('res.data', res.data)
+    const datum = res.data.find((x) => x.schema == 'public')
+    const notIncluded = res.data.find((x) => x.schema == 'pg_toast')
+    assert.equal(res.status, STATUS.SUCCESS)
+    assert.equal(true, !!datum)
+    assert.equal(true, !notIncluded)
+  })
+  it('GET with system functions', async () => {
+    const res = await axios.get(`${URL}/functions?includeSystemSchemas=true`)
+    // console.log('res.data', res.data)
+    const datum = res.data.find((x) => x.schema == 'public')
+    const included = res.data.find((x) => x.schema == 'pg_catalog')
+    assert.equal(res.status, STATUS.SUCCESS)
+    assert.equal(true, !!datum)
+    assert.equal(true, !!included)
+  })
+})
 describe('/tables', async () => {
   it('GET', async () => {
     const tables = await axios.get(`${URL}/tables`)

test/postgres/mnt/00-init.sql

@@ -25,3 +25,10 @@ INSERT INTO
 VALUES 
     ('Star the repo', 1),
     ('Watch the releases', 2);
+
+
+CREATE FUNCTION add(integer, integer) RETURNS integer
+    AS 'select $1 + $2;'
+    LANGUAGE SQL
+    IMMUTABLE
+    RETURNS NULL ON NULL INPUT;