Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update sl ide support #6072

Open
wants to merge 11 commits into
base: current
Choose a base branch
from
Open

update sl ide support #6072

wants to merge 11 commits into from

Conversation

mirnawong1
Copy link
Contributor

this pr updates the SL docs now tht the ide will support SL-related commands.

notion docs project

@mirnawong1 mirnawong1 requested a review from a team as a code owner September 17, 2024 13:27
Copy link

vercel bot commented Sep 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Sep 20, 2024 4:29pm

@github-actions github-actions bot added content Improvements or additions to content guides Knowledge best suited for Guides Docs team Authored by the Docs team @dbt Labs size: medium This change will take up to a week to address and removed Docs team Authored by the Docs team @dbt Labs labels Sep 17, 2024
@github-actions github-actions bot added the Docs team Authored by the Docs team @dbt Labs label Sep 17, 2024
| [`list saved-queries`](#list-saved-queries) | Lists available saved queries. Use the `--show-exports` flag to display each export listed under a saved query. | ✅ | ✅ |
| [`query`](#query) | Query metrics, saved queries, and dimensions you want to see in the command line interface. Refer to [query examples](#query-examples) to help you get started. | ✅ | ✅ |
| [`validate`](#validate) | Validates semantic model configurations. | ✅ | ✅ |
| [`export`](#export) | Runs exports for a singular saved query for testing and generating exports in your development environment. You can also use the `--select` flag to specify particular exports from a saved query. | ❌ | ✅ |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we confirm that the commands below dbt sl export aren't supported in the ide? i tested it today and got some failures for them. however, dbt sl list saved-queries passed:

Screenshot 2024-09-17 at 14 39 09

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dbt sl export is not supported in IDE. The preferred way to run exports is to dbt build, and make sure you have the env var to enable it.

dbt sl query and dbt sl list dimension-values will be supported, it's just not merged in yet.

@@ -54,7 +54,7 @@ Before you're able to run exports in development or production, you'll need to m

There are two ways to run an export:

- [Run exports in development](#exports-in-development) using the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) to test the output before production (You can configure exports in the dbt Cloud IDE, however running them directly in the IDE isn't supported yet).
- [Run exports in development](#exports-in-development) using the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) to test the output before production (You can configure exports in the dbt Cloud IDE, however running them directly in the IDE isn't supported yet). Confirm
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we confirm that exports can only be run in the cloud cli for development?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed!


You can use the `dbt sl` prefix before the command name to execute them in the dbt Cloud CLI. For example, to list all metrics, run `dbt sl list metrics`. For a complete list of the MetricFlow commands and flags, run the `dbt sl --help` command in your terminal.
You can use the `dbt sl` prefix before the command name to execute them in the dbt Cloud IDE or dbt Cloud CLI. For example, to list all metrics, run `dbt sl list metrics`. For a complete list of the MetricFlow commands and flags, run the `dbt sl --help` command in your terminal.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the sad reality is that at the moment dbt --help does not work in IDE due to how they process logs. If you do dbt build --help or dbt sl list metrics --help or any other help command, it will just output nothing...

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth talking to someone from the IDE team if we can get support for that.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now tho, the user's best bet is to refer to the docs.

|---------|-------------|---------------|---------------|
| [`list`](#list) | Retrieves metadata values. | ✅ | ✅ |
| [`list metrics`](#list-metrics) | Lists metrics with dimensions. | ✅ | ✅ |
| [`list saved-queries`](#list-saved-queries) | Lists available saved queries. Use the `--show-exports` flag to display each export listed under a saved query. | ✅ | ✅ |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can also do --show-parameters to show the full query parameters each saved query uses.

| [`list saved-queries`](#list-saved-queries) | Lists available saved queries. Use the `--show-exports` flag to display each export listed under a saved query. | ✅ | ✅ |
| [`query`](#query) | Query metrics, saved queries, and dimensions you want to see in the command line interface. Refer to [query examples](#query-examples) to help you get started. | ✅ | ✅ |
| [`validate`](#validate) | Validates semantic model configurations. | ✅ | ✅ |
| [`export`](#export) | Runs exports for a singular saved query for testing and generating exports in your development environment. You can also use the `--select` flag to specify particular exports from a saved query. | ❌ | ✅ |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dbt sl export is not supported in IDE. The preferred way to run exports is to dbt build, and make sure you have the env var to enable it.

dbt sl query and dbt sl list dimension-values will be supported, it's just not merged in yet.

@@ -54,7 +54,7 @@ Before you're able to run exports in development or production, you'll need to m

There are two ways to run an export:

- [Run exports in development](#exports-in-development) using the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) to test the output before production (You can configure exports in the dbt Cloud IDE, however running them directly in the IDE isn't supported yet).
- [Run exports in development](#exports-in-development) using the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) to test the output before production (You can configure exports in the dbt Cloud IDE, however running them directly in the IDE isn't supported yet). Confirm

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed!

@serramatutu
Copy link

I also forgot to mention, we're adding the support for multiple where clauses in dbt sl query so you can now do like

dbt sl query ... --where "condition1" --where "condition2"

These will be implicitly joined with AND.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs guides Knowledge best suited for Guides size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants