Skip to content

This is the repo for Bruin's Visual Studio Code extension.

License

Notifications You must be signed in to change notification settings

bruin-data/bruin-vscode

Repository files navigation

Bruin

Bruin is a unified analytics platform that enables data professionals to work end-to-end for their data pipelines. This extension is built to improve the development experience of data products on Bruin using Visual Studio Code.

🚀 Key Features

Assets Details viewer

  • Show and update asset details from the UI.
  • Renders SQL content within a VS Code Webview.
  • Copy SQL content with a single click.
  • Auto-refreshes when the file is updated.
  • Supports running and validating assets with options like --downstream and --full-refresh via checkboxes.
  • Date inputs for selecting start and end dates for the run command.

GIF of Asset Details Panel

Connections Management

  • Display and manage connections integrated with Bruin CLI.
  • Add, remove or duplicate connections directly from the UI.
  • Test exsiting connections to ensure their validity.

GIF of Connection Manager

Bruin Settings

  • The Settings tab in the side panel provides a straightforward way to install and update the Bruin CLI.
  • Access Bruin documentation or view system information with a single click. Screenshot of Settings Tab

Asset Lineage

  • View and interact with the lineage of assets.
  • Expand each node to see dependencies and easily access asset files.
  • Toggle visibility for upstream and downstream assets.

GIF of Lineage Panel

Query Preview Panel

  • Visualizes query execution results in a new panel.
  • Displays formatted output for easier analysis.
  • Supports multi-tab functionality to run different queries separately.

GIF of Lineage Panel

Autocomplete and Snippets

  • Autocomplete support for .bruin.yml, pipeline.yml, and *.asset.yml files with predefined options and schema validations.
  • Snippets for creating Bruin root configuration, pipelines, and assets.

Installation

  1. Open Visual Studio Code.
  2. Navigate to the Extensions view (Ctrl+Shift+X).
  3. Search for "Bruin" and click Install.

Note: Ensure that you have the Bruin CLI installed on your system before using the new features. For guidance on installing the Bruin CLI, please refer to the official documentation.

Release Notes

Latest Release: 0.39.4

  • Enable state persistence in Query Preview to retain query output when switching between VS Code panels.

Recent Updates

  • 0.39.3: Added environment display to the query preview panel, showing the selected environment from the side panel dropdown.
  • 0.39.2: Added expandable cells in Query Preview for long text, with copy support and ESC to close all expanded cells.
  • 0.39.1: Adjust column layout to set primary key as a separate column.
  • 0.39.0: Added primary_key to column data with support for composite primary keys.
  • 0.38.5: Update keybinding display for platforms and remove unused 'value' property in columns checks.
  • 0.38.4: Improved columns checks Dropdown positioning and run button UI on windows.
  • 0.38.3: Replaced markdown-preview auto-lock workaround with a custom preview to fix serialization errors and enable auto-refresh.
  • 0.38.2: Refactored command payload to handle undefined environment values.
  • 0.38.1: Added support for tab label editing via double-click and refactored query data loading to prevent automatic execution on mount.
  • 0.38.0: Added multi-tab support to the QueryPreview component, allowing users to manage multiple query results simultaneously.
  • 0.37.2: Resolved the visibility issue with icons in the Query Preview Panel.
  • 0.37.1: Fixed CustomChecks to correctly recognize 0 as a valid check value instead undefined.
  • 0.37.0: Added search functionality to the Query Preview Panel.
  • 0.36.0: Added support for executing selected queries in the Query Preview Panel. The selected queries should belong to a valid bruin asset.
  • 0.35.3: Optimize payload size for description and asset name updates and improve error handling.
  • 0.35.2: Adjust the styling of the save and cancel buttons in the description editing.
  • 0.35.1: Add loading state to the query preview.
  • 0.35.0: Introduce a new Query Preview Panel to display the output of SQL query execution. This feature currently uses the default environment with a maximum limit of 1000.
  • 0.34.1: Reset filter panel state on file change and improve graph viewport adjustments for expanded nodes.
  • 0.34.0: Add options panel to the lineage view with choices to display either all upstream & downstream dependencies or only direct dependencies.

For a full changelog, see Bruin Extension Changelog.

How to Update

To update to the latest version, search for "Bruin" in the Extensions Marketplace and click the Update button.

About

This is the repo for Bruin's Visual Studio Code extension.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published