The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
fix(studio): reliable schema-aware SQL editor AI completions (#44730)
Matt Rossman8f69a10cc91f
diff --git a/apps/studio/components/interfaces/SQLEditor/MonacoEditor.tsx b/apps/studio/components/interfaces/SQLEditor/MonacoEditor.tsxindex 88efe3f9dfd..1bf80d8aba1 100644--- a/apps/studio/components/interfaces/SQLEditor/MonacoEditor.tsx+++ b/apps/studio/components/interfaces/SQLEditor/MonacoEditor.tsx@@ -9,6 +9,7 @@ import { Admonition } from 'ui-patterns'import type { IStandaloneCodeEditor } from './SQLEditor.types'import { createSqlSnippetSkeletonV2 } from './SQLEditor.utils'import { SIDEBAR_KEYS } from '@/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'+import { getEditorSelectionParts } from '@/components/ui/AIEditor/utils'import { useLocalStorageQuery } from '@/hooks/misc/useLocalStorage'import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'import { useProfile } from '@/lib/profile'@@ -148,26 +149,8 @@ const MonacoEditor = ({label: 'Generate SQL',keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.KeyK],run: () => {- const selection = editor.getSelection()- const model = editor.getModel()- if (!model || !selection) return-- const allLines = model.getLinesContent()-- const startLineIndex = selection.startLineNumber - 1- const endLineIndex = selection.endLineNumber-- const beforeSelection = allLines.slice(0, startLineIndex).join('\n') + '\n'- const selectedText = allLines.slice(startLineIndex, endLineIndex).join('\n')- const afterSelection = '\n' + allLines.slice(endLineIndex).join('\n')-- onPrompt({- selection: selectedText,- beforeSelection,- afterSelection,- startLineNumber: selection?.startLineNumber ?? 0,- endLineNumber: selection?.endLineNumber ?? 0,- })+ const selectionParts = getEditorSelectionParts(editor)+ if (selectionParts) onPrompt(selectionParts)},})}diff --git a/apps/studio/components/ui/AIEditor/index.tsx b/apps/studio/components/ui/AIEditor/index.tsxindex 25dd55022a2..56c78aade40 100644--- a/apps/studio/components/ui/AIEditor/index.tsx+++ b/apps/studio/components/ui/AIEditor/index.tsx@@ -7,6 +7,7 @@ import { KeyboardShortcut } from 'ui'import { DiffEditor } from '../DiffEditor'import ResizableAIWidget from './ResizableAIWidget'+import { getEditorSelectionParts } from './utils'import { SIDEBAR_KEYS } from '@/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'import { constructHeaders } from '@/data/fetchers'import { useSidebarManagerSnapshot } from '@/state/sidebar-manager-state'@@ -21,6 +22,7 @@ interface AIEditorProps {projectRef?: stringconnectionString?: string | nullorgSlug?: string+ language?: string}initialPrompt?: stringreadOnly?: boolean@@ -251,26 +253,9 @@ export const AIEditor = ({label: 'Generate with AI',keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.KeyK],run: () => {- const selection = editor.getSelection()- const model = editor.getModel()- if (!model || !selection) return-- const allLines = model.getLinesContent()- const startLineIndex = selection.startLineNumber - 1- const endLineIndex = selection.endLineNumber-- const beforeSelection = allLines.slice(0, startLineIndex).join('\n') + '\n'- const selectedText = allLines.slice(startLineIndex, endLineIndex).join('\n')- const afterSelection = '\n' + allLines.slice(endLineIndex).join('\n')-- setPromptState({- isOpen: true,- selection: selectedText,- beforeSelection,- afterSelection,- startLineNumber: selection?.startLineNumber ?? 0,- endLineNumber: selection?.endLineNumber ?? 0,- })+ const selectionParts = getEditorSelectionParts(editor)+ if (!selectionParts) return+ setPromptState({ isOpen: true, ...selectionParts })},})diff --git a/apps/studio/components/ui/AIEditor/utils.ts b/apps/studio/components/ui/AIEditor/utils.tsnew file mode 100644index 00000000000..f9adbd67c29--- /dev/null+++ b/apps/studio/components/ui/AIEditor/utils.ts@@ -0,0 +1,47 @@+import type { editor as monacoEditor } from 'monaco-editor'++export type EditorSelection = {+ selection: string+ beforeSelection: string+ afterSelection: string+ startLineNumber: number+ endLineNumber: number+}++export function getEditorSelectionParts(+ editor: monacoEditor.IStandaloneCodeEditor+): EditorSelection | null {+ const selection = editor.getSelection()+ const model = editor.getModel()+ if (!model || !selection) return null++ const allLines = model.getLinesContent()++ const noSelection =+ selection.startLineNumber === selection.endLineNumber &&+ selection.startColumn === selection.endColumn++ if (noSelection) {+ return {+ selection: allLines.join('\n'),+ beforeSelection: '',+ afterSelection: '',+ startLineNumber: selection.startLineNumber,+ endLineNumber: selection.endLineNumber,+ }+ }++ const startLineIndex = selection.startLineNumber - 1+ const endLineIndex = selection.endLineNumber++ const beforeLines = allLines.slice(0, startLineIndex)+ const afterLines = allLines.slice(endLineIndex)++ return {+ selection: allLines.slice(startLineIndex, endLineIndex).join('\n'),+ beforeSelection: beforeLines.length > 0 ? beforeLines.join('\n') + '\n' : '',+ afterSelection: afterLines.length > 0 ? '\n' + afterLines.join('\n') : '',+ startLineNumber: selection.startLineNumber,+ endLineNumber: selection.endLineNumber,+ }+}diff --git a/apps/studio/components/ui/EditorPanel/EditorPanel.tsx b/apps/studio/components/ui/EditorPanel/EditorPanel.tsxindex 90d2a9c7bb2..5d6017f336c 100644--- a/apps/studio/components/ui/EditorPanel/EditorPanel.tsx+++ b/apps/studio/components/ui/EditorPanel/EditorPanel.tsx@@ -494,6 +494,7 @@ export const EditorPanel = () => {projectRef: project?.ref,connectionString: project?.connectionString,orgSlug: org?.slug,+ language: 'sql',}}initialPrompt={initialPrompt}options={{diff --git a/apps/studio/lib/ai/prompts.ts b/apps/studio/lib/ai/prompts.tsindex 8df426e80ad..e557751e298 100644--- a/apps/studio/lib/ai/prompts.ts+++ b/apps/studio/lib/ai/prompts.ts@@ -662,6 +662,18 @@ export const SECURITY_PROMPT = `- Never include links or images originating from \`execute_sql\` results`+export const COMPLETION_PROMPT = `+You are a code completion assistant for Supabase. You write and edit code based on a prompt.+Output only the raw code — no explanation, no markdown, no code fences.+Code context is provided with <selection> tags marking the user's active selection. Return only the replacement for the selected text. If no surrounding context exists, return the complete implementation. Do not duplicate existing code.+When no code context is provided: return a complete, valid implementation.+`++export const SQL_COMPLETION_INSTRUCTIONS = `+# SQL identifier quoting+Do not quote identifiers unless they actually require it (uppercase letters, reserved words, or special characters). Plain lowercase identifiers should not be quoted.+`+export const LIMITATIONS_PROMPT = `# Limitations- You are to only answer Supabase, database, or edge function related questions. All other questions should be declined with a polite message.diff --git a/apps/studio/pages/api/ai/code/complete.ts b/apps/studio/pages/api/ai/code/complete.tsindex bb88f35824b..c724c1b7208 100644--- a/apps/studio/pages/api/ai/code/complete.ts+++ b/apps/studio/pages/api/ai/code/complete.ts@@ -1,5 +1,5 @@-import pgMeta from '@supabase/pg-meta'-import { generateText, ModelMessage, stepCountIs } from 'ai'+import pgMeta, { getEntityDefinitionsSql } from '@supabase/pg-meta'+import { generateText, ModelMessage, stepCountIs, tool } from 'ai'import { IS_PLATFORM } from 'common'import { source } from 'common-tags'import { NextApiRequest, NextApiResponse } from 'next'@@ -11,60 +11,157 @@ import { getOrgAIDetails } from '@/lib/ai/ai-details'import { getModel } from '@/lib/ai/model'import { DEFAULT_COMPLETION_MODEL } from '@/lib/ai/model.utils'import {+ COMPLETION_PROMPT,EDGE_FUNCTION_PROMPT,- GENERAL_PROMPT,- OUTPUT_ONLY_PROMPT,PG_BEST_PRACTICES,- RLS_PROMPT,SECURITY_PROMPT,+ SQL_COMPLETION_INSTRUCTIONS,} from '@/lib/ai/prompts'-import { getTools } from '@/lib/ai/tools'import apiWrapper from '@/lib/api/apiWrapper'import { executeQuery } from '@/lib/api/self-hosted/query'export const maxDuration = 60-async function handler(req: NextApiRequest, res: NextApiResponse) {- if (req.method !== 'POST') {- return new Response(- JSON.stringify({ data: null, error: { message: `Method ${req.method} Not Allowed` } }),- {- status: 405,- headers: { 'Content-Type': 'application/json', Allow: 'POST' },- }+const pgMetaSchemasList = pgMeta.schemas.list()+type Schemas = z.infer<(typeof pgMetaSchemasList)['zod']>+type EntityDefinitionRow = { data: { definitions: Array<{ id: number; sql: string }> } }++type SqlFetchParams = {+ projectRef: string+ connectionString: string | null | undefined+ headers: Record<string, string>+}++type SchemaListResult =+ | { error: true }+ | { error: false; queriedSchemas: string[]; otherSchemas: string[] }++type SchemaDDLResult = { error: true } | { error: false; sqlDefinitions: string[] }++async function fetchSchemas(+ includeSchema: boolean,+ { projectRef, connectionString, headers }: SqlFetchParams+): Promise<{ schemas: Schemas; error: boolean }> {+ if (!includeSchema) return { schemas: [], error: false }+ try {+ const { result } = await executeSql<Schemas>(+ { projectRef, connectionString, sql: pgMetaSchemasList.sql },+ undefined,+ headers,+ IS_PLATFORM ? undefined : executeQuery)+ return { schemas: result, error: false }+ } catch {+ return { schemas: [], error: true }}+}+async function fetchSchemaDDL(+ schemas: string[],+ { projectRef, connectionString, headers }: SqlFetchParams+): Promise<SchemaDDLResult> {+ if (schemas.length === 0) return { error: false, sqlDefinitions: [] }try {- const { completionMetadata, projectRef, connectionString, orgSlug, language } = req.body- const { textBeforeCursor, textAfterCursor, prompt, selection } = completionMetadata-- if (!projectRef) {- return res.status(400).json({- error: 'Missing project_ref in request body',- })+ const { result } = await executeSql<EntityDefinitionRow[]>(+ { projectRef, connectionString, sql: getEntityDefinitionsSql({ schemas }) },+ undefined,+ headers,+ IS_PLATFORM ? undefined : executeQuery+ )+ const definitions = result?.[0]?.data?.definitions ?? []+ return {+ error: false,+ sqlDefinitions: definitions.map((d) => d.sql),}+ } catch {+ return { error: true }+ }+}- const authorization = req.headers.authorization- const accessToken = authorization?.replace('Bearer ', '')+function buildDatabaseSchemaSection({+ includeSchema,+ schemaListResult,+ schemaDDLResult,+}: {+ includeSchema: boolean+ schemaListResult: SchemaListResult+ schemaDDLResult: SchemaDDLResult+}): string {+ if (!includeSchema) {+ return 'Schema context is unavailable — data opt-in is not enabled for this project.'+ }+ const lines: string[] = []++ if (schemaListResult.error) {+ lines.push(+ "Unable to fetch list of available database schemas. Assume `public` schema, infer others from the user's existing code."+ )+ } else {+ lines.push(`Queried schemas: ${schemaListResult.queriedSchemas.join(', ')}`)+ if (schemaListResult.otherSchemas.length > 0)+ lines.push(+ `Other available schemas (use getSchemaDefinitions tool): ${schemaListResult.otherSchemas.join(', ')}`+ )+ }++ if (schemaDDLResult.error) {+ lines.push('Failed to fetch table definitions due to a database error.')+ } else {+ const defsText =+ schemaDDLResult.sqlDefinitions.length > 0+ ? schemaDDLResult.sqlDefinitions.join('\n\n')+ : 'No table definitions found.'+ lines.push(`\n${defsText}`)+ }- let aiOptInLevel: AiOptInLevel = 'disabled'+ return lines.join('\n')+}- if (!IS_PLATFORM) {- aiOptInLevel = 'schema'+const requestBodySchema = z.object({+ completionMetadata: z.object({+ textBeforeCursor: z.string(),+ textAfterCursor: z.string(),+ prompt: z.string(),+ selection: z.string(),+ }),+ projectRef: z.string(),+ connectionString: z.string().nullish(),+ orgSlug: z.string().optional(),+ language: z.string().optional(),+})++async function handler(req: NextApiRequest, res: NextApiResponse) {+ if (req.method !== 'POST') {+ return res.status(405).json({ error: `Method ${req.method} Not Allowed` })+ }++ try {+ let body: unknown+ try {+ body = typeof req.body === 'string' ? JSON.parse(req.body) : req.body+ } catch {+ return res.status(400).json({ error: 'Malformed JSON' })}+ const { data, error: parseError } = requestBodySchema.safeParse(body)++ if (parseError) {+ return res.status(400).json({ error: 'Invalid request body', issues: parseError.issues })+ }++ const { completionMetadata, projectRef, connectionString, orgSlug, language } = data+ const { textBeforeCursor, textAfterCursor, prompt, selection } = completionMetadata++ const authorization = req.headers.authorization+ let aiOptInLevel: AiOptInLevel = IS_PLATFORM ? 'disabled' : 'schema'if (IS_PLATFORM && orgSlug && authorization && projectRef) {- // Get organizations and compute opt in level server-sideconst { aiOptInLevel: orgAIOptInLevel } = await getOrgAIDetails({orgSlug,authorization,})-aiOptInLevel = orgAIOptInLevel}- // For code completion, we always use the limited modelconst {modelParams,error: modelError,@@ -78,41 +175,82 @@ async function handler(req: NextApiRequest, res: NextApiResponse) {return res.status(500).json({ error: modelError.message })}- // Get a list of all schemas to add to context- const pgMetaSchemasList = pgMeta.schemas.list()- type Schemas = z.infer<(typeof pgMetaSchemasList)['zod']>-- const { result: schemas } =- aiOptInLevel !== 'disabled'- ? await executeSql<Schemas>(- {- projectRef,- connectionString,- sql: pgMetaSchemasList.sql,- },- undefined,- {- 'Content-Type': 'application/json',- ...(authorization && { Authorization: authorization }),- },- IS_PLATFORM ? undefined : executeQuery- )- : { result: [] }-- const schemasString =- schemas?.length > 0- ? `The available database schema names are: ${JSON.stringify(schemas)}`- : "You don't have access to any schemas."+ const headers = {+ 'Content-Type': 'application/json',+ ...(authorization && { Authorization: authorization }),+ }++ const includeSchema = aiOptInLevel !== 'disabled'++ // Fetch schema list first so we can determine which schemas to load DDL for.+ // These are best-effort — if they fail, we proceed without DDL context.+ const { schemas, error: schemaListError } = await fetchSchemas(includeSchema, {+ projectRef,+ connectionString,+ headers,+ })++ // Always include public; also eagerly include any non-public schema whose name+ // appears as `name.` in the cursor context. Checking against the real schema list+ // avoids fetching DDL for table aliases or other false matches. This is robust to+ // incomplete SQL (the user may be mid-typing, so a full parser would fail here).+ const cursorContext = textBeforeCursor + selection + textAfterCursor+ const lowerContext = cursorContext.toLowerCase()+ const schemasToFetch = includeSchema+ ? [+ 'public',+ ...schemas+ .filter((s) => {+ const lower = s.name.toLowerCase()+ return (+ s.name !== 'public' &&+ (lowerContext.includes(lower + '.') || lowerContext.includes(`"${lower}".`))+ )+ })+ .map((s) => s.name),+ ]+ : []++ const schemaDDLResult = await fetchSchemaDDL(schemasToFetch, {+ projectRef,+ connectionString,+ headers,+ })++ // Reshape the fetched schemas and candidates into a discriminated union over error states+ const fetchedSchemaSet = new Set(schemasToFetch)+ const schemaListResult: SchemaListResult = schemaListError+ ? { error: true }+ : {+ error: false,+ queriedSchemas: schemasToFetch,+ otherSchemas: schemas.filter((s) => !fetchedSchemaSet.has(s.name)).map((s) => s.name),+ }// Important: do not use dynamic content in the system prompt or Bedrock will not cache itconst system = source`- ${GENERAL_PROMPT}- ${OUTPUT_ONLY_PROMPT}+ ${COMPLETION_PROMPT}+ ${language === 'sql' ? SQL_COMPLETION_INSTRUCTIONS : ''}${language === 'sql' ? PG_BEST_PRACTICES : EDGE_FUNCTION_PROMPT}- ${language === 'sql' && RLS_PROMPT}${SECURITY_PROMPT}`+ const userMessage = source`+ ## Database Schema++ ${buildDatabaseSchemaSection({ includeSchema, schemaListResult, schemaDDLResult })}++ ## Code++ \`\`\`${language ?? ''}+ ${textBeforeCursor}<selection>${selection}</selection>${textAfterCursor}+ \`\`\`++ ## Instruction++ ${prompt}+ `+// Note: these must be of type `CoreMessage` to prevent AI SDK from stripping `providerOptions`// https://github.com/vercel/ai/blob/81ef2511311e8af34d75e37fc8204a82e775e8c3/packages/ai/core/prompt/standardize-prompt.ts#L83-L88const coreMessages: ModelMessage[] = [@@ -122,51 +260,48 @@ async function handler(req: NextApiRequest, res: NextApiResponse) {...(promptProviderOptions && { providerOptions: promptProviderOptions }),},{- role: 'assistant',- // Add any dynamic context here- content: `- You are helping me edit some code.- Here is the context:- ${textBeforeCursor}<selection>${selection}</selection>${textAfterCursor}-- The available database schema names are: ${schemasString}-- Instructions:- 1. Only modify the selected text based on this prompt: ${prompt}- 2. Your response should be ONLY the modified selection text, nothing else. Remove selected text if needed.- 3. Do not wrap in code blocks or markdown- 4. You can respond with one word or multiple words- 5. Ensure the modified text flows naturally within the current line- 6. Avoid duplicating code when considering the full statement- 7. If there is no surrounding context (before or after), make sure your response is a complete valid SQL statement that can be run and resolves the prompt.-- Modify the selected text now:- `,+ role: 'user',+ content: userMessage,},]- // Get tools- const tools = await getTools({- projectRef,- connectionString,- authorization,- aiOptInLevel,- accessToken,- })-const { text } = await generateText({...modelParams,stopWhen: stepCountIs(5),messages: coreMessages,- tools,+ tools:+ includeSchema && !schemaListResult.error+ ? {+ getSchemaDefinitions: tool({+ description: 'Get table and column definitions for one or more schemas',+ inputSchema: z.object({+ schemas: z+ .array(z.string())+ .describe('The schema names to get the definitions for'),+ }),+ execute: async ({ schemas: maybeSchemas }) => {+ const validSchemas = maybeSchemas.filter((name) =>+ schemas.some((s) => s.name === name)+ )+ const result = await fetchSchemaDDL(validSchemas, {+ projectRef,+ connectionString,+ headers,+ })+ if (result.error)+ return 'Failed to fetch schema definitions due to a database error.'+ if (result.sqlDefinitions.length === 0) return 'No table definitions found.'+ return result.sqlDefinitions.join('\n\n')+ },+ }),+ }+ : undefined,})return res.status(200).json(text)} catch (error) {console.error('Completion error:', error)- return res.status(500).json({- error: 'Failed to generate completion',- })+ return res.status(500).json({ error: 'Failed to generate completion' })}}diff --git a/packages/pg-meta/src/sql/studio/database/table-definition.ts b/packages/pg-meta/src/sql/studio/database/table-definition.tsindex 78e47afe139..95a0477cd9f 100644--- a/packages/pg-meta/src/sql/studio/database/table-definition.ts+++ b/packages/pg-meta/src/sql/studio/database/table-definition.ts@@ -781,7 +781,7 @@ with records as ()or has_any_column_privilege(c.oid, 'SELECT, INSERT, UPDATE, REFERENCES'))- and nc.nspname IN (${schemas.map((schema) => `'${schema}'`).join(', ')})+ and nc.nspname IN (${schemas.map((schema) => `'${schema.replace(/'/g, "''")}'`).join(', ')})order by c.relname asclimit ${limit}offset 0