Files
supabase/apps/studio/data/database-extensions/database-extension-enable-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

79 lines
2.2 KiB
TypeScript

import { getEnableDatabaseExtensionSQL } from '@supabase/pg-meta'
import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'
import { databaseExtensionsKeys } from './keys'
import { configKeys } from '@/data/config/keys'
import { executeSql } from '@/data/sql/execute-sql-mutation'
import type { ResponseError, UseCustomMutationOptions } from '@/types'
export type DatabaseExtensionEnableVariables = {
projectRef: string
connectionString?: string | null
schema: string
name: string
version: string
cascade?: boolean
createSchema?: boolean
}
export async function enableDatabaseExtension({
projectRef,
connectionString,
schema,
name,
version,
cascade = false,
createSchema = false,
}: DatabaseExtensionEnableVariables) {
let headers = new Headers()
if (connectionString) headers.set('x-connection-encrypted', connectionString)
const sql = getEnableDatabaseExtensionSQL({ schema, name, version, cascade, createSchema })
const { result } = await executeSql({
projectRef,
connectionString,
sql,
queryKey: ['extension', 'create'],
})
return result
}
type DatabaseExtensionEnableData = Awaited<ReturnType<typeof enableDatabaseExtension>>
export const useDatabaseExtensionEnableMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<
DatabaseExtensionEnableData,
ResponseError,
DatabaseExtensionEnableVariables
>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<DatabaseExtensionEnableData, ResponseError, DatabaseExtensionEnableVariables>({
mutationFn: (vars) => enableDatabaseExtension(vars),
async onSuccess(data, variables, context) {
const { projectRef } = variables
await Promise.all([
queryClient.invalidateQueries({ queryKey: databaseExtensionsKeys.list(projectRef) }),
queryClient.invalidateQueries({ queryKey: configKeys.upgradeEligibility(projectRef) }),
])
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to enable database extension: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}