Skip to content

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

2.2 KB
Raw Blame
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,
  })
}