Skip to content

Commit

Permalink
Change group-bys to group-by in the tutorial message (#1001)
Browse files Browse the repository at this point in the history
The tutorial message did not reflect the changes made in #642 : replacing --group-bys by --group-by
  • Loading branch information
batou9150 authored Jan 27, 2024
1 parent c4234ea commit fcf0b68
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
6 changes: 6 additions & 0 deletions .changes/unreleased/Docs-20240126-133614.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: Docs
body: change group-bys to group-by in the tutorial message
time: 2024-01-26T13:36:14.490513+01:00
custom:
Author: batou9150
Issue: None
12 changes: 6 additions & 6 deletions metricflow/cli/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,17 @@ def tutorial(ctx: click.core.Context, cfg: CLIContext, msg: bool, clean: bool) -
4. Try validating your data model: `mf validate-configs`
5. Check out your metrics: `mf list metrics`
6. Check out dimensions for your metric `mf list dimensions --metrics transactions`
7. Query your first metric: `mf query --metrics transactions --group-bys metric_time --order metric_time`
7. Query your first metric: `mf query --metrics transactions --group-by metric_time --order metric_time`
8. Show the SQL MetricFlow generates:
`mf query --metrics transactions --group-bys metric_time --order metric_time --explain`
`mf query --metrics transactions --group-by metric_time --order metric_time --explain`
9. Visualize the plan:
`mf query --metrics transactions --group-bys metric_time --order metric_time --explain --display-plans`
`mf query --metrics transactions --group-by metric_time --order metric_time --explain --display-plans`
* This only works if you have graphviz installed - see README.
10. Add another dimension:
`mf query --metrics transactions --group-bys metric_time,customer__customer_country --order metric_time`
`mf query --metrics transactions --group-by metric_time,customer__customer_country --order metric_time`
11. Add a coarser time granularity:
`mf query --metrics transactions --group-bys metric_time__week --order metric_time__week`
12. Try a more complicated query: mf query --metrics transactions,transaction_usd_na --group-bys metric_time,is_large --order metric_time --start-time 2022-03-20 --end-time 2022-04-01.
`mf query --metrics transactions --group-by metric_time__week --order metric_time__week`
12. Try a more complicated query: mf query --metrics transactions,transaction_usd_na --group-by metric_time,is_large --order metric_time --start-time 2022-03-20 --end-time 2022-04-01.
13. When you're done with the tutorial, run mf tutorial --clean to delete sample models and seeds.
"""
)
Expand Down

0 comments on commit fcf0b68

Please sign in to comment.