Files
supabase/apps/studio/data/table-rows/get-cell-value-mutation.ts
Joshen Lim 1baaded0bb Consolidate execute-sql-query into execute-sql-mutation (#46944)
## Context

Just some clean up as I was going through stuff
- `useExecuteSqlQuery` is deprecated and not used at all
- As such `execute-sql-query` is technically irrelevant, the more
relevant file is `execute-sql-mutation`
- Hence opting to consolidate `execute-sql-query` into
`execute-sql-mutation`
- Also removing `ExecuteSqlError` since its just re-exporting the
`ResponseError` type

There's a lot of file changes but its essentially just updating the
importing statements across the files
2026-06-16 00:07:16 +08:00

78 lines
2.1 KiB
TypeScript

import { ident } from '@supabase/pg-meta'
import { Query } from '@supabase/pg-meta/src/query'
import { useMutation } from '@tanstack/react-query'
import { toast } from 'sonner'
import { executeSql } from '@/data/sql/execute-sql-mutation'
import { RoleImpersonationState, wrapWithRoleImpersonation } from '@/lib/role-impersonation'
import { isRoleImpersonationEnabled } from '@/state/role-impersonation-state'
import type { ResponseError, UseCustomMutationOptions } from '@/types'
export type GetCellValueVariables = {
projectRef: string
connectionString?: string | null
table: { schema: string; name: string }
column: string
pkMatch: { [key: string]: any }
roleImpersonationState?: RoleImpersonationState
}
export function getCellValueSql({
table,
column,
pkMatch,
}: Pick<GetCellValueVariables, 'table' | 'column' | 'pkMatch'>) {
return new Query()
.from(table.name, table.schema ?? undefined)
.select(ident(column))
.match(pkMatch)
.toSql()
}
export async function getCellValue({
projectRef,
connectionString,
table,
column,
pkMatch,
roleImpersonationState,
}: GetCellValueVariables) {
const sql = wrapWithRoleImpersonation(
getCellValueSql({ table, column, pkMatch }),
roleImpersonationState
)
const { result } = await executeSql({
projectRef,
connectionString,
sql,
isRoleImpersonationEnabled: isRoleImpersonationEnabled(roleImpersonationState?.role),
})
return result?.[0][column]
}
type TableRowCreateData = Awaited<ReturnType<typeof getCellValue>>
export const useGetCellValueMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<TableRowCreateData, ResponseError, GetCellValueVariables>,
'mutationFn'
> = {}) => {
return useMutation<TableRowCreateData, ResponseError, GetCellValueVariables>({
mutationFn: (vars) => getCellValue(vars),
async onSuccess(data, variables, context) {
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(data.message)
} else {
onError(data, variables, context)
}
},
...options,
})
}