feat: support COMMENTs on /tables & /columns

This adds support for adding COMMENTs on /tables & /columns through POST
and PATCH, plus updated tests (and minor refactorings).

Author: soedirgo

src/api/columns.ts

@@ -105,6 +105,7 @@ const addColumnSqlize = ({
   is_nullable = true,
   is_primary_key = false,
   is_unique = false,
+  comment,
 }: {
   schema: string
   table: string
@@ -115,20 +116,27 @@ const addColumnSqlize = ({
   is_nullable?: boolean
   is_primary_key?: boolean
   is_unique?: boolean
+  comment?: string
 }) => {
   const defaultValueSql = default_value === undefined ? '' : `DEFAULT ${default_value}`
   const isIdentitySql = is_identity ? 'GENERATED BY DEFAULT AS IDENTITY' : ''
   const isNullableSql = is_nullable ? 'NULL' : 'NOT NULL'
   const isPrimaryKeySql = is_primary_key ? 'PRIMARY KEY' : ''
   const isUniqueSql = is_unique ? 'UNIQUE' : ''
+  const commentSql =
+    comment === undefined
+      ? ''
+      : `COMMENT ON COLUMN "${schema}"."${table}"."${name}" IS '${comment}';`
 
   return `
 ALTER TABLE "${schema}"."${table}" ADD COLUMN "${name}" "${type}"
   ${defaultValueSql}
   ${isIdentitySql}
   ${isNullableSql}
   ${isPrimaryKeySql}
-  ${isUniqueSql}`
+  ${isUniqueSql};
+
+  ${commentSql}`
 }
 const getColumnSqlize = (tableId: number, name: string) => {
   return SQL``.append(columns).append(SQL` WHERE c.oid = ${tableId} AND column_name = ${name}`)
@@ -147,6 +155,7 @@ const alterColumnSqlize = ({
   drop_default = false,
   default_value,
   is_nullable,
+  comment,
 }: {
   schema: string
   table: string
@@ -156,6 +165,7 @@ const alterColumnSqlize = ({
   drop_default?: boolean
   default_value?: any
   is_nullable?: boolean
+  comment?: string
 }) => {
   const nameSql =
     name === undefined
@@ -177,13 +187,18 @@ const alterColumnSqlize = ({
       ? `ALTER TABLE "${schema}"."${table}" ALTER COLUMN "${oldName}" DROP NOT NULL;`
       : `ALTER TABLE "${schema}"."${table}" ALTER COLUMN "${oldName}" SET NOT NULL;`
   }
+  const commentSql =
+    comment === undefined
+      ? ''
+      : `COMMENT ON COLUMN "${schema}"."${table}"."${oldName}" IS '${comment}';`
 
   // nameSql must be last.
   return `
 BEGIN;
   ${isNullableSql}
   ${defaultValueSql}
   ${typeSql}
+  ${commentSql}
   ${nameSql}
 COMMIT;`
 }

src/api/tables.ts

@@ -32,11 +32,10 @@ router.get('/', async (req, res) => {
 router.post('/', async (req, res) => {
   try {
     const pcConnection: string = req.headers.pg.toString()
-    const schema: string = req.body.schema || 'public'
-    const name: string = req.body.name
+    const { schema = 'public', name } = req.body
 
     // Create the table
-    const createTableSql = createTable(name, schema)
+    const createTableSql = createTableSqlize(req.body)
     const alterSql = alterTableSql(req.body)
     const transaction = toTransaction([createTableSql, alterSql])
     await RunQuery(pcConnection, transaction)
@@ -144,8 +143,19 @@ const selectSingleByName = (sqlTemplates, schema: string, name: string) => {
   const { tables } = sqlTemplates
   return `${tables} and table_schema = '${schema}' and table_name = '${name}';`.trim()
 }
-const createTable = (name: string, schema: string = 'postgres') => {
-  return `CREATE TABLE IF NOT EXISTS "${schema}"."${name}" ();`.trim()
+const createTableSqlize = ({
+  name,
+  schema = 'public',
+  comment,
+}: {
+  name: string
+  schema?: string
+  comment?: string
+}) => {
+  const tableSql = `CREATE TABLE IF NOT EXISTS "${schema}"."${name}" ();`
+  const commentSql =
+    comment === undefined ? '' : `COMMENT ON TABLE "${schema}"."${name}" IS '${comment}';`
+  return `${tableSql} ${commentSql}`
 }
 const alterTableName = (previousName: string, newName: string, schema: string) => {
   return `ALTER TABLE "${schema}"."${previousName}" RENAME TO "${newName}";`.trim()
@@ -155,11 +165,13 @@ const alterTableSql = ({
   name,
   rls_enabled,
   rls_forced,
+  comment,
 }: {
   schema?: string
   name: string
   rls_enabled?: boolean
   rls_forced?: boolean
+  comment?: string
 }) => {
   let alter = `ALTER table "${schema}"."${name}"`
   let enableRls = ''
@@ -174,9 +186,12 @@ const alterTableSql = ({
     let disable = `${alter} NO FORCE ROW LEVEL SECURITY;`
     forceRls = rls_forced ? enable : disable
   }
+  const commentSql =
+    comment === undefined ? '' : `COMMENT ON TABLE "${schema}"."${name}" IS '${comment}';`
   return `
     ${enableRls}
     ${forceRls}
+    ${commentSql}
   `.trim()
 }
 const dropTableSql = (schema: string, name: string, cascade: boolean) => {

src/lib/sql/columns.sql

@@ -24,8 +24,9 @@ SELECT
       ORDER BY
         enums.enumsortorder
     )
-  ) AS enums
+  ) AS enums,
+  col_description(c.oid, ordinal_position) AS comment
 FROM
   information_schema.columns
   JOIN pg_class c ON quote_ident(table_schema) :: regnamespace = c.relnamespace
-  AND c.relname = table_name
+  AND c.relname = table_name

src/lib/sql/tables.sql

@@ -29,7 +29,8 @@ SELECT
   vacuum_count :: bigint,
   autovacuum_count :: bigint,
   analyze_count :: bigint,
-  autoanalyze_count :: bigint
+  autoanalyze_count :: bigint,
+  obj_description(c.oid) AS comment
 FROM
   information_schema.tables
   JOIN pg_class c ON quote_ident(table_schema)::regnamespace = c.relnamespace

test/integration/index.spec.js

@@ -229,8 +229,9 @@ describe('/tables', async () => {
     assert.equal(true, !!included)
   })
   it('POST /tables should create a table', async () => {
-    const { data: newTable } = await axios.post(`${URL}/tables`, { name: 'test' })
+    const { data: newTable } = await axios.post(`${URL}/tables`, { name: 'test', comment: 'foo' })
     assert.equal(`${newTable.schema}.${newTable.name}`, 'public.test')
+    assert.equal(newTable.comment, 'foo')
 
     const { data: tables } = await axios.get(`${URL}/tables`)
     const newTableExists = tables.some((table) => table.id === newTable.id)
@@ -246,10 +247,12 @@ describe('/tables', async () => {
       name: 'test a',
       rls_enabled: true,
       rls_forced: true,
+      comment: 'foo',
     })
     assert.equal(updatedTable.name, `test a`)
     assert.equal(updatedTable.rls_enabled, true)
     assert.equal(updatedTable.rls_forced, true)
+    assert.equal(updatedTable.comment, 'foo')
     await axios.delete(`${URL}/tables/${newTable.id}`)
   })
   it('DELETE /tables', async () => {
@@ -268,6 +271,7 @@ describe('/tables', async () => {
       type: 'int2',
       default_value: 42,
       is_nullable: false,
+      comment: 'foo',
       // Currently no way to test these:
       //   isPrimaryKey: true,
       //   isUnique: true,
@@ -280,6 +284,7 @@ describe('/tables', async () => {
     )
     assert.equal(newColumn.default_value, 42)
     assert.equal(newColumn.is_nullable, false)
+    assert.equal(newColumn.comment, 'foo')
 
     await axios.delete(`${URL}/columns/${newTable.id}.1`)
     await axios.delete(`${URL}/tables/${newTable.id}`)
@@ -291,13 +296,15 @@ describe('/tables', async () => {
       name: 'foo',
       type: 'int2',
       default_value: 42,
+      comment: 'foo',
     })
 
     await axios.patch(`${URL}/columns/${newTable.id}.1`, {
       name: 'foo bar',
       type: 'int4',
       drop_default: true,
       is_nullable: false,
+      comment: 'bar',
     })
 
     const { data: columns } = await axios.get(`${URL}/columns`)
@@ -307,6 +314,7 @@ describe('/tables', async () => {
     )
     assert.equal(updatedColumn.default_value, null)
     assert.equal(updatedColumn.is_nullable, false)
+    assert.equal(updatedColumn.comment, 'bar')
 
     await axios.delete(`${URL}/columns/${newTable.id}.1`)
     await axios.delete(`${URL}/tables/${newTable.id}`)