feat: more options on /column POST & PATCH

Still missing some parameters (e.g. PATCH identity), but good enough for most use cases.

Author: soedirgo

src/api/columns.ts

@@ -31,15 +31,16 @@ router.get('/', async (req, res) => {
 
 router.post('/', async (req, res) => {
   try {
-    const { tableId, name, type } = req.body as {
-      tableId: number
-      name: string
-      type: string
-    }
+    const tableId: number = req.body.tableId
+    const name: string = req.body.name
     const getTableQuery = getTableSqlize(tableId)
     const { name: table, schema } = (await RunQuery(req.headers.pg, getTableQuery)).data[0]
 
-    const query = addColumnSqlize({ schema, table, name, type })
+    const addColumnArgs = req.body
+    delete addColumnArgs.tableId
+    addColumnArgs.table = table
+    addColumnArgs.schema = schema
+    const query = addColumnSqlize(addColumnArgs)
     await RunQuery(req.headers.pg, query)
 
     const getColumnQuery = getColumnSqlize(tableId, name)
@@ -59,12 +60,11 @@ router.patch('/:id', async (req, res) => {
     const column = (await RunQuery(req.headers.pg, getColumnQuery)).data[0]
     const { schema, table, name: oldName } = column
 
-    const { name, type } = req.body as {
-      name?: string
-      type?: string
-    }
-
-    const query = patchColumnSqlize({ schema, table, oldName, name, type })
+    const alterColumnArgs = req.body
+    alterColumnArgs.schema = schema
+    alterColumnArgs.table = table
+    alterColumnArgs.oldName = oldName
+    const query = alterColumnSqlize(alterColumnArgs)
     await RunQuery(req.headers.pg, query)
 
     const updated = (await RunQuery(req.headers.pg, getColumnQuery)).data[0]
@@ -100,13 +100,35 @@ const addColumnSqlize = ({
   table,
   name,
   type,
+  defaultValue,
+  isIdentity = false,
+  isNullable = true,
+  isPrimaryKey = false,
+  isUnique = false,
 }: {
   schema: string
   table: string
   name: string
   type: string
+  defaultValue?: any
+  isIdentity?: boolean
+  isNullable?: boolean
+  isPrimaryKey?: boolean
+  isUnique?: boolean
 }) => {
-  return `ALTER TABLE "${schema}"."${table}" ADD COLUMN "${name}" "${type}"`
+  const defaultValueSql = defaultValue === undefined ? '' : `DEFAULT ${defaultValue}`
+  const isIdentitySql = isIdentity ? 'GENERATED BY DEFAULT AS IDENTITY' : ''
+  const isNullableSql = isNullable ? 'NULL' : 'NOT NULL'
+  const isPrimaryKeySql = isPrimaryKey ? 'PRIMARY KEY' : ''
+  const isUniqueSql = isUnique ? 'UNIQUE' : ''
+
+  return `
+ALTER TABLE "${schema}"."${table}" ADD COLUMN "${name}" "${type}"
+  ${defaultValueSql}
+  ${isIdentitySql}
+  ${isNullableSql}
+  ${isPrimaryKeySql}
+  ${isUniqueSql}`
 }
 const getColumnSqlize = (tableId: number, name: string) => {
   return SQL``.append(columns).append(SQL` WHERE c.oid = ${tableId} AND column_name = ${name}`)
@@ -116,18 +138,24 @@ const getColumnByPosSqlize = (tableId: number, ordinalPos: number) => {
     .append(columns)
     .append(SQL` WHERE c.oid = ${tableId} AND ordinal_position = ${ordinalPos}`)
 }
-const patchColumnSqlize = ({
+const alterColumnSqlize = ({
   schema,
   table,
   oldName,
   name,
   type,
+  dropDefault = false,
+  defaultValue,
+  isNullable,
 }: {
   schema: string
   table: string
   oldName: string
   name?: string
   type?: string
+  dropDefault?: boolean
+  defaultValue?: any
+  isNullable?: boolean
 }) => {
   const nameSql =
     name === undefined
@@ -137,9 +165,24 @@ const patchColumnSqlize = ({
     type === undefined
       ? ''
       : `ALTER TABLE "${schema}"."${table}" ALTER COLUMN "${oldName}" SET DATA TYPE "${type}";`
-  // Make sure typeSql comes first
+  let defaultValueSql = ''
+  if (dropDefault) {
+    defaultValueSql = `ALTER TABLE "${schema}"."${table}" ALTER COLUMN "${oldName}" DROP DEFAULT;`
+  } else if (defaultValue !== undefined) {
+    defaultValueSql = `ALTER TABLE "${schema}"."${table}" ALTER COLUMN "${oldName}" SET DEFAULT ${defaultValue};`
+  }
+  let isNullableSql = ''
+  if (isNullable !== undefined) {
+    isNullableSql = isNullable
+      ? `ALTER TABLE "${schema}"."${table}" ALTER COLUMN "${oldName}" DROP NOT NULL;`
+      : `ALTER TABLE "${schema}"."${table}" ALTER COLUMN "${oldName}" SET NOT NULL;`
+  }
+
+  // nameSql must be last.
   return `
 BEGIN;
+  ${isNullableSql}
+  ${defaultValueSql}
   ${typeSql}
   ${nameSql}
 COMMIT;`

test/integration/index.spec.js

@@ -260,30 +260,51 @@ describe('/tables', async () => {
   })
   it('POST /columns', async () => {
     const { data: newTable } = await axios.post(`${URL}/tables`, { name: 'foo bar' })
-    await axios.post(`${URL}/columns`, { tableId: newTable.id, name: 'foo bar', type: 'int2' })
+    await axios.post(`${URL}/columns`, {
+      tableId: newTable.id,
+      name: 'foo bar',
+      type: 'int2',
+      defaultValue: 42,
+      isNullable: false,
+      // Currently no way to test these:
+      //   isPrimaryKey: true,
+      //   isUnique: true,
+    })
 
     const { data: columns } = await axios.get(`${URL}/columns`)
-    const newColumnExists = columns.some(
+    const newColumn = columns.find(
       (column) =>
         column.id === `${newTable.id}.1` && column.name === 'foo bar' && column.format === 'int2'
     )
-    assert.equal(newColumnExists, true)
+    assert.equal(newColumn.default_value, 42)
+    assert.equal(newColumn.is_nullable, false)
 
     await axios.delete(`${URL}/columns/${newTable.id}.1`)
     await axios.delete(`${URL}/tables/${newTable.id}`)
   })
   it('PATCH /columns', async () => {
     const { data: newTable } = await axios.post(`${URL}/tables`, { name: 'foo bar' })
-    await axios.post(`${URL}/columns`, { tableId: newTable.id, name: 'foo', type: 'int2' })
+    await axios.post(`${URL}/columns`, {
+      tableId: newTable.id,
+      name: 'foo',
+      type: 'int2',
+      defaultValue: 42,
+    })
 
-    await axios.patch(`${URL}/columns/${newTable.id}.1`, { name: 'foo bar', type: 'int4' })
+    await axios.patch(`${URL}/columns/${newTable.id}.1`, {
+      name: 'foo bar',
+      type: 'int4',
+      dropDefault: true,
+      isNullable: false,
+    })
 
     const { data: columns } = await axios.get(`${URL}/columns`)
-    const updatedColumnExists = columns.some(
+    const updatedColumn = columns.find(
       (column) =>
         column.id === `${newTable.id}.1` && column.name === 'foo bar' && column.format === 'int4'
     )
-    assert.equal(updatedColumnExists, true)
+    assert.equal(updatedColumn.default_value, null)
+    assert.equal(updatedColumn.is_nullable, false)
 
     await axios.delete(`${URL}/columns/${newTable.id}.1`)
     await axios.delete(`${URL}/tables/${newTable.id}`)