mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
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
99 lines
2.3 KiB
TypeScript
99 lines
2.3 KiB
TypeScript
import type { OptimizedSearchColumns } from '@supabase/pg-meta'
|
|
import { getUsersCountSQL } from '@supabase/pg-meta'
|
|
import { useQuery } from '@tanstack/react-query'
|
|
|
|
import { authKeys } from './keys'
|
|
import { type Filter } from './users-infinite-query'
|
|
import { executeSql } from '@/data/sql/execute-sql-mutation'
|
|
import { ResponseError, UseCustomQueryOptions } from '@/types'
|
|
|
|
type UsersCountVariables = {
|
|
projectRef?: string
|
|
connectionString?: string | null
|
|
keywords?: string
|
|
filter?: Filter
|
|
providers?: string[]
|
|
forceExactCount?: boolean
|
|
|
|
/** If set, uses optimized prefix search for the specified column */
|
|
column?: OptimizedSearchColumns
|
|
}
|
|
|
|
export async function getUsersCount(
|
|
{
|
|
projectRef,
|
|
connectionString,
|
|
keywords,
|
|
filter,
|
|
providers,
|
|
forceExactCount,
|
|
column,
|
|
}: UsersCountVariables,
|
|
signal?: AbortSignal
|
|
) {
|
|
const sql = getUsersCountSQL({ filter, keywords, providers, forceExactCount, column })
|
|
|
|
const { result } = await executeSql(
|
|
{
|
|
projectRef,
|
|
connectionString,
|
|
sql,
|
|
queryKey: ['users-count'],
|
|
},
|
|
signal
|
|
)
|
|
|
|
const count = result?.[0]?.count
|
|
const isEstimate = result?.[0]?.is_estimate
|
|
|
|
if (typeof count !== 'number') {
|
|
throw new Error('Error fetching users count')
|
|
}
|
|
|
|
return {
|
|
count,
|
|
is_estimate: isEstimate ?? true,
|
|
}
|
|
}
|
|
|
|
export type UsersCountData = Awaited<ReturnType<typeof getUsersCount>>
|
|
export type UsersCountError = ResponseError
|
|
|
|
/** [Joshen] Be wary of using this as it could potentially cause a huge load on the user's DB */
|
|
export const useUsersCountQuery = <TData = UsersCountData>(
|
|
{
|
|
projectRef,
|
|
connectionString,
|
|
keywords,
|
|
filter,
|
|
providers,
|
|
forceExactCount,
|
|
column,
|
|
}: UsersCountVariables,
|
|
{ enabled = true, ...options }: UseCustomQueryOptions<UsersCountData, UsersCountError, TData> = {}
|
|
) =>
|
|
useQuery<UsersCountData, UsersCountError, TData>({
|
|
queryKey: authKeys.usersCount(projectRef, {
|
|
keywords,
|
|
filter,
|
|
providers,
|
|
forceExactCount,
|
|
column,
|
|
}),
|
|
queryFn: ({ signal }) =>
|
|
getUsersCount(
|
|
{
|
|
projectRef,
|
|
connectionString,
|
|
keywords,
|
|
filter,
|
|
providers,
|
|
forceExactCount,
|
|
column,
|
|
},
|
|
signal
|
|
),
|
|
enabled: enabled && typeof projectRef !== 'undefined',
|
|
...options,
|
|
})
|