Files
supabase/apps/studio/data/database-functions/database-functions-query.ts
Alaister Young 6c592dec99 chore: remove useExecuteSqlQuery() part 2 (#30467)
* foreign-key-constraints

* update entity-types stale time

* schemas query

* deprecate useExecuteSqlQuery

* users count query

* database size query

* indexes query

* keywords query

* migrations query

* table columns

* database functions

* database roles query

* fdws query

* replication lag query

* ongoing queries query

* vault secrets query

* remove unneeded staleTime: 0

* max connections query

* fix entity types key in tests

* Some fixes

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2024-11-18 05:15:37 +00:00

52 lines
1.5 KiB
TypeScript

import pgMeta from '@supabase/pg-meta'
import { useQuery, UseQueryOptions } from '@tanstack/react-query'
import { databaseKeys } from 'data/database/keys'
import { executeSql } from 'data/sql/execute-sql-query'
import type { ResponseError } from 'types'
import { z } from 'zod'
export type DatabaseFunctionsVariables = {
projectRef?: string
connectionString?: string
}
export type DatabaseFunction = z.infer<typeof pgMeta.functions.pgFunctionZod>
const pgMetaFunctionsList = pgMeta.functions.list()
export async function getDatabaseFunctions(
{ projectRef, connectionString }: DatabaseFunctionsVariables,
signal?: AbortSignal
) {
const { result } = await executeSql(
{
projectRef,
connectionString,
sql: pgMetaFunctionsList.sql,
queryKey: ['database-functions'],
},
signal
)
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
}: UseQueryOptions<DatabaseFunctionsData, DatabaseFunctionsError, TData> = {}
) =>
useQuery<DatabaseFunctionsData, DatabaseFunctionsError, TData>(
databaseKeys.databaseFunctions(projectRef),
({ signal }) => getDatabaseFunctions({ projectRef, connectionString }, signal),
{
enabled: enabled && typeof projectRef !== 'undefined',
...options,
}
)