feat: adds the ability to create and update a schema

Author: kiwicopple

package-lock.json

@@ -24,7 +24,8 @@
     "cors": "^2.8.5",
     "crypto-js": "^4.0.0",
     "express": "^4.17.1",
-    "pg": "^7.18.2"
+    "pg": "^7.18.2",
+    "sql-template-strings": "^2.2.2"
   },
   "devDependencies": {
     "@types/cors": "^2.8.6",

package.json

@@ -1,11 +1,12 @@
 import { Router } from 'express'
-
-import sql = require('../lib/sql')
-const { schemas } = sql
+import SQL from 'sql-template-strings'
+import sqlTemplates = require('../lib/sql')
 import { RunQuery } from '../lib/connectionPool'
 import { DEFAULT_SYSTEM_SCHEMAS } from '../lib/constants'
 import { Schemas } from '../lib/interfaces'
 
+const { schemas } = sqlTemplates
+
 /**
  * @param {boolean} [includeSystemSchemas=false] - Return system schemas as well as user schemas
  */
@@ -14,6 +15,7 @@ interface GetSchemasQueryParams {
 }
 
 const router = Router()
+
 router.get('/', async (req, res) => {
   try {
     const { data } = await RunQuery(req.headers.pg, schemas)
@@ -23,11 +25,81 @@ router.get('/', async (req, res) => {
 
     return res.status(200).json(payload)
   } catch (error) {
-    console.log('throwing error')
+    console.log('throwing error', error)
+    res.status(500).json({ error: 'Database error', status: 500 })
+  }
+})
+router.post('/', async (req, res) => {
+  try {
+    const name: string = req.body.name
+    const owner: string = req.body.owner
+
+    // Create the schema
+    const schemqQuery = createSchema(name, owner)
+    await RunQuery(req.headers.pg, schemqQuery)
+  
+    // Return fresh details
+    const getSchema = selectSingleByName(name)
+    const { data } = await RunQuery(req.headers.pg, getSchema)
+    let schema: Schemas.Schema = data[0]
+    return res.status(200).json(schema)
+  } catch (error) {
+    console.log('throwing error', error)
+    res.status(500).json({ error: 'Database error', status: 500 })
+  }
+})
+router.patch('/:id', async (req, res) => {
+  try {
+    const id: number = parseInt(req.params.id)
+    const name: string = req.body.name
+    const owner: string = req.body.owner
+
+    // Get schema name
+    const getSchema = selectSingleSql(id)
+    const { data: getSchemaResults } = await RunQuery(req.headers.pg, getSchema)
+    let previousSchema: Schemas.Schema = getSchemaResults[0]
+
+    // Update fields
+    if (owner) {
+      const updateOwner = alterSchemaOwner(previousSchema.name, owner)
+      await RunQuery(req.headers.pg, updateOwner)
+    }
+    if (name) {
+      const updateName = alterSchemaName(previousSchema.name, name)
+      await RunQuery(req.headers.pg, updateName)
+    }
+
+    // Return fresh details
+    const { data: updatedSchemaResults } = await RunQuery(req.headers.pg, getSchema)
+    let updatedSchema: Schemas.Schema = updatedSchemaResults[0]
+    return res.status(200).json(updatedSchema)
+  } catch (error) {
+    console.log('throwing error', error)
     res.status(500).json({ error: 'Database error', status: 500 })
   }
 })
 
+// Helpers
+const selectSingleSql = (id: number) => {
+  const query = SQL``.append(schemas).append(SQL` where nsp.oid = ${id}`)
+  return query
+}
+const selectSingleByName = (name: string) => {
+  const query = SQL``.append(schemas).append(SQL` where schema_name = ${name}`)
+  return query
+}
+const createSchema = (name: string, owner: string = 'postgres') => {
+  const query = SQL``.append(`CREATE SCHEMA IF NOT EXISTS ${name} AUTHORIZATION ${owner}`)
+  return query
+}
+const alterSchemaName = (previousName: string, newName: string) => {
+  const query = SQL``.append(`ALTER SCHEMA ${previousName} RENAME TO ${newName}`)
+  return query
+}
+const alterSchemaOwner = (schemaName: string, newOwner: string) => {
+  const query = SQL``.append(`ALTER SCHEMA ${schemaName} OWNER TO ${newOwner}`)
+  return query
+}
 const removeSystemSchemas = (data: Schemas.Schema[]) => {
   return data.filter((x) => !DEFAULT_SYSTEM_SCHEMAS.includes(x.name))
 }

src/api/schemas.ts

@@ -1,11 +1,12 @@
 import pg = require('pg')
+import { SQLStatement } from 'sql-template-strings'
 // HACK: Number has 53 bits of precision, may overflow with bigint (64 bits).
 // Maybe use BigInt?
 // TODO: Use Date object for timestamptz?
 pg.types.setTypeParser(20, 'text', parseInt)
 const { Pool } = pg
 
-export const RunQuery = async (connectionString: any, sql: string) => {
+export const RunQuery = async (connectionString: any, sql: string|SQLStatement) => {
   const pool = new Pool({ connectionString })
   try {
     const results = await pool.query(sql)

src/lib/connectionPool.ts

@@ -8,6 +8,7 @@ const STATUS = {
   SUCCESS: 200,
   ERROR: 500,
 }
+const PUBLIC_SCHEMA_ID = 2200
 
 console.log('Running tests on ', URL)
 
@@ -98,6 +99,18 @@ describe('/schemas', () => {
     assert.equal(true, !!datum)
     assert.equal(true, !!included)
   })
+  it('POST & PATCH', async () => {
+    const res = await axios.post(`${URL}/schemas`, { name: 'api' })
+    assert.equal('api', res.data.name)
+    const newSchemaId = res.data.id
+    const res2 = await axios.patch(`${URL}/schemas/${newSchemaId}`, { name: 'api_updated' })
+    assert.equal('api_updated', res2.data.name)
+    const res3 = await axios.patch(`${URL}/schemas/${newSchemaId}`, {
+      name: 'api',
+      owner: 'postgres',
+    })
+    assert.equal('api', res3.data.name)
+  })
 })
 describe('/types', () => {
   it('GET', async () => {
@@ -197,6 +210,7 @@ describe('/extensions', () => {
 describe('/roles', () => {
   it('GET', async () => {
     const res = await axios.get(`${URL}/roles`)
+    // console.log('res', res)
     const datum = res.data.find((x) => x.name == 'postgres')
     const hasSystemSchema = datum.grants.some((x) => x.schema == 'information_schema')
     const hasPublicSchema = datum.grants.some((x) => x.schema == 'public')