Files
supabase/apps/studio/data/auth/user-search-indexes-query.ts
issuedat cb25d2383a feat(auth): allow opting in to creating indexes on auth.users (#40955)
* feat(auth): allow opting in to creating indexes on `auth.users`

* chore: organize imports. use alert above table.

* chore: use default type to avoid 2 primary actions
2025-12-08 10:42:18 +01:00

58 lines
1.5 KiB
TypeScript

import pgMeta from '@supabase/pg-meta'
import { useQuery } from '@tanstack/react-query'
import { executeSql, type ExecuteSqlError } from 'data/sql/execute-sql-query'
import { UseCustomQueryOptions } from 'types'
import { authKeys } from './keys'
type UsersIndexStatusesVariables = {
projectRef?: string
connectionString?: string | null
}
type UsersIndexStatusesData = {
index_name: string
is_valid: boolean
is_ready: boolean
}[]
export type UsersIndexStatusesError = ExecuteSqlError
export async function getUserIndexStatuses(
{ projectRef, connectionString }: UsersIndexStatusesVariables,
signal?: AbortSignal
): Promise<UsersIndexStatusesData> {
const sql = pgMeta.getIndexStatusesSQL()
const { result } = await executeSql<UsersIndexStatusesData>(
{
projectRef,
connectionString,
sql,
queryKey: ['index-statuses'],
},
signal
)
return result
}
export const useUserIndexStatusesQuery = <TData = UsersIndexStatusesData>(
{ projectRef, connectionString }: UsersIndexStatusesVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<UsersIndexStatusesData, UsersIndexStatusesError, TData> = {}
) =>
useQuery<UsersIndexStatusesData, UsersIndexStatusesError, TData>({
queryKey: authKeys.usersIndexStatuses(projectRef),
queryFn: ({ signal }) =>
getUserIndexStatuses(
{
projectRef,
connectionString,
},
signal
),
enabled: enabled && typeof projectRef !== 'undefined',
...options,
})