Files
supabase/apps/studio/data/database/entity-definitions-query.ts
T
Joshen Lim 1baaded0bb Consolidate execute-sql-query into execute-sql-mutation (#46944)
## Context

Just some clean up as I was going through stuff
- `useExecuteSqlQuery` is deprecated and not used at all
- As such `execute-sql-query` is technically irrelevant, the more
relevant file is `execute-sql-mutation`
- Hence opting to consolidate `execute-sql-query` into
`execute-sql-mutation`
- Also removing `ExecuteSqlError` since its just re-exporting the
`ResponseError` type

There's a lot of file changes but its essentially just updating the
importing statements across the files
2026-06-16 00:07:16 +08:00

51 lines
1.6 KiB
TypeScript

import { getEntityDefinitionsSql } from '@supabase/pg-meta'
import { useQuery } from '@tanstack/react-query'
import { databaseKeys } from './keys'
import { executeSql } from '@/data/sql/execute-sql-mutation'
import { ResponseError, UseCustomQueryOptions } from '@/types'
export type EntityDefinitionsVariables = {
limit?: number
projectRef?: string
connectionString?: string | null
schemas: string[]
}
export async function getEntityDefinitions(
{ projectRef, connectionString, schemas, limit }: EntityDefinitionsVariables,
signal?: AbortSignal
) {
const sql = getEntityDefinitionsSql({ schemas, limit })
const { result } = await executeSql(
{
projectRef,
connectionString,
sql,
queryKey: ['entity-definitions', schemas],
},
signal
)
return result[0].data.definitions
}
type EntityDefinition = { id: number; sql: string }
export type EntityDefinitionsData = EntityDefinition[]
export type EntityDefinitionsError = ResponseError
export const useEntityDefinitionsQuery = <TData = EntityDefinitionsData>(
{ projectRef, connectionString, schemas, limit }: EntityDefinitionsVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<EntityDefinitionsData, EntityDefinitionsError, TData> = {}
) =>
useQuery<EntityDefinitionsData, EntityDefinitionsError, TData>({
queryKey: databaseKeys.entityDefinitions(projectRef, schemas),
queryFn: ({ signal }) =>
getEntityDefinitions({ projectRef, connectionString, schemas, limit }, signal),
enabled: enabled && typeof projectRef !== 'undefined' && schemas.length > 0,
...options,
})