You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-5Lines changed: 3 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -145,8 +145,7 @@ python -m venv .venv
145
145
source .venv/bin/activate
146
146
pip install 'sqlmesh[lsp]' # install the sqlmesh package with extensions to work with VSCode
147
147
source .venv/bin/activate # reactivate the venv to ensure you're using the right installation
148
-
sqlmesh init duckdb # get started right away with a local duckdb instance
149
-
sqlmesh plan # see the plan for the changes you're making
148
+
sqlmesh init # follow the prompts to get started (choose DuckDB)
150
149
```
151
150
152
151
</details>
@@ -163,13 +162,12 @@ python -m venv .venv
163
162
.\.venv\Scripts\Activate.ps1
164
163
pip install 'sqlmesh[lsp]' # install the sqlmesh package with extensions to work with VSCode
165
164
.\.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
165
+
sqlmesh init # follow the prompts to get started (choose DuckDB)
168
166
```
169
167
</details>
170
168
171
169
172
-
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!
170
+
Follow the [quickstart guide](https://sqlmesh.readthedocs.io/en/stable/quickstart/cli/) to learn how to use SQLMesh. You already have a head start!
173
171
174
172
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.
Copy file name to clipboardExpand all lines: docs/guides/vscode.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -149,6 +149,16 @@ Because the VSCode extension establishes a long-running process connected to the
149
149
150
150
Therefore, we do not recommend using DuckDB as a state store with the VSCode extension.
151
151
152
+
### Environment variables
153
+
154
+
The VSCode extension is based on a [language server](https://en.wikipedia.org/wiki/Language_Server_Protocol) that runs in the background as a separate process. When the VSCode extension starts the background language server, the server inherits environment variables from the environment where you started VSCode. The server does *not* inherit environment variables from your terminal instance in VSCode, so it may not have access to variables you use when calling SQLMesh from the CLI.
155
+
156
+
If you have environment variables that are needed by the context and the language server, you can use one of these approaches to pass variables to the language server:
157
+
158
+
- Open VSCode from a terminal that has the variables set
159
+
- Use environment variables pulled from somewhere else dynamically (e.g. a `.env` file) in your config
160
+
- Set the environment variables in the python environment that the extension uses. You can find detailed instructions [here](https://code.visualstudio.com/docs/python/environments#_environment-variables)
161
+
152
162
### Python environment woes
153
163
154
164
The most common problem is the extension not using the correct Python interpreter.
Copy file name to clipboardExpand all lines: docs/integrations/engines/duckdb.md
+34-1Lines changed: 34 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@
18
18
|`extensions`| Extension to load into duckdb. Only autoloadable extensions are supported. | list | N |
19
19
|`connector_config`| Configuration to pass into the duckdb connector. | dict | N |
20
20
|`secrets`| Configuration for authenticating external sources (e.g., S3) using DuckDB secrets. | dict | N |
21
+
|`filesystems`| Configuration for registering `fsspec` filesystems to the DuckDB connection. | dict | N |
21
22
22
23
#### DuckDB Catalogs Example
23
24
@@ -256,4 +257,36 @@ After configuring the secrets, you can directly reference S3 paths in your catal
256
257
257
258
Refer to the official DuckDB documentation for the full list of [supported S3 secret parameters](https://duckdb.org/docs/stable/extensions/httpfs/s3api.html#overview-of-s3-secret-parameters) and for more information on the [Secrets Manager configuration](https://duckdb.org/docs/configuration/secrets_manager.html).
258
259
259
-
> Note: Loading credentials at runtime using `load_aws_credentials()` or similar deprecated functions may fail when using SQLMesh.
260
+
> Note: Loading credentials at runtime using `load_aws_credentials()` or similar deprecated functions may fail when using SQLMesh.
261
+
262
+
##### File system configuration example for Microsoft Onelake
263
+
264
+
The `filesystems` accepts a list of file systems to register in the DuckDB connection. This is especially useful for Azure Storage Accounts, as it adds write support for DuckDB which is not natively supported by DuckDB (yet).
# anon: False # To use azure.identity.DefaultAzureCredential authentication
289
+
```
290
+
291
+
292
+
Refer to the documentation for `fsspec`[fsspec.filesystem](https://filesystem-spec.readthedocs.io/en/latest/api.html#fsspec.filesystem) and `adlfs`[adlfs.AzureBlobFileSystem](https://fsspec.github.io/adlfs/api/#api-reference) for a full list of storage options.
SQLMesh supports the following execution engines for running SQLMesh projects:
12
+
SQLMesh supports the following execution engines for running SQLMesh projects (engine `type` in parentheses - example usage: `pip install "sqlmesh[databricks]"`):
0 commit comments