Files
supabase/apps/studio/data/table-rows/table-row-delete-all-mutation.ts
2024-03-04 20:48:22 +08:00

92 lines
2.6 KiB
TypeScript

import { useMutation, UseMutationOptions, useQueryClient } from '@tanstack/react-query'
import { toast } from 'react-hot-toast'
import { Filter, Query, SupaTable } from 'components/grid'
import { executeSql } from 'data/sql/execute-sql-query'
import { sqlKeys } from 'data/sql/keys'
import { ImpersonationRole, wrapWithRoleImpersonation } from 'lib/role-impersonation'
import { isRoleImpersonationEnabled } from 'state/role-impersonation-state'
import type { ResponseError } from 'types'
import { formatFilterValue } from './utils'
export type TableRowDeleteAllVariables = {
projectRef: string
connectionString?: string
table: SupaTable
filters: Filter[]
impersonatedRole?: ImpersonationRole
}
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 = formatFilterValue(table, x)
queryChains = queryChains.filter(x.column, x.operator, value)
})
return queryChains.toSql()
}
export async function deleteAllTableRow({
projectRef,
connectionString,
table,
filters,
impersonatedRole,
}: TableRowDeleteAllVariables) {
const sql = wrapWithRoleImpersonation(getTableRowDeleteAllSql({ table, filters }), {
projectRef,
role: impersonatedRole,
})
const { result } = await executeSql({
projectRef,
connectionString,
sql,
isRoleImpersonationEnabled: isRoleImpersonationEnabled(impersonatedRole),
})
return result
}
type TableRowDeleteAllData = Awaited<ReturnType<typeof deleteAllTableRow>>
/**
* For deleting all rows based on a given filter
*/
export const useTableRowDeleteAllMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseMutationOptions<TableRowDeleteAllData, ResponseError, TableRowDeleteAllVariables>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<TableRowDeleteAllData, ResponseError, TableRowDeleteAllVariables>(
(vars) => deleteAllTableRow(vars),
{
async onSuccess(data, variables, context) {
const { projectRef, table } = variables
await queryClient.invalidateQueries(sqlKeys.query(projectRef, [table.schema, table.name]))
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,
}
)
}