Files
supabase/apps/studio/data/sql/abort-query-mutation.ts
Ivan Vasilov 8b657165b5 chore: Migrate to use custom type for ReactQuery queries and mutations (#40073)
* Add custom types for queries, mutations and infinite queries.

* Migrate all queries to use the new type.

* Migrate all infinite queries to useCustomInfiniteQueryOptions.

* Migrate all mutations to use useCustomMutationOptions.

* Add type to all imports in `types` folder.
2025-11-03 13:18:13 +01:00

48 lines
1.5 KiB
TypeScript

import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'
import { executeSql } from 'data/sql/execute-sql-query'
import type { ResponseError, UseCustomMutationOptions } from 'types'
import { sqlKeys } from './keys'
export type QueryAbortVariables = {
pid: number
projectRef?: string
connectionString?: string | null
}
export async function abortQuery({ pid, projectRef, connectionString }: QueryAbortVariables) {
const sql = /* SQL */ `select pg_terminate_backend(${pid})`
const { result } = await executeSql({ projectRef, connectionString, sql })
return result
}
type QueryAbortData = Awaited<ReturnType<typeof abortQuery>>
export const useQueryAbortMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<QueryAbortData, ResponseError, QueryAbortVariables>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<QueryAbortData, ResponseError, QueryAbortVariables>({
mutationFn: (vars) => abortQuery(vars),
async onSuccess(data, variables, context) {
const { projectRef } = variables
await queryClient.invalidateQueries({ queryKey: sqlKeys.ongoingQueries(projectRef) })
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to abort query: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}