mirror of
https://github.com/supabase/supabase.git
synced 2026-06-30 04:17:50 -04:00
Joshen Lim
1baaded0bb
## 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
106 lines
3.3 KiB
TypeScript
106 lines
3.3 KiB
TypeScript
import { type SafeSqlFragment } from '@supabase/pg-meta/src/pg-format'
|
|
import { useQuery } from '@tanstack/react-query'
|
|
|
|
import { DEFAULT_QUERY_PARAMS } from '@/components/interfaces/Reports/Reports.constants'
|
|
import {
|
|
BaseReportParams,
|
|
MetaQueryResponse,
|
|
ReportQueryDb,
|
|
} from '@/components/interfaces/Reports/Reports.types'
|
|
import { useReadReplicasQuery } from '@/data/read-replicas/replicas-query'
|
|
import { executeSql } from '@/data/sql/execute-sql-mutation'
|
|
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
|
|
import { IS_PLATFORM } from '@/lib/constants'
|
|
import { useDatabaseSelectorStateSnapshot } from '@/state/database-selector'
|
|
|
|
export interface DbQueryHook<T = any> {
|
|
isLoading: boolean
|
|
isRefetching: boolean
|
|
error: string
|
|
data: T[]
|
|
params: BaseReportParams
|
|
logData?: never
|
|
runQuery: () => void
|
|
setParams?: never
|
|
changeQuery?: never
|
|
resolvedSql: string
|
|
}
|
|
|
|
// [Joshen] Atm this is being used only in query performance
|
|
const useDbQuery = ({
|
|
sql,
|
|
params = DEFAULT_QUERY_PARAMS,
|
|
where,
|
|
orderBy,
|
|
}: {
|
|
sql: ReportQueryDb['safeSql'] | SafeSqlFragment
|
|
params?: BaseReportParams
|
|
where?: string
|
|
orderBy?: string
|
|
}): DbQueryHook => {
|
|
const { data: project } = useSelectedProjectQuery()
|
|
const state = useDatabaseSelectorStateSnapshot()
|
|
|
|
const { data: databases } = useReadReplicasQuery({ projectRef: project?.ref })
|
|
const connectionString = (databases || []).find(
|
|
(db) => db.identifier === state.selectedDatabaseId
|
|
)?.connection_string_read_only // default to using the read_only string
|
|
const identifier = state.selectedDatabaseId
|
|
|
|
// When a read-replica is selected, require its connection string before fetching.
|
|
// Falling back to the primary's connection string would silently query the wrong database.
|
|
const isPrimarySelected = !state.selectedDatabaseId || state.selectedDatabaseId === project?.ref
|
|
const effectiveConnectionString = isPrimarySelected
|
|
? (connectionString ?? project?.connectionString)
|
|
: connectionString
|
|
|
|
const resolvedSql = typeof sql === 'function' ? sql([]) : sql
|
|
|
|
const {
|
|
data,
|
|
error: rqError,
|
|
isPending,
|
|
isRefetching,
|
|
refetch,
|
|
} = useQuery({
|
|
queryKey: [
|
|
'projects',
|
|
project?.ref,
|
|
'db',
|
|
{ ...params, sql: resolvedSql, identifier, connectionString: effectiveConnectionString },
|
|
where,
|
|
orderBy,
|
|
],
|
|
queryFn: ({ signal }) => {
|
|
return executeSql(
|
|
{
|
|
projectRef: project?.ref,
|
|
connectionString: effectiveConnectionString,
|
|
sql: resolvedSql,
|
|
},
|
|
signal
|
|
).then((res) => res.result) as Promise<MetaQueryResponse>
|
|
},
|
|
// Don't run until we have a connection string for the selected database.
|
|
// For replicas this prevents a silent fallback to the primary before replicas load.
|
|
// In self-hosted mode (IS_PLATFORM=false) there is no real connection string, so we
|
|
// skip the check — executeSql works fine without one on self-hosted deployments.
|
|
enabled: Boolean(resolvedSql) && (!IS_PLATFORM || Boolean(effectiveConnectionString)),
|
|
refetchOnWindowFocus: false,
|
|
refetchOnReconnect: false,
|
|
})
|
|
|
|
const error = rqError || (typeof data === 'object' ? data?.error : '')
|
|
return {
|
|
error,
|
|
data,
|
|
isLoading: isPending,
|
|
isRefetching,
|
|
params,
|
|
runQuery: refetch,
|
|
resolvedSql,
|
|
}
|
|
}
|
|
|
|
export default useDbQuery
|