Skip to content

Commit 3e36c71

Browse files
benfdkingCopilot
andauthored
docs: updating vsccode with features (#4611)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 0bbbf9a commit 3e36c71

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

docs/guides/vscode.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,10 @@ The extension adds a lineage view to SQLMesh models. To view the lineage of a mo
9595

9696
![Lineage view](./vscode/lineage.png)
9797

98+
### Render
99+
100+
The extension allows you to render a model with the macros resolved. You can invoke it either with the command palette `Render SQLMesh Model` or by clicking the preview button in the top right.
101+
98102
### Editor
99103

100104
The SQLMesh VSCode extension includes several features that make editing SQLMesh models easier and quicker:
@@ -107,7 +111,13 @@ See auto-completion suggestions when writing SQL models, keywords, or model name
107111

108112
**Go to definition and hover information**
109113

110-
Hovering over a model name shows a tooltip with the model description. Clicking the model name opens the file containing the model definition.
114+
Hovering over a model name shows a tooltip with the model description.
115+
116+
In addition to hover information, you can go to a definition of the following objects in a SQL file by either right-clicking and choosing "Go to definition" or by `Command/Control + Click` on the respective reference. This currently works for:
117+
118+
- Model references in a SQL file like `FROM my_model`
119+
- CTE reference in a SQL file like `WITH my_cte AS (...) ... FROM my_cte`
120+
- Python macros in a SQL file like `SELECT @my_macro(...)`
111121

112122
**Diagnostics**
113123

0 commit comments

Comments
 (0)