Interactive Apache Flink SQL development environment for VS Code. Write and execute Flink SQL queries in notebooks, explore cluster metadata (catalogs, databases, tables), monitor running jobs and cluster status, and manage your Flink cluster—all within your editor.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Apache Flink SQL Notebook transforms VS Code into a first-class Interactive Development Environment (IDE) for Apache Flink. Write SQL, stream results in real-time, explore cluster metadata, and manage jobs—all without leaving your editor.
✨ Key Enhancements
Recent updates allow you to do more with your data:
📊 Advanced Visualization: Client-side Sorting and Filtering on query results, plus CSV/JSON Export.
🧠 Intelligent Completion: Context-aware Column Auto-Completion that understands table aliases and joins.
⚡ Productivity Snippets: Built-in templates for Kafka tables, Window TVFs, and DataGen.
🛠️ Interactive Explorer: Click to Script SELECT queries or Copy DDL statements instantly.
🚀 Features
📓 Interactive Notebooks
.flinksql Support: Create notebook files to organize your queries.
Streaming Results: Run queries and watch results stream in real-time.
Pause & Resume: Control the flow of streaming data.
Result Grid:
Sort: Click headers to sort by column.
Filter: Type to filter rows instantly.
Export: Download results as CSV or copy as JSON.
🔍 Cluster Explorer
Navigate your Flink ecosystem from the sidebar:
Metadata Browser: Drill down into Catalogs, Databases, and Tables.
Quick Actions:
Right-click or use the Details View to interact with objects.
Script SELECT: Inserts a SELECT * ... LIMIT 100 snippet.
Copy DDL: Copies the CREATE TABLE statement to your clipboard.
🛡️ System Monitoring
Running Jobs: View active jobs, their status, and duration.
Job History: Access past job executions.
One-Click Cancel: Stop running jobs directly from the sidebar.
Task Manager Details: Monitor cluster health, slots, and resource usage.
⚡ Developer Experience
Auto-Completion:
Keywords, Functions, Catalogs, Databases, Tables.
Smart Column Suggestions: Detects tables in FROM/JOIN clauses (including aliases like t.col) to suggest relevant columns.