Skip to content

Commit

Permalink
Update sl-jdbc.md
Browse files Browse the repository at this point in the history
We made a non-breaking change to switch EXPLAIN to COMPILE. Explain will still work but we want to discourage it. Changing references to compile so at least net new people will use that and see it in the document.
  • Loading branch information
rpourzand authored Sep 26, 2023
1 parent 8e1a7d5 commit 28d2395
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions website/docs/docs/dbt-cloud-apis/sl-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ To query metric values, here are the following parameters that are available:
| `where` | A where clause that allows you to filter on dimensions and entities using parameters - comes with `TimeDimension`, `Dimension`, and `Entity` objects. Granularity is required with `TimeDimension` | `"{{ where=Dimension('customer__country') }} = 'US')"` | Optional |
| `limit` | Limit the data returned | `limit=10` | Optional |
|`order` | Order the data returned | `order_by=['-order_gross_profit']` (remove `-` for ascending order) | Optional |
| `explain` | If true, returns generated SQL for the data platform but does not execute | `explain=True` | Optional |
| `compile` | If true, returns generated SQL for the data platform but does not execute | `compile=True` | Optional |
## Note on time dimensions and `metric_time`
Expand Down Expand Up @@ -285,15 +285,15 @@ semantic_layer.query(metrics=['food_order_amount', 'order_gross_profit'],
order_by=['order_gross_profit'])
}}
```
### Query with explain keyword
### Query with compile keyword
Use the following example to query using a `explain` keyword:
Use the following example to query using a `compile` keyword:
```bash
select * from {{
semantic_layer.query(metrics=['food_order_amount', 'order_gross_profit'],
group_by=[Dimension('metric_time').grain('month'),'customer__customer_type'],
explain=True)
compile=True)
}}
```
Expand Down

0 comments on commit 28d2395

Please sign in to comment.