supabase/apps/studio/data/database-indexes/index-create-mutation.ts

import { ident, joinSqlFragments, keyword, safeSql } from '@supabase/pg-meta/src/pg-format'
import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'

import { databaseIndexesKeys } from './keys'
import { executeSql } from '@/data/sql/execute-sql-mutation'
import type { ResponseError, UseCustomMutationOptions } from '@/types'

export type DatabaseIndexCreateVariables = {
  projectRef: string
  connectionString?: string | null
  payload: {
    schema: string
    entity: string
    type: string
    columns: string[]
  }
}

export async function createDatabaseIndex({
  projectRef,
  connectionString,
  payload,
}: DatabaseIndexCreateVariables) {
  const { schema, entity, type, columns } = payload

  const columnList = joinSqlFragments(
    columns.map((column) => ident(column)),
    ', '
  )
  const sql = safeSql`CREATE INDEX ON ${ident(schema)}.${ident(entity)} USING ${keyword(type)} (${columnList});`

  const { result } = await executeSql({
    projectRef,
    connectionString,
    sql,
    queryKey: ['indexes', schema],
  })

  return result
}

type DatabaseIndexCreateData = Awaited<ReturnType<typeof createDatabaseIndex>>

export const useDatabaseIndexCreateMutation = ({
  onSuccess,
  onError,
  ...options
}: Omit<
  UseCustomMutationOptions<DatabaseIndexCreateData, ResponseError, DatabaseIndexCreateVariables>,
  'mutationFn'
> = {}) => {
  const queryClient = useQueryClient()

  return useMutation<DatabaseIndexCreateData, ResponseError, DatabaseIndexCreateVariables>({
    mutationFn: (vars) => createDatabaseIndex(vars),
    async onSuccess(data, variables, context) {
      const { projectRef } = variables
      await queryClient.invalidateQueries({ queryKey: databaseIndexesKeys.list(projectRef) })
      await onSuccess?.(data, variables, context)
    },
    async onError(data, variables, context) {
      if (onError === undefined) {
        toast.error(`Failed to create database index: ${data.message}`)
      } else {
        onError(data, variables, context)
      }
    },
    ...options,
  })
}