Skip to content

Commit 64de41a

Browse files
authored
Docs: update CLI reference with new command options (#3754)
1 parent a01a455 commit 64de41a

1 file changed

Lines changed: 20 additions & 5 deletions

File tree

docs/reference/cli.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Commands:
2424
create_test Generate a unit test fixture for a given model.
2525
dag Render the DAG as an html file.
2626
diff Show the diff between the local state and the...
27+
dlt_refresh Attaches to a DLT pipeline with the option to...
2728
evaluate Evaluate a model and return a dataframe with a...
2829
fetchdf Run a SQL query and display the results.
2930
format Format all SQL models and audits.
@@ -131,6 +132,7 @@ Usage: dlt_refresh PIPELINE [OPTIONS]
131132
Options:
132133
-t, --table TEXT The DLT tables to generate SQLMesh models from. When none specified, all new missing tables will be generated.
133134
-f, --force If set it will overwrite existing models with the new generated models from the DLT tables.
135+
--help Show this message and exit.
134136
```
135137

136138
## diff
@@ -215,6 +217,7 @@ Usage: sqlmesh info [OPTIONS]
215217
216218
Options:
217219
--skip-connection Skip the connection test.
220+
-v, --verbose Verbose output.
218221
--help Show this message and exit.
219222
```
220223

@@ -229,7 +232,7 @@ Options:
229232
-t, --template TEXT Project template. Supported values: airflow, dbt,
230233
dlt, default, empty.
231234
--dlt-pipeline TEXT DLT pipeline for which to generate a SQLMesh project.
232-
This option is supported if the template is dlt.
235+
For use with dlt template.
233236
--help Show this message and exit.
234237
```
235238

@@ -275,7 +278,9 @@ Options:
275278
--help Show this message and exit.
276279
```
277280

278-
**Caution**: this command affects all SQLMesh users. Contact your SQLMesh administrator before running.
281+
!!! danger "Caution"
282+
283+
The `migrate` command affects all SQLMesh users. Contact your SQLMesh administrator before running.
279284

280285
## plan
281286

@@ -335,7 +340,8 @@ Options:
335340
application (prod environment only).
336341
--enable-preview Enable preview for forward-only models when
337342
targeting a development environment.
338-
--diff-rendered Output text differences for the rendered versions of models and standalone audits
343+
--diff-rendered Output text differences for rendered versions
344+
of models and standalone audits
339345
-v, --verbose Verbose output.
340346
--help Show this message and exit.
341347
```
@@ -406,7 +412,9 @@ Options:
406412
--help Show this message and exit.
407413
```
408414

409-
**Caution**: this command affects all SQLMesh users. Contact your SQLMesh administrator before running.
415+
!!! danger "Caution"
416+
417+
The `rollback` command affects all SQLMesh users. Contact your SQLMesh administrator before running.
410418

411419
## run
412420

@@ -428,6 +436,10 @@ Options:
428436
--exit-on-env-update INTEGER If set, the command will exit with the
429437
specified code if the run is interrupted by an
430438
update to the target environment.
439+
--no-auto-upstream Do not automatically include upstream models.
440+
Only applicable when --select-model is used.
441+
Note: this may result in missing / invalid
442+
data for the selected models.
431443
--help Show this message and exit.
432444
```
433445

@@ -452,6 +464,9 @@ Options:
452464
floating point columns. Default: 3
453465
--skip-grain-check Disable the check for a primary key (grain) that is
454466
missing or is not unique.
467+
--temp-schema TEXT Schema used for temporary tables. It can be
468+
`CATALOG.SCHEMA` or `SCHEMA`. Default:
469+
`sqlmesh_temp`
455470
--help Show this message and exit.
456471
```
457472

@@ -493,6 +508,6 @@ Usage: sqlmesh ui [OPTIONS]
493508
Options:
494509
--host TEXT Bind socket to this host. Default: 127.0.0.1
495510
--port INTEGER Bind socket to this port. Default: 8000
496-
--mode [ide|default|docs|plan] Mode to start the UI in. Default: default
511+
--mode [ide|catalog|docs|plan] Mode to start the UI in. Default: ide
497512
--help Show this message and exit.
498513
```

0 commit comments

Comments
 (0)