mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
Removes the SQL Editor Pretty Explain feature — the Explain tab, the Run EXPLAIN ANALYZE action + shortcut, and its dead plumbing. It's been gated off behind the `DisablePrettyExplainOnSqlEditor` kill switch for weeks with no usage or complaints. `ExplainVisualizer` / `isExplainQuery` are kept — they're used independently by Query Insights, Query Performance, and the EditorPanel quick-runner. Manually-run `EXPLAIN` queries still render as raw rows in the Results tab. Typecheck, lint, and all affected unit tests pass. Closes FE-3930 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Changes** * Removed the SQL editor’s EXPLAIN execution workflow, including its toolbar action, keyboard shortcut, utility tab, and visual query-plan display. * Simplified query execution to focus on standard results and charts. * Improved result clearing when switching databases and refined execution error handling. * Updated SQL editor state and tests to reflect the streamlined experience. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
189 lines
5.5 KiB
TypeScript
189 lines
5.5 KiB
TypeScript
import {
|
|
Activity,
|
|
Database,
|
|
GitMerge,
|
|
Hash,
|
|
Layers,
|
|
ListFilter,
|
|
SortAsc,
|
|
Zap,
|
|
type LucideIcon,
|
|
} from 'lucide-react'
|
|
|
|
// Get human-readable description for an operation
|
|
export function getOperationDescription(operation: string): string {
|
|
const op = operation.toLowerCase()
|
|
|
|
if (op.includes('seq scan')) {
|
|
return 'Reads entire table row by row'
|
|
}
|
|
if (op.includes('index only scan')) {
|
|
return 'Reads data directly from index (fastest)'
|
|
}
|
|
if (op.includes('bitmap index scan')) {
|
|
return 'Builds bitmap of matching rows from index'
|
|
}
|
|
if (op.includes('bitmap heap scan')) {
|
|
return 'Fetches rows using bitmap'
|
|
}
|
|
if (op.includes('index scan')) {
|
|
return 'Uses index to find matching rows'
|
|
}
|
|
if (op.includes('hash left join')) {
|
|
return 'Returns all left rows with matching right rows via hash'
|
|
}
|
|
if (op.includes('hash right join')) {
|
|
return 'Returns all right rows with matching left rows via hash'
|
|
}
|
|
if (op.includes('hash full join')) {
|
|
return 'Returns all rows from both tables via hash'
|
|
}
|
|
if (op.includes('hash anti join')) {
|
|
return 'Returns rows without matches via hash'
|
|
}
|
|
if (op.includes('hash semi join')) {
|
|
return 'Returns rows with at least one match via hash'
|
|
}
|
|
if (op.includes('hash join')) {
|
|
return 'Joins tables using hash lookup'
|
|
}
|
|
if (op.includes('merge left join')) {
|
|
return 'Returns all left rows with matching right rows via merge'
|
|
}
|
|
if (op.includes('merge right join')) {
|
|
return 'Returns all right rows with matching left rows via merge'
|
|
}
|
|
if (op.includes('merge full join')) {
|
|
return 'Returns all rows from both tables via merge'
|
|
}
|
|
if (op.includes('merge anti join')) {
|
|
return 'Returns rows without matches via merge'
|
|
}
|
|
if (op.includes('merge semi join')) {
|
|
return 'Returns rows with at least one match via merge'
|
|
}
|
|
if (op.includes('merge join')) {
|
|
return 'Joins pre-sorted tables'
|
|
}
|
|
if (op.includes('nested loop left join')) {
|
|
return 'Returns all left rows with matching right rows via loop'
|
|
}
|
|
if (op.includes('nested loop anti join')) {
|
|
return 'Returns rows without matches via loop'
|
|
}
|
|
if (op.includes('nested loop semi join')) {
|
|
return 'Returns rows with at least one match via loop'
|
|
}
|
|
if (op.includes('nested loop')) {
|
|
return 'Joins by looping through each row'
|
|
}
|
|
if (op === 'hash') {
|
|
return 'Builds hash table for fast lookups'
|
|
}
|
|
if (op.includes('sort')) {
|
|
return 'Sorts rows for output or join'
|
|
}
|
|
if (op.includes('aggregate') || op.includes('group')) {
|
|
return 'Groups rows and calculates aggregates'
|
|
}
|
|
if (op.includes('limit')) {
|
|
return 'Returns only first N rows'
|
|
}
|
|
if (op.includes('materialize')) {
|
|
return 'Stores results in memory for reuse'
|
|
}
|
|
if (op.includes('gather')) {
|
|
return 'Collects results from parallel workers'
|
|
}
|
|
|
|
return ''
|
|
}
|
|
|
|
// Get an icon for the operation type
|
|
export function getOperationIcon(operation: string): LucideIcon {
|
|
const op = operation.toLowerCase()
|
|
if (op === 'hash') return Hash
|
|
if (op.includes('hash join')) return GitMerge
|
|
if (op.includes('merge join')) return GitMerge
|
|
if (op.includes('nested loop')) return GitMerge
|
|
if (op.includes('join')) return Layers
|
|
if (op.includes('index')) return Zap
|
|
if (op.includes('seq scan')) return Database
|
|
if (op.includes('scan')) return Database
|
|
if (op.includes('filter')) return ListFilter
|
|
if (op.includes('sort')) return SortAsc
|
|
if (op.includes('aggregate') || op.includes('group')) return Activity
|
|
return Database
|
|
}
|
|
|
|
// Get a color class for the operation type
|
|
export function getOperationColor(operation: string): string {
|
|
const op = operation.toLowerCase()
|
|
if (op.includes('seq scan')) return 'text-warning'
|
|
if (op.includes('index')) return 'text-brand'
|
|
if (op.includes('join')) return 'text-foreground-light'
|
|
if (op.includes('sort') || op.includes('aggregate')) return 'text-foreground-light'
|
|
return 'text-foreground-light'
|
|
}
|
|
|
|
export function isExplainQuery(rows: readonly unknown[]): boolean {
|
|
if (rows.length === 0) return false
|
|
const firstRow = rows[0]
|
|
if (typeof firstRow !== 'object' || firstRow === null) return false
|
|
return 'QUERY PLAN' in firstRow && Object.keys(firstRow).length === 1
|
|
}
|
|
|
|
export function formatNodeDuration(ms: number | undefined): string {
|
|
if (ms === undefined) return '-'
|
|
if (ms >= 1000) return `${(ms / 1000).toFixed(2)}s`
|
|
if (ms >= 1) return `${ms.toFixed(2)}ms`
|
|
if (ms >= 0.01) return `${ms.toFixed(2)}ms`
|
|
if (ms >= 0.001) return `${ms.toFixed(3)}ms`
|
|
|
|
const us = ms * 1000
|
|
if (us >= 0.1) return `${us.toFixed(1)}µs`
|
|
return `${us.toFixed(2)}µs`
|
|
}
|
|
|
|
export function getScanBarColor(operation: string): string {
|
|
const op = operation.toLowerCase()
|
|
|
|
// Index scans are green
|
|
if (
|
|
op.includes('index scan') ||
|
|
op.includes('index only scan') ||
|
|
op.includes('bitmap index scan')
|
|
) {
|
|
return 'bg-brand/20'
|
|
}
|
|
|
|
// Sequential scans are yellow
|
|
if (op.includes('seq scan') || op.includes('sequential scan')) {
|
|
return 'bg-warning/20'
|
|
}
|
|
|
|
// Default neutral color for other operations
|
|
return 'bg-foreground/6'
|
|
}
|
|
|
|
export function getScanBorderColor(operation: string): string {
|
|
const op = operation.toLowerCase()
|
|
|
|
// Index scans are green
|
|
if (
|
|
op.includes('index scan') ||
|
|
op.includes('index only scan') ||
|
|
op.includes('bitmap index scan')
|
|
) {
|
|
return 'border-l-brand'
|
|
}
|
|
|
|
// Sequential scans are yellow
|
|
if (op.includes('seq scan') || op.includes('sequential scan')) {
|
|
return 'border-l-warning'
|
|
}
|
|
|
|
// Default neutral color for other operations
|
|
return 'border-l-border-muted'
|
|
}
|