From 1951830b014b956944bd6de3ec59f8f6d091dc23 Mon Sep 17 00:00:00 2001 From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> Date: Fri, 19 Apr 2024 18:28:41 +0100 Subject: [PATCH] Update exports.md 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 --- .../docs/use-dbt-semantic-layer/exports.md | 25 ++++++++++--------- 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/exports.md b/website/docs/docs/use-dbt-semantic-layer/exports.md index 0b363ee990b..884e74b1aa5 100644 --- a/website/docs/docs/use-dbt-semantic-layer/exports.md +++ b/website/docs/docs/use-dbt-semantic-layer/exports.md @@ -69,17 +69,6 @@ saved_queries: ``` -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 @@ -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**