SDF Analyzer VSCode Extension

The SDF Analyzer is a powerful Visual Studio Code extension designed for developers working with SQL Warehouses defined within the context of an SDF workspace. This extension provides advanced features such as syntax highlighting, go-to definition support, and on-hover context tips that enhance productivity and understanding of SQL warehouse schematics and semantics.

Features

Syntax Highlighting

SDF Analyzer automatically detects .sdf.yml and .sql files and applies custom syntax highlighting to improve the readability of SQL schemas and queries. It distinguishes between SQL keywords, table names, variable declarations, and comments, making it easier to navigate complex SQL files.

Go-to Definition

With the go-to definition feature, users can navigate SQL warehouse queries more efficiently. Simply click on a table name, variable, column, function etc. and the SDF Analyzer will take you to its definition in the appropriate .sql or .sdf.yml file. This is particularly useful in large projects with multiple schema definitions.

On-hover Context Tips

The on-hover feature provides contextual information about SQL elements such as tables, columns, and functions directly within the editor. By hovering over any SQL element, users receive a tooltip containing details like column data types, default values, and brief descriptions extracted from the SDF workspace.

Language Support

SDF Analyzer offers comprehensive language support tailored to SQL and extended properties defined within SDF workspaces. This includes understanding complex SQL constructs and proprietary SQL extensions specific to different SQL warehouses like Redshift, Snowflake, and BigQuery.

Installation

To install the SDF Analyzer extension:

1. Open Visual Studio Code.
2. Navigate to the Extensions view by clicking on the square icon on the sidebar, or by pressing Ctrl+Shift+X.
3. Search for "SDF Analyzer".
4. Click on Install.

Configuration

After installation, you may want to configure the extension to better fit your development environment:

1. Open the Command Palette (Ctrl+Shift+P).
2. Type Preferences: Open Settings (JSON).
3. Add or modify the following settings to configure SDF Analyzer:

{
  "sdfAnalyzer.MaxErrorReporting": 100,
  "sdfAnalyzer.trace.server": "verbose"
}

Usage

Once installed and configured, the SDF Analyzer automatically activates when you open any .sdf.yml or .sql files. You can start benefiting from advanced syntax highlighting, go-to definition navigation, and informative on-hover tips immediately.

Support

For assistance with the SDF Analyzer, you can access our support forums or contact us directly through the GitHub issues page linked above. We welcome feedback and contributions to improve the extension.

Thank you for choosing SDF Analyzer to enhance your SQL warehouse development workflow!