Files
supabase/apps/studio/data/database-publications/database-publications-update-mutation.ts
T
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

85 lines
2.1 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 { databasePublicationsKeys } from './keys'
export type DatabasePublicationUpdateVariables = {
projectRef: string
connectionString?: string | null
id: number
tables?: string[]
publish_insert?: boolean
publish_update?: boolean
publish_delete?: boolean
publish_truncate?: boolean
}
export async function updateDatabasePublication({
projectRef,
connectionString,
id,
tables,
publish_insert,
publish_update,
publish_delete,
publish_truncate,
}: DatabasePublicationUpdateVariables) {
const { sql } = pgMeta.publications.update(id, {
tables,
publish_insert,
publish_update,
publish_delete,
publish_truncate,
})
const { result } = await executeSql({
projectRef,
connectionString,
sql,
queryKey: ['publication', 'update', id],
})
return result
}
type DatabasePublicationUpdateData = Awaited<ReturnType<typeof updateDatabasePublication>>
export const useDatabasePublicationUpdateMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<
DatabasePublicationUpdateData,
ResponseError,
DatabasePublicationUpdateVariables
>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<
DatabasePublicationUpdateData,
ResponseError,
DatabasePublicationUpdateVariables
>({
mutationFn: (vars) => updateDatabasePublication(vars),
async onSuccess(data, variables, context) {
const { projectRef } = variables
await queryClient.invalidateQueries({ queryKey: databasePublicationsKeys.list(projectRef) })
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to update database publication: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}