Skip to content

Commit 417009f

Browse files
committed
first draft
1 parent 7c7110f commit 417009f

1 file changed

Lines changed: 24 additions & 3 deletions

File tree

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -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">
14+
<!-- <img src="https://github.com/TobikoData/sqlmesh-public-assets/blob/main/sqlmesh_plan_mode.gif?raw=true" alt="SQLMesh Plan Mode"> -->
15+
TODO: replace with vscode gif in a separate repo link
1516

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)
17+
> Get instant SQL impact analysis of your changes, whether in the CLI or 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/guides/tablediff/?h=data+diff#diffing-multiple-models-across-environments) based on tables/views impacted by a change
123125
124126
<details>
125127
<summary><b>Level Up Your SQL</b></summary>
@@ -141,16 +143,35 @@ 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,web]' # install the sqlmesh package with extensions to work with VS Code
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+
<details>
154+
<summary><b>Windows Powershell Installation</b></summary>
155+
156+
```bash
157+
mkdir sqlmesh-example
158+
cd sqlmesh-example
159+
python -m venv .venv
160+
.\.venv\Scripts\Activate.ps1
161+
pip install 'sqlmesh[lsp,web]' # install the sqlmesh package with extensions to work with VS Code
162+
.\.venv\Scripts\Activate.ps1 # reactivate the venv to ensure you're using the right installation
163+
sqlmesh init duckdb # get started right away with a local duckdb instance
164+
sqlmesh plan # see the plan for the changes you're making
165+
```
166+
</details>
167+
168+
150169
> Note: You may need to run `python3` or `pip3` instead of `python` or `pip`, depending on your python installation.
151170

152171
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!
153172

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

156177
## Join Our Community

0 commit comments

Comments
 (0)