Files
supabase/apps/studio/data/config/disk-breakdown-query.ts
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

65 lines
1.7 KiB
TypeScript

import { safeSql } from '@supabase/pg-meta/src/pg-format'
import { useQuery } from '@tanstack/react-query'
import { configKeys } from './keys'
import { executeSql } from '@/data/sql/execute-sql-mutation'
import type { ResponseError, UseCustomQueryOptions } from '@/types'
export type DiskBreakdownVariables = {
projectRef?: string
connectionString?: string | null
}
type DiskBreakdownResult = {
db_size_bytes: number
wal_size_bytes: number
}
export async function getDiskBreakdown(
{ projectRef, connectionString }: DiskBreakdownVariables,
signal?: AbortSignal
) {
if (!projectRef) throw new Error('Project ref is required')
if (!connectionString) throw new Error('Connection string is required')
const { result } = await executeSql(
{
projectRef,
connectionString,
sql: safeSql`
SELECT
(
SELECT
SUM(pg_database_size(pg_database.datname)) AS db_size_bytes
FROM
pg_database
),
(
SELECT SUM(size)
FROM
pg_ls_waldir()
) AS wal_size_bytes`,
},
signal
)
return result[0] as DiskBreakdownResult
}
export type DiskBreakdownData = Awaited<ReturnType<typeof getDiskBreakdown>>
export type DiskBreakdownError = ResponseError
export const useDiskBreakdownQuery = <TData = DiskBreakdownData>(
{ projectRef, connectionString }: DiskBreakdownVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<DiskBreakdownData, DiskBreakdownError, TData> = {}
) =>
useQuery<DiskBreakdownData, DiskBreakdownError, TData>({
queryKey: configKeys.diskBreakdown(projectRef),
queryFn: ({ signal }) => getDiskBreakdown({ projectRef, connectionString }, signal),
enabled: enabled && typeof projectRef !== 'undefined',
...options,
})