Atlas HCL Extension for Visual Studio CodeThe Extension supports Auto Completion Schema, SQL Dialect, Referencing Qualified Tables, Linting. How to Use the PluginBy default, the plugin will recognize files with the name atlas.hcl. Follow this file naming convention to help the plugin recognize the correct dialect:
FeaturesAuto Completion Schema ResourcesThis refers to a feature that automatically suggests or completes the names of schema resources (e.g. tables, columns, etc.) as the user types, based on the database dialect being used. For a comprehensive list of the supported resources, please visit the following link: https://atlasgo.io/atlas-schema/sql-resources. Syntax HighlightingThis refers to a feature that highlights syntax in a file based on the HashiCorp Configuration Language (HCL) syntax Referencing Qualified tablesThis refers to a feature that allows for referencing tables and their columns in a structured manner, either relative to the current location (e.g. column.id) or absolute to the table (e.g. table.user.column.id). LintingThe tool provides linting capabilities, including duplicate resources/attributes, required attributes, and resource hierarchy validation. ConfigurationModule PathsConfigure paths to Atlas modules for cross-module references. This feature allows schema files to reference schema definitions outside their immediate directory scope. To configure module paths:
How it works:
This configuration is particularly useful in large projects with schema definitions split across multiple directories for better organization. SupportNeed help? File issues on the Atlas Issue Tracker or join our Discord server. |