From 8459a738c66a50435b35b589bf1baca27369b5bb Mon Sep 17 00:00:00 2001
From: Mirna Wong <89008547+mirnawong1@users.noreply.github.com>
Date: Wed, 30 Oct 2024 17:18:20 +0000
Subject: [PATCH] oct MF release notes and jdbc (#6377)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
this pr adds the oct SL release notes as mentioned in
[linear](https://linear.app/dbt-labs/view/release-note-and-docs-view-07352a33cd9c5),
as well as adds metadata calls for the jdbc doc.
---
🚀 Deployment available! Here are the direct links to the updated files:
-
https://docs-getdbt-com-git-oct-sl-rn-dbt-labs.vercel.app/docs/dbt-cloud-apis/sl-jdbc
-
https://docs-getdbt-com-git-oct-sl-rn-dbt-labs.vercel.app/docs/dbt-versions/release-notes
---------
Co-authored-by: nataliefiann <120089939+nataliefiann@users.noreply.github.com>
---
website/docs/docs/dbt-cloud-apis/sl-jdbc.md | 67 ++++++++++++++-----
.../docs/docs/dbt-versions/release-notes.md | 9 ++-
2 files changed, 59 insertions(+), 17 deletions(-)
diff --git a/website/docs/docs/dbt-cloud-apis/sl-jdbc.md b/website/docs/docs/dbt-cloud-apis/sl-jdbc.md
index 3a9832dd706..9178d1e6592 100644
--- a/website/docs/docs/dbt-cloud-apis/sl-jdbc.md
+++ b/website/docs/docs/dbt-cloud-apis/sl-jdbc.md
@@ -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:
-
+
You can use this query to fetch all defined metrics in your dbt project:
@@ -65,9 +65,9 @@ select * from {{
semantic_layer.metrics()
}}
```
-
+
-
+
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'])}}
```
-
+
-
+
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'])}}
```
-
+
-
+
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'])}}
```
-
+
-
+
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 {{
}}
```
-
+
-
+
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 {{
}}
```
-
+
-
+
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 {{
}}
```
-
+
+
+
+
+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.
-
+
+
+
+
+In the case when you don't want to return the full result set from a metadata call, you can paginate the results for both `semantic_layer.metrics()` and `semantic_layer.dimensions()` calls using the `page_size` and `page_number` parameters.
+
+- `page_size`: This is an optional variable which sets the number of records per page. If left as None, there is no page limit.
+- `page_number`: This is an optional variable which specifies the page number to retrieve. Defaults to `1` (first page) if not specified.
+
+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(...)`.
+
+
+
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 |
```
-
+