dataform.nvim

Dataform Core Plugin for Neovim

⚠️ This is not an officially supported Google product.

🪄 Features

• Compile dataform project when open .sqlx file first time within neovim session or when write a sqlx file
• Compile dataform current model to sql script with bq cli validation (full load and incremental)
• Go to reference sqlx file when line has the ${ref()} pattern
• Run current dataform model (full or incremental)
• Run current dataform model assertions
• Run entire dataform project
• Run dataform specific tag
• Syntax highlighting for both sql and javascript blocks
• Search for dependencies and dependents for a specific model

📜 Requirements

• Dataform CLI to get stuff done
• nvim-notify for amazing notifications
• telescope.nvim for smart dependencies/dependents finder
• BigQuery CLI Tool to validate BigQuery sql script

🧪 Installation

Use your favorite plugin manager to install it. For example:

use {
  'magal1337/dataform.nvim',
  requires = {
    'rcarriga/nvim-notify',
    'nvim-telescope/telescope.nvim'
  },
}

🧙‍♂️ Usage

First time that you open a dataform project with a .sqlx file in neovim session, it will automatically compile the project. And also every time that you edit your .sqlx file, and hit :w it will recompile it again for you not worry to do it manually. 🔮

🌀 Commands

Command	Action	Arguments
:DataformCompileFull	Will compile your current file as a BigQuery SQL Script and it will evaluate it using bq CLI. The results will be presented in a new buffer.
:DataformCompileIncremental	Same thing as :DataformCompileFull but it will compile the Bigquery SQL Script with incremental option if your model is of type incremental.
:DataformGoToRef	It will open the source file of your reference but only if your cursor is in the same line of your ${ref()} expression.
:DataformRunAll	Will run your entire dataform project.
:DataformRunAction	Will run the current model in your opened .sqlx file.
:DataformRunActionIncremental	Same thing as :DataformRunAction but it will run the current model with incremental option if your model is of type incremental.
:DataformRunTag	Will run a specific tag that you specify.	A specific tag name like :DataformRunTag tag_name or a list of tags like :DataformRunTag tag_name1,tag_name2
:DataformRunAssertions	Will run the current model assertions.
:DataformFindDependencies	Will return a Telescope Finder with all dependencies for current model
:DataformFindDependents	Will return a Telescope Finder with all dependents for current model

🔮 It's recommended to use these commands encapsulated in some custom keymaps to make it more convenient. Choose what suits you best.

📖 Syntax Highlight

From a syntax perspective sqlx acts like a combination of sql and js and the aim of this project is to support both syntaxes in parody with how Dataform uses them, more precisely:

• The javascript supported by NodeJs
• The sql supported by BigQuery

✨ Still under development...

🏰 How to contribute

To know more on how to contribute please check our Contributing Guide

🙏 Thanks adventurer 🧙‍♀️

Like this Plugin? Star it on GitHub