sqlsift VS Code Extension

SQL static analysis extension powered by sqlsift. Validates SQL queries against schema definitions and shows diagnostics in real-time.

Checked files

• SQL files (sql language)
• dbt models: jinja-sql documents (set by the "dbt Power User" extension) and .sql files in the jinja language. Jinja is also masked in any SQL file inside a dbt project (a dbt_project.yml in one of its parent directories).
• TypeScript and JavaScript files: the SQL in tagged template literals whose tag is in embedded_sql_tags in sqlsift.toml (default ["sql"]). Files without such a template get no diagnostics. Turn this off with sqlsift.embeddedSql.enable.

Prerequisites

The platform builds on the Marketplace bundle the sqlsift-lsp language server, so nothing else is needed. A build without it (such as a .vsix packaged locally as below) uses sqlsift-lsp from your PATH, or the path in sqlsift.serverPath:

# From the repository root
cargo install --path crates/sqlsift-lsp

Installation

From .vsix file

# Build the .vsix package
cd editors/vscode
npm install
npm run compile
npx @vscode/vsce package --allow-missing-repository

# Install in VS Code
code --install-extension sqlsift-0.1.0.vsix

Development (Extension Development Host)

cd editors/vscode
npm install
npm run compile

Then open editors/vscode/ in VS Code and press F5.

Setup

Run sqlsift init in your project root to detect the schema, queries and dialect and write a sqlsift.toml (details), or create one by hand:

# Schema file paths (glob patterns supported)
schema = ["db/schema.sql"]

# Or specify a directory (recursively finds *.sql)
# schema_dir = "db/migrations"

# SQL dialect: "postgresql" (default), "mysql", "sqlite", or (alpha) "snowflake", "bigquery", "redshift", "databricks"
# dialect = "postgresql"

# Template literal tags checked as SQL in TypeScript / JavaScript files
# embedded_sql_tags = ["sql", "$queryRaw"]

# Disable specific rules
# disable = ["E0001"]

# Rule levels: "off", "warn" or "error" (by code or name)
# [rules]
# ambiguous-column = "warn"

Extension Settings

Uninstall

code --uninstall-extension sqlsift.sqlsift