-
Notifications
You must be signed in to change notification settings - Fork 976
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
oct MF release notes and jdbc #6377
Merged
Merged
Changes from 11 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
4432996
add rn
mirnawong1 b217cb4
update jdbc doc
mirnawong1 f59246e
add rn and jdbc
mirnawong1 bbb78ca
add retro rn
mirnawong1 4674d17
Merge branch 'current' into oct-sl-rn
mirnawong1 0770e4e
update to expandables
mirnawong1 2c5b3db
Update website/docs/docs/dbt-versions/release-notes.md
nataliefiann a91c250
Update website/docs/docs/dbt-cloud-apis/sl-jdbc.md
mirnawong1 f0525e9
Update website/docs/docs/dbt-cloud-apis/sl-jdbc.md
mirnawong1 2f3b438
Update website/docs/docs/dbt-versions/release-notes.md
mirnawong1 6d815c3
Update website/docs/docs/dbt-cloud-apis/sl-jdbc.md
mirnawong1 cdd87c9
Update website/docs/docs/dbt-versions/release-notes.md
mirnawong1 28c306d
Merge branch 'current' into oct-sl-rn
mirnawong1 9e1d436
Update sl-jdbc.md
mirnawong1 26c1201
Update sl-jdbc.md
mirnawong1 5d637b9
Update sl-jdbc.md
mirnawong1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -56,7 +56,7 @@ The Semantic Layer JDBC API has built-in metadata calls which can provide a user | |
|
||
Expand the following toggles for examples and metadata commands: | ||
|
||
<DetailsToggle alt_header="Fetch defined metrics"> | ||
<Expandable alt_header="Fetch defined metrics"> | ||
|
||
You can use this query to fetch all defined metrics in your dbt project: | ||
|
||
|
@@ -65,9 +65,9 @@ select * from {{ | |
semantic_layer.metrics() | ||
}} | ||
``` | ||
</DetailsToggle> | ||
</Expandable> | ||
|
||
<DetailsToggle alt_header="Fetch dimension for a metric"> | ||
<Expandable alt_header="Fetch dimension for a metric"> | ||
|
||
You can use this query to fetch all dimensions for a metric. | ||
|
||
|
@@ -77,9 +77,9 @@ Note, metrics is a required argument that lists one or multiple metrics in it. | |
select * from {{ | ||
semantic_layer.dimensions(metrics=['food_order_amount'])}} | ||
``` | ||
</DetailsToggle> | ||
</Expandable> | ||
|
||
<DetailsToggle alt_header="Fetch dimension values"> | ||
<Expandable alt_header="Fetch dimension values"> | ||
|
||
You can use this query to fetch dimension values for one or multiple metrics and a single dimension. | ||
|
||
|
@@ -89,9 +89,9 @@ Note, metrics is a required argument that lists one or multiple metrics, and a s | |
select * from {{ | ||
semantic_layer.dimension_values(metrics=['food_order_amount'], group_by=['customer__customer_name'])}} | ||
``` | ||
</DetailsToggle> | ||
</Expandable> | ||
|
||
<DetailsToggle alt_header="Fetch granularities for metrics"> | ||
<Expandable alt_header="Fetch granularities for metrics"> | ||
|
||
You can use this query to fetch queryable granularities for a list of metrics. | ||
|
||
|
@@ -103,9 +103,9 @@ select * from {{ | |
semantic_layer.queryable_granularities(metrics=['food_order_amount', 'order_gross_profit'])}} | ||
``` | ||
|
||
</DetailsToggle> | ||
</Expandable> | ||
|
||
<DetailsToggle alt_header="Fetch available metrics given dimensions"> | ||
<Expandable alt_header="Fetch available metrics given dimensions"> | ||
|
||
You can use this query to fetch available metrics given dimensions. This command is essentially the opposite of getting dimensions given a list of metrics. | ||
|
||
|
@@ -117,9 +117,9 @@ select * from {{ | |
}} | ||
``` | ||
|
||
</DetailsToggle> | ||
</Expandable> | ||
|
||
<DetailsToggle alt_header="Fetch granularities for all time dimensions"> | ||
<Expandable alt_header="Fetch granularities for all time dimensions"> | ||
|
||
You can use this example query to fetch available granularities for all time dimensions (the similar queryable granularities API call only returns granularities for the primary time dimensions for metrics). | ||
|
||
|
@@ -133,9 +133,9 @@ select NAME, QUERYABLE_GRANULARITIES from {{ | |
}} | ||
``` | ||
|
||
</DetailsToggle> | ||
</Expandable> | ||
|
||
<DetailsToggle alt_header="Fetch primary time dimension names"> | ||
<Expandable alt_header="Fetch primary time dimension names"> | ||
|
||
It may be useful in your application to expose the names of the time dimensions that represent metric_time or the common thread across all metrics. | ||
|
||
|
@@ -147,9 +147,44 @@ select * from {{ | |
}} | ||
``` | ||
|
||
</DetailsToggle> | ||
</Expandable> | ||
|
||
<Expandable alt_header="Fetch metrics by substring search"> | ||
|
||
You can filter your metrics to include only those that contain a specific substring (sequence of characters contained within a larger string (text)). Use the `search` argument to specify the substring you want to match. | ||
|
||
```sql | ||
select * from {{ semantic_layer.metrics(search='order') }} | ||
``` | ||
|
||
If no substring is provided, the query returns all metrics. | ||
|
||
<DetailsToggle alt_header="List saved queries"> | ||
</Expandable> | ||
|
||
<Expandable alt_header="Paginate metadata calls"> | ||
|
||
In cases where user manifests are large, pagination is a useful way to prevent query character limits in the data platform. You can paginate results for both `semantic_layer.metrics()` and `semantic_layer.dimensions()` calls using the `page_size` and `page_number` parameters. | ||
mirnawong1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- `page_size`: This is an optional feature which sets the number of records per page. If left as `None`, there is no page limit. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Change to --> This is an optional variable which sets the number of records per page. If left as
mirnawong1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- `page_number`: This is another optional feature which specifies the page number to retrieve. Defaults to `1` (first page) if not specified. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as above
mirnawong1 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Examples: | ||
|
||
```sql | ||
-- Retrieves the 5th page with a page size of 10 metrics | ||
select * from {{ semantic_layer.metrics(page_size=10, page_number=5) }} | ||
|
||
-- Retrieves the 1st page with a page size of 10 metrics | ||
select * from {{ semantic_layer.metrics(page_size=10) }} | ||
|
||
-- Retrieves all metrics without pagination | ||
select * from {{ semantic_layer.metrics() }} | ||
``` | ||
|
||
You can use the same pagination parameters for `semantic_layer.dimensions(...)`. | ||
</Expandable> | ||
|
||
<Expandable alt_header="List saved queries"> | ||
|
||
You can use this example query to list all available saved queries in your dbt project. | ||
|
||
|
@@ -165,7 +200,7 @@ select * from semantic_layer.saved_queries() | |
| NAME | DESCRIPTION | LABEL | METRICS | GROUP_BY | WHERE_FILTER | | ||
``` | ||
|
||
</DetailsToggle> | ||
</Expandable> | ||
|
||
<!-- | ||
<Tabs> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"In cases where user manifests are large, pagination is a useful way to prevent query character limits in the data platform. You can paginate results"
Change to: "In the case when you don't want to return the full result set from a metadata call you can paginate the resluts.."