Function useUpdateColumn

apps/sim/hooks/queries/tables.ts:1185–1231

({ workspaceId, tableId }: RowMutationContext)

 * Update a column (rename, type change, or constraint update).
 */
export function useUpdateColumn({ workspaceId, tableId }: RowMutationContext) {
  const queryClient = useQueryClient()

  return useMutation({
    mutationFn: async ({ columnName, updates }: UpdateColumnParams) => {
      return requestJson(updateTableColumnContract, {
        params: { tableId },
        body: { workspaceId, columnName, updates },
      })
    },
    onMutate: async ({ columnName, updates }) => {
      await queryClient.cancelQueries({ queryKey: tableKeys.detail(tableId) })
      const previousDetail = queryClient.getQueryData<TableDefinition>(tableKeys.detail(tableId))
      if (previousDetail) {
        // `columnName` is the column id (first-party) or name (legacy); match
        // either. A rename is metadata-only and never moves id-keyed row data,
        // so we only patch the schema column's name — never `row.data` keys.
        // Stamp the current storage id so `getColumnId` stays stable as the
        // display name changes (mirrors the server's metadata-only rename).
        const lower = columnName.toLowerCase()
        const isRename = typeof (updates as { name?: string }).name === 'string'
        const nextColumns = previousDetail.schema.columns.map((c) => {
          if (getColumnId(c) !== columnName && c.name.toLowerCase() !== lower) return c
          const next = { ...c, ...updates }
          if (isRename && next.id === undefined) next.id = getColumnId(c)
          return next
        })
        queryClient.setQueryData<TableDefinition>(tableKeys.detail(tableId), {
          ...previousDetail,
          schema: { ...previousDetail.schema, columns: nextColumns },
        })
      }

      return { previousDetail }
    },
    onError: (error, _vars, context) => {
      if (context?.previousDetail) {
        queryClient.setQueryData(tableKeys.detail(tableId), context.previousDetail)
      }
      if (isValidationError(error)) return
      toast.error(error.message, { duration: 5000 })
    },
    onSettled: () => {
      invalidateTableSchema(queryClient, tableId)
    },
  })
}

/**
 * Update a table's UI metadata (e.g. column widths).