Files
supabase/apps/studio/data/tables/table-create-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

72 lines
1.9 KiB
TypeScript

import pgMeta from '@supabase/pg-meta'
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 { tableKeys } from './keys'
export type CreateTableBody = {
name: string
schema?: string
comment?: string
}
export type TableCreateVariables = {
projectRef: string
connectionString?: string | null
// the schema is required field
payload: CreateTableBody & { schema: string }
}
export async function createTable({ projectRef, connectionString, payload }: TableCreateVariables) {
const { sql } = pgMeta.tables.create(payload)
const { result } = await executeSql<void>({
projectRef,
connectionString,
sql,
queryKey: ['table', 'create'],
})
return result
}
type TableCreateData = Awaited<ReturnType<typeof createTable>>
export const useTableCreateMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<TableCreateData, ResponseError, TableCreateVariables>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<TableCreateData, ResponseError, TableCreateVariables>({
mutationFn: (vars) => createTable(vars),
async onSuccess(data, variables, context) {
const { projectRef, payload } = variables
await Promise.all([
queryClient.invalidateQueries({
queryKey: tableKeys.list(projectRef, payload.schema, true),
}),
queryClient.invalidateQueries({
queryKey: tableKeys.list(projectRef, payload.schema, false),
}),
])
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to create database table: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}