mirror of
https://github.com/supabase/supabase.git
synced 2026-10-11 04:15:04 +03:00
* added table advisor query * updated to include table editor performance * updated JSON B * added side panel * updated query indexes to show highlights context * show index advisor in table editor * updated invalidation logic * added color updates * added query indexes * updated query performance type * updated overflow and title * put behind flag * remove gap * added on close * Update apps/studio/data/database/table-index-advisor-query.ts Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> * updated styling --------- Co-authored-by: Charis <26616127+charislam@users.noreply.github.com>
145 lines
4.7 KiB
TypeScript
145 lines
4.7 KiB
TypeScript
import { useQueryClient } from '@tanstack/react-query'
|
|
import { createContext, useContext, PropsWithChildren, useState, useCallback } from 'react'
|
|
|
|
import { QueryIndexes } from 'components/interfaces/QueryPerformance/QueryIndexes'
|
|
import { useIndexAdvisorStatus } from 'components/interfaces/QueryPerformance/hooks/useIsIndexAdvisorStatus'
|
|
import { databaseKeys } from 'data/database/keys'
|
|
import {
|
|
useTableIndexAdvisorQuery,
|
|
TableIndexAdvisorData,
|
|
IndexAdvisorSuggestion,
|
|
} from 'data/database/table-index-advisor-query'
|
|
import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
|
|
import { Sheet, SheetContent, SheetHeader, SheetTitle } from 'ui'
|
|
|
|
interface TableIndexAdvisorContextValue {
|
|
isLoading: boolean
|
|
isAvailable: boolean
|
|
isEnabled: boolean
|
|
columnsWithSuggestions: string[]
|
|
suggestions: TableIndexAdvisorData['suggestions']
|
|
openSheet: (columnName: string) => void
|
|
getSuggestionsForColumn: (columnName: string) => IndexAdvisorSuggestion[]
|
|
invalidate: () => Promise<void>
|
|
}
|
|
|
|
const TableIndexAdvisorContext = createContext<TableIndexAdvisorContextValue>({
|
|
isLoading: false,
|
|
isAvailable: false,
|
|
isEnabled: false,
|
|
columnsWithSuggestions: [],
|
|
suggestions: [],
|
|
openSheet: () => {},
|
|
getSuggestionsForColumn: () => [],
|
|
invalidate: async () => {},
|
|
})
|
|
|
|
interface TableIndexAdvisorProviderProps {
|
|
schema: string
|
|
table: string
|
|
}
|
|
|
|
export function TableIndexAdvisorProvider({
|
|
children,
|
|
schema,
|
|
table,
|
|
}: PropsWithChildren<TableIndexAdvisorProviderProps>) {
|
|
const { data: project } = useSelectedProjectQuery()
|
|
const { isIndexAdvisorAvailable, isIndexAdvisorEnabled } = useIndexAdvisorStatus()
|
|
const queryClient = useQueryClient()
|
|
const [isSheetOpen, setIsSheetOpen] = useState(false)
|
|
const [selectedColumn, setSelectedColumn] = useState<string | undefined>(undefined)
|
|
|
|
const { data, isLoading } = useTableIndexAdvisorQuery(
|
|
{
|
|
projectRef: project?.ref,
|
|
connectionString: project?.connectionString,
|
|
schema,
|
|
table,
|
|
},
|
|
{
|
|
enabled: isIndexAdvisorEnabled && !!schema && !!table,
|
|
}
|
|
)
|
|
|
|
const openSheet = useCallback((columnName: string) => {
|
|
setSelectedColumn(columnName)
|
|
setIsSheetOpen(true)
|
|
}, [])
|
|
|
|
const closeSheet = useCallback(() => {
|
|
setIsSheetOpen(false)
|
|
setSelectedColumn(undefined)
|
|
}, [])
|
|
|
|
const getSuggestionsForColumn = useCallback(
|
|
(columnName: string): IndexAdvisorSuggestion[] => {
|
|
if (!data?.suggestions) return []
|
|
// Filter suggestions that include this column in their index statements
|
|
return data.suggestions.filter((suggestion) =>
|
|
suggestion.index_statements.some((stmt) => {
|
|
const match = stmt.match(/USING\s+\w+\s*\(([^)]+)\)/i)
|
|
if (match) {
|
|
const columns = match[1].split(',').map((c) => c.trim().replace(/^"(.+)"$/, '$1'))
|
|
return columns.includes(columnName)
|
|
}
|
|
return false
|
|
})
|
|
)
|
|
},
|
|
[data?.suggestions]
|
|
)
|
|
|
|
const invalidate = useCallback(async () => {
|
|
if (project?.ref && schema && table) {
|
|
await queryClient.invalidateQueries({
|
|
queryKey: databaseKeys.tableIndexAdvisor(project.ref, schema, table),
|
|
})
|
|
}
|
|
}, [queryClient, project?.ref, schema, table])
|
|
|
|
// Get the first suggestion for the selected column to pass to QueryIndexes
|
|
const selectedSuggestion = selectedColumn ? getSuggestionsForColumn(selectedColumn)[0] : null
|
|
|
|
const value: TableIndexAdvisorContextValue = {
|
|
isLoading,
|
|
isAvailable: isIndexAdvisorAvailable,
|
|
isEnabled: isIndexAdvisorEnabled,
|
|
columnsWithSuggestions: data?.columnsWithSuggestions ?? [],
|
|
suggestions: data?.suggestions ?? [],
|
|
openSheet,
|
|
getSuggestionsForColumn,
|
|
invalidate,
|
|
}
|
|
|
|
return (
|
|
<TableIndexAdvisorContext.Provider value={value}>
|
|
{children}
|
|
<Sheet open={isSheetOpen} onOpenChange={(open) => !open && closeSheet()}>
|
|
<SheetContent className="flex flex-col gap-0 p-0 sm:max-w-[500px]">
|
|
<SheetHeader className="border-b px-5 py-3">
|
|
<SheetTitle>Index Recommendation</SheetTitle>
|
|
</SheetHeader>
|
|
{selectedSuggestion && (
|
|
<QueryIndexes
|
|
selectedRow={{ query: selectedSuggestion.query }}
|
|
columnName={selectedColumn}
|
|
suggestedSelectQuery={selectedSuggestion.query}
|
|
onClose={closeSheet}
|
|
/>
|
|
)}
|
|
</SheetContent>
|
|
</Sheet>
|
|
</TableIndexAdvisorContext.Provider>
|
|
)
|
|
}
|
|
|
|
export function useTableIndexAdvisor() {
|
|
return useContext(TableIndexAdvisorContext)
|
|
}
|
|
|
|
export function useColumnHasIndexSuggestion(columnName: string): boolean {
|
|
const { columnsWithSuggestions } = useTableIndexAdvisor()
|
|
return columnsWithSuggestions.includes(columnName)
|
|
}
|