Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tinybirdco/vscode-tinybird-support
Tinybird support for Visual Studio Code
https://github.com/tinybirdco/vscode-tinybird-support
vscode vscode-extension
Last synced: 5 days ago
JSON representation
Tinybird support for Visual Studio Code
- Host: GitHub
- URL: https://github.com/tinybirdco/vscode-tinybird-support
- Owner: tinybirdco
- License: mit
- Created: 2022-06-09T07:46:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-09T11:02:36.000Z (about 1 year ago)
- Last Synced: 2024-08-03T12:15:51.581Z (4 months ago)
- Topics: vscode, vscode-extension
- Language: JavaScript
- Homepage:
- Size: 14.5 MB
- Stars: 19
- Watchers: 4
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Tinybird support for Visual Studio Code
This extension provides some helpers for your [Tinybird](https://tinybird.co) data projects:
## Syntax highlighting and autocomplete
Adds syntax highlighting for `.datasource`, `.pipe` and `.incl` files.
Also includes autocomplete for the full library of ClickHouse SQL functions.
## Navigate your Data Project
The Tinybird Sidebar lists all the resources within your data project, including Data Sources, Pipes, and Tokens.
## View your Data Flow
View the flow of data from Data Sources to Endpoints without switching back to the Tinybird UI. Simply open the Command Palette (`Cmd+Shift+P`), type `Tinybird CLI: Show Data Flow` and hit `Enter`. You can drag to navigate and zoom in/out with `Ctrl` and your scroll wheel/trackpad.
## Execute common Tinybird commands
Find and execute common Tinybird CLI commands from the Command Palette in VS Code. Use `Cmd+Shift+P` to open the Command Palette, type `Tinybird CLI` and find a list of available commands.
## Run SQL from within VS Code
Execute any SQL in your Tinybird workspace by selecting an SQL statement in the editor and pressing the default `Cmd+Enter` keybinding (alternatively, you can call the command from the command bar or set your preferred mapping).
You'll see the results in the `Tinybird SQL` output panel.
> Note: for this command to work you need to have your `tb` command properly configured. Please, [refer to our docs](https://www.tinybird.co/docs/quick-start-cli.html) for a quick start.
#### Configure the extension
For the Tinybird commands to work, you need to setup the following settings:
- `tinybird.dataProjectSubdir`: Where your data project is located in the active workspace.
- `tinybird.venv`: If you use a Python virtual env to work with Tinybird, put the venv name here.
- `tinybird.venvActivate`: The activation command for your virtual env (see setting `tinybird.venv`). Default is `bin/activate` but for some shells you might need another one (for example `bin/activate.fish` for the [fish shell](https://fishshell.com/)).
## New to Tinybird?
If you’re new to Tinybird and want to try it out, you can signup for free [here](https://www.tinybird.co/signup?referrer=vscode). The Build Plan doesn’t require a credit card and has no time limit.
If you have any questions or want new features in the VS Code Extension, please join our [Slack community](https://www.tinybird.co/community).