Skip to content

Commit

Permalink
Docs: update CLI reference with new command options (#3754)
Browse files Browse the repository at this point in the history
  • Loading branch information
treysp committed Jan 31, 2025
1 parent e0d65a3 commit ee7c6b2
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Commands:
create_test Generate a unit test fixture for a given model.
dag Render the DAG as an html file.
diff Show the diff between the local state and the...
dlt_refresh Attaches to a DLT pipeline with the option to...
evaluate Evaluate a model and return a dataframe with a...
fetchdf Run a SQL query and display the results.
format Format all SQL models and audits.
Expand Down Expand Up @@ -131,6 +132,7 @@ Usage: dlt_refresh PIPELINE [OPTIONS]
Options:
-t, --table TEXT The DLT tables to generate SQLMesh models from. When none specified, all new missing tables will be generated.
-f, --force If set it will overwrite existing models with the new generated models from the DLT tables.
--help Show this message and exit.
```

## diff
Expand Down Expand Up @@ -215,6 +217,7 @@ Usage: sqlmesh info [OPTIONS]
Options:
--skip-connection Skip the connection test.
-v, --verbose Verbose output.
--help Show this message and exit.
```

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

Expand Down Expand Up @@ -275,7 +278,9 @@ Options:
--help Show this message and exit.
```

**Caution**: this command affects all SQLMesh users. Contact your SQLMesh administrator before running.
!!! danger "Caution"

The `migrate` command affects all SQLMesh users. Contact your SQLMesh administrator before running.

## plan

Expand Down Expand Up @@ -335,7 +340,8 @@ Options:
application (prod environment only).
--enable-preview Enable preview for forward-only models when
targeting a development environment.
--diff-rendered Output text differences for the rendered versions of models and standalone audits
--diff-rendered Output text differences for rendered versions
of models and standalone audits
-v, --verbose Verbose output.
--help Show this message and exit.
```
Expand Down Expand Up @@ -406,7 +412,9 @@ Options:
--help Show this message and exit.
```

**Caution**: this command affects all SQLMesh users. Contact your SQLMesh administrator before running.
!!! danger "Caution"

The `rollback` command affects all SQLMesh users. Contact your SQLMesh administrator before running.

## run

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

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

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

0 comments on commit ee7c6b2

Please sign in to comment.