How bruin-data/bruin-vscode works
Bruin is a VS Code extension for developing and operating Bruin data products. Users manage assets and connections, run or validate work, and inspect results through extension panels and webviews; the README also documents lineage, database browsing, query preview, table diff, run history, and configuration autocomplete. The sampled query path runs from the preview panel through query commands to Bruin CLI output handling. Several feature modules are unsampled, so their documented capabilities are shown without speculative internal call chains.
Main entry points: extension.ts Extension Activation · BruinPanel.ts Asset Details · QueryPreviewPanel.ts Query Preview · DacPreviewPanel.ts Dashboard Preview
Components 31
VS Code Extension
- Extension Activation
src/extension/extension.ts - Extension Settings
src/extension/configuration.ts - Connections
src/extension/commands/manageConnections.ts - Database Explorer
src/providers/ActivityBarConnectionsProvider.ts - Config Completion
src/language-server/bruinLanguageServer.ts - Webview Nonce
src/utilities/getNonce.ts - Webview URI
src/utilities/getUri.ts
Asset Workflow
- Asset Details
src/panels/BruinPanel.ts - Asset Webview
webview-ui/src/App.vue - Asset Parsing
src/extension/commands/parseAssetCommand.ts - Run and Validate
src/bruin/bruinCommand.ts - Asset Utilities
src/utilities/helperUtils.ts - Materialization Editor
webview-ui/src/components/asset/materialization/Materialization.vue
Data Insights
- Asset Lineage
src/panels/LineagePanel.ts - Lineage Visualization
webview-ui/src/components/lineage-flow/pipeline-lineage/pipelineLineageBuilder.ts - Query Preview
src/panels/QueryPreviewPanel.ts - Query Results UI
webview-ui/src/components/query-output/QueryPreview.vue - Table Diff
src/panels/TableDiffPanel.ts - Run History
src/panels/RunHistoryPanel.ts - Table Details
src/panels/TableDetailsPanel.ts - Dashboard Preview
src/panels/DacPreviewPanel.ts
CLI Runtime
- Query Commands
src/extension/commands/queryCommands.ts - Query Execution
src/bruin/queryOutput.ts - Result Export
src/bruin/exportQueryOutput.ts - Dashboard Server
src/bruin/dacServe.ts - Bruin CLI Access
src/bruin/bruinCommand.ts - CLI Discovery
src/providers/BruinExecutableService.ts - DAC Discovery
src/providers/DacExecutableService.ts - CLI Installation
src/bruin/bruinInstallCli.ts - DAC Installation
src/bruin/dacInstallCli.ts
Other components
- Data Engineer
Connections 36
- Data Engineer → Extension Activation: uses in VS Code
README.md - Extension Activation → Asset Lineage: registers
src/extension/extension.ts - Extension Activation → Query Preview: registers
src/extension/extension.ts - Extension Activation → Table Diff: registers
src/extension/extension.ts - Extension Activation → Run History: registers
src/extension/extension.ts - Extension Activation → Dashboard Preview: registers
src/extension/extension.ts - Data Engineer → Asset Details: views and edits
README.md - Asset Details → Asset Webview: presents details
- Data Engineer → Connections: manages connections
README.md - Data Engineer → Database Explorer: browses tables
README.md - Data Engineer → Config Completion: gets completions
README.md - Data Engineer → Asset Lineage: explores lineage
README.md - Asset Lineage → Lineage Visualization: renders lineage
- Data Engineer → Query Preview: previews queries
README.md - Query Preview → Query Commands: requests output
src/panels/QueryPreviewPanel.ts - Query Commands → Query Execution: runs query
src/extension/commands/queryCommands.ts - Query Commands → Result Export: exports results
src/extension/commands/queryCommands.ts - Query Execution → Bruin CLI Access: executes command
src/bruin/queryOutput.ts - Query Commands → CLI Discovery: gets executable
src/extension/commands/queryCommands.ts - Data Engineer → Table Diff: compares tables
README.md - Data Engineer → Run History: reviews runs
README.md - Data Engineer → Table Details: opens metadata
README.md - Data Engineer → Dashboard Preview: previews dashboards
README.md - Dashboard Preview → Dashboard Server: starts preview
src/panels/DacPreviewPanel.ts - Dashboard Preview → DAC Discovery: checks version
src/panels/DacPreviewPanel.ts - Dashboard Preview → DAC Installation: installs if needed
src/panels/DacPreviewPanel.ts - Dashboard Server → DAC Discovery: resolves executable
src/bruin/dacServe.ts - Dashboard Server → CLI Discovery: resolves CLI
src/bruin/dacServe.ts - Data Engineer → Run and Validate: runs or validates
README.md - Asset Details → Asset Parsing: requests parsing
src/panels/BruinPanel.ts - Asset Details → CLI Installation: offers installation
src/panels/BruinPanel.ts - Asset Details → Asset Utilities: uses utilities
src/panels/BruinPanel.ts - Query Preview → Webview Nonce: builds webview
src/panels/QueryPreviewPanel.ts - Query Preview → Webview URI: builds webview
src/panels/QueryPreviewPanel.ts - Extension Settings → Query Execution: provides timeout
src/bruin/queryOutput.ts - Asset Webview → Materialization Editor: includes editor
webview-ui/src/App.vue