Skip to content

Commit

Permalink
Update exports.md
Browse files Browse the repository at this point in the history
move dbt sl export command to 'run exports' dev section. raised in slack thread here: https://dbt-labs.slack.com/archives/C03KHQRQUBX/p1713545643546209?thread_ts=1713501995.424989&cid=C03KHQRQUBX
  • Loading branch information
mirnawong1 authored Apr 19, 2024
1 parent 6da2bab commit 1951830
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions website/docs/docs/use-dbt-semantic-layer/exports.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,6 @@ saved_queries:
```
</File>
You can use the following parameters to define an `export`:

| Parameters | Type | Required | Description |
| ------- | --------- | ---------- | ---------------- |
| `name` | String | Required | Name of the `export` object. |
| `saved-query` | String | Required | Name of a saved query that could be used. |
| `select` | List or String | Optional | Specify the names of exports to select from the saved query. |
| `exclude` | String | Optional | Specify the names of exports to exclude from the saved query. |
| `export_as` | String | Optional | Type of export to create from the `export_as` types available in the config. Options available are `table` or `view`. |
| `schema` | String | Optional | Schema to use for creating the table or view. |
| `alias` | String | Optional | Table alias to use to write the table or view. |
## Run exports
Expand All @@ -90,12 +79,24 @@ Once you define exports in your dbt project, then you can run them. There are tw
### Exports in development
You can run an export in your development environment using your development credentials if you want to test the output of the export before production. You can use the following command in the dbt Cloud CLI:
You can run an export in your development environment using your development credentials if you want to test the output of the export before production. You can use the following command to run exports in the dbt Cloud CLI:
```bash
dbt sl export
```

The following table lists the options for `dbt sl export` command:

| Parameters | Type | Required | Description |
| ------- | --------- | ---------- | ---------------- |
| `name` | String | Required | Name of the `export` object. |
| `saved-query` | String | Required | Name of a saved query that could be used. |
| `select` | List or String | Optional | Specify the names of exports to select from the saved query. |
| `exclude` | String | Optional | Specify the names of exports to exclude from the saved query. |
| `export_as` | String | Optional | Type of export to create from the `export_as` types available in the config. Options available are `table` or `view`. |
| `schema` | String | Optional | Schema to use for creating the table or view. |
| `alias` | String | Optional | Table alias to use to write the table or view. |

You can also run any export defined for the saved query and write the table or view in your development environment. Refer to the following command example and output:

**Example**
Expand Down

0 comments on commit 1951830

Please sign in to comment.