The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
import { useMutation, useQueryClient, type UseMutationOptions } from '@tanstack/react-query'
import { toast } from 'sonner'
import { storageKeys } from '../keys'
import { objectVersionsQueryOptions } from './object-versions-query'
import { del, handleError } from '@/data/fetchers'
import type { ResponseError } from '@/types'
export type ObjectPurgeVariables = {
projectRef: string
bucketId: string
/** The object's full path within the bucket, not just its leaf name. */
path: string
}
/**
* No single endpoint does this: a bare path only hides what is current, so the history
* is read first and every version deleted by id, delete markers included.
*/
export const useObjectPurgeMutation = ({
onSuccess,
onError,
...options
}: Omit<UseMutationOptions<void, ResponseError, ObjectPurgeVariables>, 'mutationFn'> = {}) => {
const queryClient = useQueryClient()
const purgeObject = async ({ projectRef, bucketId, path }: ObjectPurgeVariables) => {
if (!projectRef) throw new Error('projectRef is required')
if (!bucketId) throw new Error('bucketId is required')
if (!path) throw new Error('path is required')
const listVersions = () =>
queryClient.fetchQuery({
...objectVersionsQueryOptions({ projectRef, bucketId, path }),
// Each round has to see what the last one left behind, not the cached first page.
staleTime: 0,
})
const deleteVersions = async (paths: ({ path: string; versionId: string } | string)[]) => {
const { error } = await del('/platform/storage/{ref}/buckets/{id}/objects', {
params: { path: { ref: projectRef, id: bucketId } },
body: { paths },
})
if (error) handleError(error)
}
let versions = await listVersions()
// A never-versioned bucket has no version ids, so the bare path is the only address.
if (versions.length === 0) {
await deleteVersions([path])
return
}
// The list endpoint returns one capped page, so a longer history takes several rounds.
// Deleting only the first would report a purge that left versions behind.
while (versions.length > 0) {
await deleteVersions(versions.map((version) => ({ path, versionId: version.versionId })))
const remaining = await listVersions()
// Nothing went away, so another round would spin rather than make progress.
if (remaining.length >= versions.length) {
throw new Error(`Some versions of ${path} could not be deleted`)
}
versions = remaining
}
}
return useMutation<void, ResponseError, ObjectPurgeVariables>({
mutationFn: purgeObject,
async onSuccess(data, variables, context, mutationContext) {
// The object list lives in the explorer's state, not React Query.
await queryClient.invalidateQueries({
queryKey: storageKeys.objectVersions(
variables.projectRef,
variables.bucketId,
variables.path
),
})
await onSuccess?.(data, variables, context, mutationContext)
},
async onError(error, variables, context, mutationContext) {
if (onError === undefined) toast.error(`Failed to delete object: ${error.message}`)
else onError(error, variables, context, mutationContext)
},
...options,
})
}