Dataform tools - a vscode extension

⚠️ This is not an officially supported Google product.

VS Code extension for Dataform with following features

Requirements

1. Dataform cli

   npm i -g @dataform/cli

   Run dataform compile from the root of your Dataform project to ensure that you are able to use the cli

2. Install gcloud cli and run

   gcloud init
   

   gcloud auth application-default login
   

    gcloud config set project <project_id> #replace with your gcp project id
   

3. To enable formatting using sqlfluff install sqlfluff

   # install python and run
   pip install sqlfluff
   

4. To enable prettier diagnostics install Error Lens extension [ optional ]

[!NOTE] Trouble installing ? Please see FAQ section, if you are still stuck, please raise an issue here

Features

Compiled query & Dry run stats

Dependency graph

Inline diagnostics errors on .sqlx files ❗

Preview query results

Go to definition

Go to definition for source in $ref{("my_source")}. Takes you to my_source.sqlx or sources.js at the line where my_source is defined. There is also support for go to definiton from a javascript variable/module from a .sqlx file to js block or .js file where the virable or module declaration exsists

Autocomplete model, tags, dependencies

Auto completion support for dependencies when " or ' is typed inside the config block which has dependencies keyword is in the line prefix

Declarations in ${ref("..")} trigger when $ character is typed

Auto completion support for tags when " or ' is typed inside the config block which has tags keyword is in the line prefix

Formatting using sqlfluff

Run file/tag with dependencies/dependents

Open vscode command pallet by pressing CTLR + SHIFT + p or CMD + SHIFT + p on mac and run one of the required commands

Known Issues

• [ ] Features such as go to definition / dependancy graph might not work with consistantly with ${ref("dataset", "table")} or when it is multiline or a different format works best with ${ref('table_name')} format

TODO

• [ ] Handle case where user is not connected to internet or on vpn where network request for dry run cannot be made