feat(extensions): Enhances SQL Lab API by michael-s-molina · Pull Request #37642 · apache/superset

michael-s-molina · 2026-02-03T18:10:38Z

Summary

This PR extends the SQL Lab API with new capabilities for tab management, query execution, and editor manipulation.

New APIs

Editor Access (now available via `Tab.getEditor()`)

Tab.getEditor() - Async method to get the editor handle
Editor.getValue() - Get the current SQL content
Editor.setValue(sql) - Replace the editor content
Editor.insertText(text) - Insert text at cursor position
Editor.focus() - Focus the editor
Editor.getCursorPosition() - Get current cursor position
Editor.getSelections() - Get current selections
Editor.setAnnotations(annotations) - Set error/warning markers
Editor.registerCompletionProvider(provider) - Register custom autocomplete

Tab Management

createTab(options?) - Create a new query editor tab with optional SQL, title, database, catalog, and schema
closeTab(tabId) - Close a specific tab
setActiveTab(tabId) - Switch to a specific tab
onDidCreateTab - Event fired when a new tab is created

Query Execution

executeQuery(options?) - Execute the SQL query in the current tab
cancelQuery(queryId) - Cancel a running query

Tab Context

setDatabase(databaseId) - Set the database for the current tab
setCatalog(catalog) - Set the catalog for the current tab
setSchema(schema) - Set the schema for the current tab
Tab.databaseId, Tab.catalog, Tab.schema - Direct access to tab context

API Changes

Tab Interface

// Before
interface Tab {
  id: string;
  title: string;
  editor: Editor;  // sync property with content, databaseId, catalog, schema
  panels: Panel[];
}

// After
interface Tab {
  id: string;
  title: string;
  databaseId: number;
  catalog: string | null;
  schema: string | null;
  getEditor(): Promise<Editor>;  // async method returning EditorHandle
  panels: Panel[];
}

Editor Interface

// Before
interface Editor {
  content: string;
  databaseId: number;
  catalog: string | null;
  schema: string;
  table: string | null;
}

// After - extends EditorHandle with full editor manipulation
interface Editor extends EditorHandle {
  // Inherited: getValue(), setValue(), insertText(), focus(),
  // getCursorPosition(), getSelections(), setAnnotations(), etc.
}

Migration Example

// Before
const tab = sqlLab.getCurrentTab();
const sql = tab.editor.content;
const dbId = tab.editor.databaseId;

// After
const tab = sqlLab.getCurrentTab();
const editor = await tab.getEditor();
const sql = editor.getValue();
const dbId = tab.databaseId;

Documentation

Improved JSDoc documentation for the Editor API in packages/superset-core/src/api/editors.ts:

EditorHandle - Comprehensive documentation for all methods including behavior details, edge cases, and parameter descriptions
Position, Range, Selection - Added examples and clarified zero-based indexing
EditorAnnotation - Added example and severity color explanations
EditorHotkey - Documented key combination format with example
CompletionProvider - Added example showing async table completion
executeCommand() - Noted that command names are editor-specific (Ace vs Monaco)

Test Plan

Create new tabs via createTab() with various options
Verify default tab naming "Untitled Query N"
Close and switch tabs via API
Execute and stop queries via API
Change database/catalog/schema via API
Access editor via getEditor() and manipulate content

ADDITIONAL INFORMATION

Has associated issue:
Required feature flags:
Changes UI
Includes DB Migration (follow approval process in SIP-59)
- Migration is atomic, supports rollback & is backwards-compatible
- Confirm DB migration upgrade and downgrade tested
- Runtime estimates and downtime expectations provided
Introduces new feature or API
Removes existing feature or API

superset-frontend/packages/superset-core/src/api/sqlLab.ts

superset-frontend/src/core/sqlLab/index.ts

superset-frontend/src/core/utils.ts

netlify · 2026-02-03T18:16:21Z

✅ Deploy Preview for superset-docs-preview ready!

Name	Link
🔨 Latest commit	`bbc5ccd`
🔍 Latest deploy log	https://app.netlify.com/projects/superset-docs-preview/deploys/69823a220b7e3a00080062e7
😎 Deploy Preview	https://deploy-preview-37642--superset-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

bito-code-review

Code Review Agent Run #07fa32

Actionable Suggestions - 5

superset-frontend/packages/superset-core/src/api/sqlLab.ts - 2
- Outdated API example in comment · Line 268-269
- Outdated API example in comment · Line 334-334
superset-frontend/src/core/sqlLab/index.ts - 2
- Incorrect state inheritance · Line 526-531
- Incorrect API return value · Line 607-607
superset-frontend/packages/superset-core/src/api/editors.ts - 1
- Incorrect zero-based indexing in JSDoc example · Line 94-101

Additional Suggestions - 1

superset-frontend/src/SqlLab/components/EditorWrapper/index.tsx - 1
- Missing handle re-registration · Line 257-279
  
  If queryEditorId changes after the editor is ready, the handle isn't re-registered under the new ID, potentially breaking SQL Lab API access. The added useEffect ensures re-registration.
  Code suggestion
  @@ -278,1 +278,6 @@ - + // Re-register editor handle when queryEditorId changes + useEffect(() => { + if (editorHandleRef.current) { + registerEditorHandle(queryEditorId, editorHandleRef.current); + } + }, [queryEditorId]); +

Review Details

Files reviewed - 6 · Commit Range: bbc5ccd..bbc5ccd
- superset-frontend/packages/superset-core/src/api/editors.ts
- superset-frontend/packages/superset-core/src/api/sqlLab.ts
- superset-frontend/src/SqlLab/components/EditorWrapper/index.tsx
- superset-frontend/src/core/sqlLab/index.ts
- superset-frontend/src/core/sqlLab/models.ts
- superset-frontend/src/core/utils.ts
Files skipped - 0
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

/review - Manually triggers a full AI review.
/pause - Pauses automatic reviews on this pull request.
/resume - Resumes automatic reviews.
/resolve - Marks all Bito-posted review comments as resolved.
/abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at [email protected].

Documentation & Help

AI Code Review powered by

superset-frontend/packages/superset-core/src/api/sqlLab.ts

superset-frontend/src/core/sqlLab/index.ts

superset-frontend/packages/superset-core/src/api/editors.ts

bito-code-review · 2026-02-03T19:39:48Z

Code Review Agent Run #a6163f

Actionable Suggestions - 0

Review Details

Files reviewed - 6 · Commit Range: bbc5ccd..00ea913
- superset-frontend/packages/superset-core/src/api/editors.ts
- superset-frontend/packages/superset-core/src/api/sqlLab.ts
- superset-frontend/src/SqlLab/components/EditorWrapper/index.tsx
- superset-frontend/src/core/sqlLab/index.ts
- superset-frontend/src/core/sqlLab/models.ts
- superset-frontend/src/core/utils.ts
Files skipped - 0
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

/review - Manually triggers a full AI review.
/pause - Pauses automatic reviews on this pull request.
/resume - Resumes automatic reviews.
/resolve - Marks all Bito-posted review comments as resolved.
/abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at [email protected].

Documentation & Help

AI Code Review powered by

msyavuz

Looks good with a small nit! Curious to see how this changes your example editor implementations?

superset-frontend/src/core/sqlLab/index.ts

michael-s-molina · 2026-02-04T12:59:08Z

Curious to see how this changes your example editor implementations?

@msyavuz It does not change the editor implementations as the editor API didn't change. What changed was that the editor handle API is now available for extensions and built-in features.

superset-frontend/packages/superset-core/src/api/sqlLab.ts

superset-frontend/src/core/sqlLab/index.ts

msyavuz · 2026-02-04T13:52:09Z

@michael-s-molina Yeah, i am using your extensions repo as a documentation so i was curious to see how you would use the handle api

michael-s-molina · 2026-02-04T13:55:31Z

@michael-s-molina Yeah, i am using your extensions repo as a documentation so i was curious to see how you would use the handle api

Oh, got it! We'll need an extension idea that manipulates the editor 😉 The only one I have is the SQL Snippets which uses insertText from the handle API.

bito-code-review · 2026-02-04T13:59:50Z

Code Review Agent Run #dcffda

Actionable Suggestions - 0

Review Details

Files reviewed - 6 · Commit Range: 00ea913..fa54712
- superset-frontend/packages/superset-core/src/api/editors.ts
- superset-frontend/packages/superset-core/src/api/sqlLab.ts
- superset-frontend/src/SqlLab/components/EditorWrapper/index.tsx
- superset-frontend/src/core/sqlLab/index.ts
- superset-frontend/src/core/sqlLab/models.ts
- superset-frontend/src/core/utils.ts
Files skipped - 0
Tools
- Eslint (Linter) - ✔︎ Successful
- Whispers (Secret Scanner) - ✔︎ Successful
- Detect-secrets (Secret Scanner) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

/review - Manually triggers a full AI review.
/pause - Pauses automatic reviews on this pull request.
/resume - Resumes automatic reviews.
/resolve - Marks all Bito-posted review comments as resolved.
/abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at [email protected].

Documentation & Help

AI Code Review powered by

michael-s-molina · 2026-02-04T16:56:03Z

@msyavuz I updated my extensions to reflect the latest changes.

feat(extensions): Enhances SQL Lab API

bbc5ccd

michael-s-molina requested review from eschutho, geido, kgabryje, rusackas and villebro as code owners February 3, 2026 18:10

pull-request-size bot added the size/XXL label Feb 3, 2026

github-actions bot added the packages label Feb 3, 2026

michael-s-molina self-assigned this Feb 3, 2026

michael-s-molina added this to Superset Extensions Feb 3, 2026

github-project-automation bot moved this to To Do in Superset Extensions Feb 3, 2026

michael-s-molina moved this from To Do to In Review in Superset Extensions Feb 3, 2026

michael-s-molina requested review from justinpark and msyavuz February 3, 2026 18:11

dosubot bot added api Related to the REST API sqllab Namespace | Anything related to the SQL Lab labels Feb 3, 2026

codeant-ai-for-open-source bot reviewed Feb 3, 2026

View reviewed changes

bito-code-review bot reviewed Feb 3, 2026

View reviewed changes

Address AI comments

00ea913

github-actions bot removed the api Related to the REST API label Feb 3, 2026

msyavuz approved these changes Feb 4, 2026

View reviewed changes

superset-frontend/src/core/sqlLab/index.ts Outdated Show resolved Hide resolved

Improves query execution/cancelation

2f1fa0c

codeant-ai-for-open-source bot reviewed Feb 4, 2026

View reviewed changes

superset-frontend/packages/superset-core/src/api/sqlLab.ts Show resolved Hide resolved

superset-frontend/src/core/sqlLab/index.ts Show resolved Hide resolved

superset-frontend/src/core/sqlLab/index.ts Show resolved Hide resolved

Address Codeant comments

fa54712

villebro approved these changes Feb 4, 2026

View reviewed changes

michael-s-molina merged commit 9243832 into apache:master Feb 4, 2026
69 checks passed

github-project-automation bot moved this from In Review to Done in Superset Extensions Feb 4, 2026

Conversation

michael-s-molina commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

New APIs

Editor Access (now available via Tab.getEditor())

Tab Management

Query Execution

Tab Context

API Changes

Tab Interface

Editor Interface

Migration Example

Documentation

Test Plan

ADDITIONAL INFORMATION

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

netlify bot commented Feb 3, 2026

✅ Deploy Preview for superset-docs-preview ready!

Uh oh!

bito-code-review bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Code Review Agent Run #07fa32

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bito-code-review bot commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #a6163f

Uh oh!

msyavuz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

michael-s-molina commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

msyavuz commented Feb 4, 2026

Uh oh!

michael-s-molina commented Feb 4, 2026

Uh oh!

bito-code-review bot commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Agent Run #dcffda

Uh oh!

Uh oh!

michael-s-molina commented Feb 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

michael-s-molina commented Feb 3, 2026 •

edited

Loading

Editor Access (now available via `Tab.getEditor()`)

bito-code-review bot left a comment •

edited

Loading

bito-code-review bot commented Feb 3, 2026 •

edited

Loading

michael-s-molina commented Feb 4, 2026 •

edited

Loading

bito-code-review bot commented Feb 4, 2026 •

edited

Loading