Skip to content

Commit 8670796

Browse files
authored
Update README for VS Code Extension (#4483)
1 parent f4fa53f commit 8670796

1 file changed

Lines changed: 27 additions & 5 deletions

File tree

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<img src="docs/readme/sqlmesh.png" alt="SQLMesh logo" width="50%" height="50%">
33
</p>
44

5-
SQLMesh is a next-generation data transformation framework designed to ship data quickly, efficiently, and without error. Data teams can efficiently run and deploy data transformations written in SQL or Python with visibility and control at any size.
5+
SQLMesh is a next-generation data transformation framework designed to ship data quickly, efficiently, and without error. Data teams can run and deploy data transformations written in SQL or Python with visibility and control at any size.
66

77
It is more than just a [dbt alternative](https://tobikodata.com/reduce_costs_with_cron_and_partitions.html).
88

@@ -11,9 +11,10 @@ It is more than just a [dbt alternative](https://tobikodata.com/reduce_costs_wit
1111
</p>
1212

1313
## Core Features
14-
<img src="https://github.com/TobikoData/sqlmesh-public-assets/blob/main/sqlmesh_plan_mode.gif?raw=true" alt="SQLMesh Plan Mode">
1514

16-
> Get instant SQL impact analysis of your changes, whether in the CLI or in [SQLMesh Plan Mode](https://sqlmesh.readthedocs.io/en/stable/guides/ui/?h=modes#working-with-an-ide)
15+
<img src="https://github.com/TobikoData/sqlmesh-public-assets/blob/main/vscode.gif?raw=true" alt="SQLMesh Plan Mode">
16+
17+
> Get instant SQL impact and context of your changes, both in the CLI and in the [SQLMesh VSCode Extension](https://sqlmesh.readthedocs.io/en/latest/guides/vscode/?h=vs+cod)
1718
1819
<details>
1920
<summary><b>Virtual Data Environments</b></summary>
@@ -120,6 +121,7 @@ outputs:
120121
* Never build a table [more than once](https://tobikodata.com/simplicity-or-efficiency-how-dbt-makes-you-choose.html)
121122
* Track what data’s been modified and run only the necessary transformations for [incremental models](https://tobikodata.com/correctly-loading-incremental-data-at-scale.html)
122123
* Run [unit tests](https://tobikodata.com/we-need-even-greater-expectations.html) for free and configure automated audits
124+
* Run [table diffs](https://sqlmesh.readthedocs.io/en/stable/examples/sqlmesh_cli_crash_course/?h=crash#run-data-diff-against-prod) between prod and dev based on tables/views impacted by a change
123125
124126
<details>
125127
<summary><b>Level Up Your SQL</b></summary>
@@ -131,7 +133,7 @@ Write SQL in any dialect and SQLMesh will transpile it to your target SQL dialec
131133
* Definitions using [simply SQL](https://sqlmesh.readthedocs.io/en/stable/concepts/models/sql_models/#sql-based-definition) (no need for redundant and confusing `Jinja` + `YAML`)
132134
* See impact of changes before you run them in your warehouse with column-level lineage
133135

134-
For more information, check out the [website](https://sqlmesh.com) and [documentation](https://sqlmesh.readthedocs.io/en/stable/).
136+
For more information, check out the [website](https://www.tobikodata.com/sqlmesh) and [documentation](https://sqlmesh.readthedocs.io/en/stable/).
135137

136138
## Getting Started
137139
Install SQLMesh through [pypi](https://pypi.org/project/sqlmesh/) by running:
@@ -141,16 +143,36 @@ mkdir sqlmesh-example
141143
cd sqlmesh-example
142144
python -m venv .venv
143145
source .venv/bin/activate
144-
pip install sqlmesh
146+
pip install 'sqlmesh[lsp]' # install the sqlmesh package with extensions to work with VSCode
145147
source .venv/bin/activate # reactivate the venv to ensure you're using the right installation
146148
sqlmesh init duckdb # get started right away with a local duckdb instance
147149
sqlmesh plan # see the plan for the changes you're making
148150
```
149151

152+
</details>
153+
150154
> Note: You may need to run `python3` or `pip3` instead of `python` or `pip`, depending on your python installation.
151155

156+
<details>
157+
<summary><b>Windows Installation</b></summary>
158+
159+
```bash
160+
mkdir sqlmesh-example
161+
cd sqlmesh-example
162+
python -m venv .venv
163+
.\.venv\Scripts\Activate.ps1
164+
pip install 'sqlmesh[lsp]' # install the sqlmesh package with extensions to work with VSCode
165+
.\.venv\Scripts\Activate.ps1 # reactivate the venv to ensure you're using the right installation
166+
sqlmesh init duckdb # get started right away with a local duckdb instance
167+
sqlmesh plan # see the plan for the changes you're making
168+
```
169+
</details>
170+
171+
152172
Follow the [quickstart guide](https://sqlmesh.readthedocs.io/en/stable/quickstart/cli/#1-create-the-sqlmesh-project) to learn how to use SQLMesh. You already have a head start!
153173

174+
Follow the [crash course](https://sqlmesh.readthedocs.io/en/stable/examples/sqlmesh_cli_crash_course/) to learn the core movesets and use the easy to reference cheat sheet.
175+
154176
Follow this [example](https://sqlmesh.readthedocs.io/en/stable/examples/incremental_time_full_walkthrough/) to learn how to use SQLMesh in a full walkthrough.
155177

156178
## Join Our Community

0 commit comments

Comments
 (0)