Files
supabase/apps/studio/data/database-triggers/database-trigger-update-transaction-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

87 lines
3.0 KiB
TypeScript

import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'
import { PGTrigger, PGTriggerCreate } from '@supabase/pg-meta/src/pg-meta-triggers'
import { PostgresTrigger } from '@supabase/postgres-meta'
import { executeSql } from 'data/sql/execute-sql-query'
import { quoteLiteral } from 'lib/pg-format'
import type { ResponseError, UseCustomMutationOptions } from 'types'
import { databaseTriggerKeys } from './keys'
// [Joshen] Writing this query within FE as the PATCH endpoint from pg-meta only supports updating
// trigger name and enabled mode. So we'll delete and create the trigger, within a single transaction
// Copying the SQL from https://github.com/supabase/postgres-meta/blob/master/src/lib/PostgresMetaTriggers.ts
export type DatabaseTriggerUpdateVariables = {
projectRef: string
connectionString?: string | null
originalTrigger: PostgresTrigger
updatedTrigger: PGTriggerCreate & Pick<PGTrigger, 'enabled_mode'>
}
export function getDatabaseTriggerUpdateSQL({
originalTrigger,
updatedTrigger,
}: Pick<DatabaseTriggerUpdateVariables, 'originalTrigger' | 'updatedTrigger'>) {
const { name, activation, events, schema, table, function_schema, function_name, function_args } =
updatedTrigger
return /* SQL */ `
BEGIN;
DROP TRIGGER "${originalTrigger.name}" ON "${originalTrigger.schema}"."${originalTrigger.table}";
CREATE TRIGGER "${name}" ${activation} ${events.join(' OR ')} ON "${schema}"."${table}"
FOR EACH ROW EXECUTE FUNCTION
"${function_schema}"."${function_name}"(${function_args?.map(quoteLiteral).join(',') ?? ''});
COMMIT;
`.trim()
}
export async function updateDatabaseTrigger({
projectRef,
connectionString,
originalTrigger,
updatedTrigger,
}: DatabaseTriggerUpdateVariables) {
const sql = getDatabaseTriggerUpdateSQL({ originalTrigger, updatedTrigger })
await executeSql({
projectRef,
connectionString,
sql,
queryKey: ['trigger', 'update', originalTrigger.id],
})
return updatedTrigger
}
type DatabaseTriggerUpdateTxnData = Awaited<ReturnType<typeof updateDatabaseTrigger>>
export const useDatabaseTriggerUpdateMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<
DatabaseTriggerUpdateTxnData,
ResponseError,
DatabaseTriggerUpdateVariables
>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<DatabaseTriggerUpdateTxnData, ResponseError, DatabaseTriggerUpdateVariables>({
mutationFn: (vars) => updateDatabaseTrigger(vars),
async onSuccess(data, variables, context) {
const { projectRef } = variables
await queryClient.invalidateQueries({ queryKey: databaseTriggerKeys.list(projectRef) })
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to update database trigger: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}