Dataform Tools

Officially recommended VS Code extension for Dataform by Google[^1] ✨. Supports Dataform versions 2.9.x and 3.x in all major operating systems. Works in: VS Code, Cursor, Antigravity.

compilation

Installation

Install the extension from the marketplace.
Install Dataform cli
```
# requires nodejs & npm - https://nodejs.org/en/download
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.

Install gcloud cli and run

gcloud init
gcloud auth application-default login
gcloud config set project <project_id> #replace with your gcp project id

Install sqlfluff (optional, for formatting)

# install python and run
pip install sqlfluff

[!NOTE] Trouble installing or looking for a specific customization ? Please see FAQ section, if you are still stuck, please raise an issue here

️▶️ Installation on Windows
️▶️ Installation and demo on Ubuntu
️▶️ Dataform workspace run using API demo and technical details

✨ Features / Previews

Feature	Description
Compiled Query & Dry run stats	Compiled query with dry run stats in a vertical split, with the option to switch between backends for compilation (CLI or Dataform API)
Inline diagnostics on `.sqlx` file 🚨	Native LSP like experience with diagnostics being directly put on sqlx file
Dependancy graph	Interative dependancy graph with external sources higlighted in distinct colors
Preview query results	Preview query results in a table by running the file
Run changed actions	Run only the actions whose compiled SQL or materialization settings changed vs the merge-base with your default branch (set with `vscode-dataform-tools.defaultBranch`), like dbt's `state:modified`. Catches changes made through `includes/`, and shows what will run before running it
Column impact of branch changes	For every table the branch changes, the columns it drops or retypes against the table in BigQuery and who reads them, from Dataplex lineage, as a report you can paste into a pull request. It compares with the tables compiled with `vscode-dataform-tools.prodCompilerOptions`; if your project's defaults (e.g. `defaultProject` in `workflow_settings.yaml`) point at dev, set it, e.g. `--default-database=my-prod-project`, or the report compares with your dev tables
BigQuery hover provider	Hover definition for tables, columns, column descriptions, types and common BigQuery functions
Cost estimator	Estimate the cost of running a Tag
Go to definition	Go to definition for source in `$ref{("my_source")}` and javascript blocks in `.sqlx` files
Auto-completion	Column names of current model Dependencies and declarations in `${ref("..")}` trigger when `$` character is typed Dependencies when `"` or `'` is typed inside the config block which has `dependencies` keyword is in the line prefix `tags` when `"` or `'` is typed inside the config block which has `tags` keyword is in the line prefix
Code actions	Apply dry run suggestions at the speed of thought
Config block IntelliSense	Completion, hover docs and as-you-type warnings with quick fixes for `config {}` options, based on the action `type`. Catches typos like `partitonBy` and options that don't apply, like `uniqueKey` on a view
Run file(s)/tag(s)	Run file(s)/tag(s), optionally with dependencies/dependents/full refresh using cli or Dataform API
Format using Sqlfluff 🪄	Format `.sqlx` files using sqlfluff
BigQuery snippets	Code snippets for generic BigQuery functions taken from vscode-language-sql-bigquery extension
Tests	Support to view and run tests. Running test is currently only supported via Dataform CLI.
Dependency Inspector	Inspect model dependencies, apply filters and run dry runs/queries

Inline diagnostics errors on `.sqlx` files

diagnostics

BigQuery hover definition provider

Hover over tables, columns, column types and BigQuery functions to see their documentation, syntax, and examples making it easier to understand and use them correctly without leaving your editor.

table_hover

Estimate cost of running a Tag

cost_estimator

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

go-to-definition

Autocomplete model, tags, dependencies

Auto completion of declarations in ${ref("..")} trigger when $ character is typed and dependencies and tags in config block when " or ' is typed.

auto-completion

Formatting using sqlfluff

formatting

Dependency Inspector

Interactive inspector to explore dependencies, apply a common filter across all nested dependencies and perform dry runs or run the queries in BigQuery.

dependency_inspector_one

dependency_inspector_two

Commands

Most features can be invoked via the Command Palette by pressing CTRL + SHIFT + P or CMD + SHIFT + P on Mac and searching for the following. These key bindings can also be attached to a keybinding to further streamline your workflow.

Command	Description
`vscode-dataform-tools.showCompiledQueryInWebView`	Show compiled Query in web view
`vscode-dataform-tools.runCurrentFile`	Run current file
`vscode-dataform-tools.runCurrentFileWtDeps`	Run current file with dependencies
`vscode-dataform-tools.runCurrentFileWtDownstreamDeps`	Run current file with dependents
`vscode-dataform-tools.runQuery`	Preview query results
`vscode-dataform-tools.runTag`	Run a tag
`vscode-dataform-tools.runTagWtDeps`	Run a tag with dependencies
`vscode-dataform-tools.runTagWtDownstreamDeps`	Run a tag with dependents
`vscode-dataform-tools.runFilesTagsWtOptions`	Run file(s) / tag(s) with options
`vscode-dataform-tools.runFilesTagsWtOptionsApi`	Run file(s) / tag(s) with options using API
`vscode-dataform-tools.runFilesTagsWtOptionsInRemoteWorkspace`	Run file(s) / tag(s) with options using API in remote workspace [beta]
`vscode-dataform-tools.dependencyGraphPanel`	Show dependency graph
`vscode-dataform-tools.runTagWtApi`	Run a tag using API
`vscode-dataform-tools.runTagWtDependenciesApi`	Run tag with dependencies using API
`vscode-dataform-tools.runCurrentFileWtApi`	Run current file using API
`vscode-dataform-tools.runCurrentFileWtDependenciesApi`	Run current file with dependencies using API
`vscode-dataform-tools.runCurrentFileWtDependentsApi`	Run current file with dependents using API
`vscode-dataform-tools.clearExtensionCache`	Clear extension cache
`vscode-dataform-tools.openLastWorkflowExecution`	Open last workflow execution in browser
`vscode-dataform-tools.rerunLastExecution`	Rerun last execution (same files/tags, options and mode as the previous run)
`vscode-dataform-tools.runChangedActions`	Run only the actions changed vs the default branch, after previewing them. In a keybinding, pass `"args": { "includeDependents": true, "fullRefresh": false }` (also `includeDependencies`) to skip the prompts
`vscode-dataform-tools.runChangedActionsApi`	Same as above, using the Dataform API

Products

Name	Registry	Description
Dataform Tools	VS Code marketplace	VS Code extension — dependency graph, compiled query preview, dry-run stats, inline diagnostics, go-to-definition, autocomplete, formatting, and more. Same build is published to both the VS Code marketplace and Open VSX (for forks such as Cursor and Antigravity).
Dataform Tools	Open VSX marketplace
`@ashishalex/dataform-graph`	npm	`dataform-graph` CLI — serves the dependency graph in your browser; no VS Code required (readme).
`@ashishalex/dataform-tools`	npm	Programmatic wrapper around the `@google-cloud/dataform` npm package.
`dataform-tools`	PyPI	Programmatic wrapper around the `google-cloud-dataform` Python package.

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

[^1]: Link to confirmation of official recommendation by Google:. Note that this is a community-led project and not an officially supported Google product.

Dataform tools

ashishalex