Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

2.8 KB
Raw Blame
import { Query } from '@supabase/pg-meta/src/query'
import { formatPatternMatchFilterValue } from '@supabase/pg-meta/src/query/table-row-query'
import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'

import { tableRowKeys } from './keys'
import type { Filter } from '@/components/grid/types'
import { executeSql } from '@/data/sql/execute-sql-mutation'
import { Entity } from '@/data/table-editor/table-editor-types'
import { RoleImpersonationState, wrapWithRoleImpersonation } from '@/lib/role-impersonation'
import { isRoleImpersonationEnabled } from '@/state/role-impersonation-state'
import type { ResponseError, UseCustomMutationOptions } from '@/types'

export type TableRowDeleteAllVariables = {
  projectRef: string
  connectionString?: string | null
  table: Entity
  filters: Filter[]
  roleImpersonationState?: RoleImpersonationState
}

export function getTableRowDeleteAllSql({
  table,
  filters,
}: Pick<TableRowDeleteAllVariables, 'table' | 'filters'>) {
  let queryChains = new Query().from(table.name, table.schema ?? undefined).delete()

  filters
    .filter((x) => x.value && x.value !== '')
    .forEach((x) => {
      const value = formatPatternMatchFilterValue(x.value, x.operator)
      queryChains = queryChains.filter(x.column, x.operator, value)
    })

  return queryChains.toSql()
}

export async function deleteAllTableRow({
  projectRef,
  connectionString,
  table,
  filters,
  roleImpersonationState,
}: TableRowDeleteAllVariables) {
  const sql = wrapWithRoleImpersonation(
    getTableRowDeleteAllSql({ table, filters }),
    roleImpersonationState
  )

  const { result } = await executeSql({
    projectRef,
    connectionString,
    sql,
    isRoleImpersonationEnabled: isRoleImpersonationEnabled(roleImpersonationState?.role),
  })

  return result
}

type TableRowDeleteAllData = Awaited<ReturnType<typeof deleteAllTableRow>>

/**
 * For deleting all rows based on a given filter
 */
export const useTableRowDeleteAllMutation = ({
  onSuccess,
  onError,
  ...options
}: Omit<
  UseCustomMutationOptions<TableRowDeleteAllData, ResponseError, TableRowDeleteAllVariables>,
  'mutationFn'
> = {}) => {
  const queryClient = useQueryClient()

  return useMutation<TableRowDeleteAllData, ResponseError, TableRowDeleteAllVariables>({
    mutationFn: (vars) => deleteAllTableRow(vars),
    async onSuccess(data, variables, context) {
      const { projectRef, table } = variables
      await queryClient.invalidateQueries({
        queryKey: tableRowKeys.tableRowsAndCount(projectRef, table.id),
      })
      await onSuccess?.(data, variables, context)
    },
    async onError(data, variables, context) {
      if (onError === undefined) {
        toast.error(`Failed to delete all table rows: ${data.message}`)
      } else {
        onError(data, variables, context)
      }
    },
    ...options,
  })
}