Files
supabase/apps/studio/data/database-functions/database-functions-query.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

54 lines
1.6 KiB
TypeScript

import pgMeta from '@supabase/pg-meta'
import { useQuery } from '@tanstack/react-query'
import { databaseKeys } from 'data/database/keys'
import { executeSql } from 'data/sql/execute-sql-query'
import type { ResponseError, UseCustomQueryOptions } from 'types'
import { z } from 'zod'
export type DatabaseFunctionsVariables = {
projectRef?: string
connectionString?: string | null
}
export type DatabaseFunction = z.infer<typeof pgMeta.functions.pgFunctionZod>
const pgMetaFunctionsList = pgMeta.functions.list()
export async function getDatabaseFunctions(
{ projectRef, connectionString }: DatabaseFunctionsVariables,
signal?: AbortSignal,
headersInit?: HeadersInit
) {
let headers = new Headers(headersInit)
const { result } = await executeSql(
{
projectRef,
connectionString,
sql: pgMetaFunctionsList.sql,
queryKey: ['database-functions'],
},
signal,
headers
)
return result as DatabaseFunction[]
}
export type DatabaseFunctionsData = z.infer<typeof pgMetaFunctionsList.zod>
export type DatabaseFunctionsError = ResponseError
export const useDatabaseFunctionsQuery = <TData = DatabaseFunctionsData>(
{ projectRef, connectionString }: DatabaseFunctionsVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<DatabaseFunctionsData, DatabaseFunctionsError, TData> = {}
) =>
useQuery<DatabaseFunctionsData, DatabaseFunctionsError, TData>({
queryKey: databaseKeys.databaseFunctions(projectRef),
queryFn: ({ signal }) => getDatabaseFunctions({ projectRef, connectionString }, signal),
enabled: enabled && typeof projectRef !== 'undefined',
...options,
})