Merge pull request #105 from dpguthrie/feat/add-fields

Add requiresMetricTime field
dpguthrie · May 27, 2024 · e4bbe37 · e4bbe37
2 parents 21dcee9 + 548ab64
commit e4bbe37
Show file tree

Hide file tree

Showing 2 changed files with 76 additions and 75 deletions.
diff --git a/dbtc/client/semantic_layer.py b/dbtc/client/semantic_layer.py
@@ -68,101 +68,102 @@ class _SemanticLayerClient(_Client):
 query GetMetrics($environmentId: BigInt!) {
     metrics(environmentId: $environmentId) {
         description
+        requiresMetricTime
         measures {
-        agg
-        aggTimeDimension
-        expr
-        name
+            agg
+            aggTimeDimension
+            expr
+            name
         }
         entities {
-        description
-        expr
-        name
-        role
-        type
+            description
+            expr
+            name
+            role
+            type
         }
         filter {
-        whereSqlTemplate
+            whereSqlTemplate
         }
         label
         name
         queryableGranularities
         type
         typeParams {
-        denominator {
-            alias
-            filter {
-            whereSqlTemplate
+            denominator {
+                alias
+                filter {
+                    whereSqlTemplate
+                }
+                name
+                offsetToGrain
+                offsetWindow {
+                    count
+                    granularity
+                }
             }
-            name
-            offsetToGrain
-            offsetWindow {
-            count
-            granularity
-            }
-        }
-        expr
-        grainToDate
-        inputMeasures {
-            alias
-            filter {
-            whereSqlTemplate
+            expr
+            grainToDate
+            inputMeasures {
+                alias
+                filter {
+                    whereSqlTemplate
+                }
+                name
             }
-            name
-        }
-        measure {
-            alias
-            filter {
-            whereSqlTemplate
-            }
-            name
-        }
-        metrics {
-            alias
-            filter {
-            whereSqlTemplate
+            measure {
+                alias
+                filter {
+                    whereSqlTemplate
+                }
+                name
             }
-            name
-            offsetToGrain
-            offsetWindow {
-            count
-            granularity
+            metrics {
+                alias
+                filter {
+                    whereSqlTemplate
+                }
+                name
+                offsetToGrain
+                offsetWindow {
+                    count
+                    granularity
+                }
             }
-        }
-        numerator {
-            alias
-            filter {
-            whereSqlTemplate
+            numerator {
+                alias
+                filter {
+                    whereSqlTemplate
+                }
+                name
+                offsetToGrain
+                offsetWindow {
+                    count
+                    granularity
+                }
             }
-            name
-            offsetToGrain
-            offsetWindow {
-            count
-            granularity
+            window {
+                count
+                granularity
             }
         }
-        window {
-            count
-            granularity
-        }
-        }
         dimensions {
-        description
-        expr
-        isPartition
-        label
-        name
-        qualifiedName
-        queryableGranularities
-        type
-        typeParams {
-            timeGranularity
-            validityParams {
-            isEnd
-            isStart
+            description
+            expr
+            isPartition
+            label
+            name
+            qualifiedName
+            queryableGranularities
+            type
+            typeParams {
+                timeGranularity
+                validityParams {
+                    isEnd
+                    isStart
+                }
             }
         }
-        }
     }
 }
         """,

diff --git a/docs/guide/semantic_layer.md b/docs/guide/semantic_layer.md
@@ -128,7 +128,7 @@ client = dbtCloudClient(environment_id=1, host="emea.dbt.com")
     Assuming that `client` is an instance of `dbtCloudClient`
     ```py
     query_result = client.sl.query(
-        metrics=["]
+        metrics=["total_revenue", "total_profit"],
         group_by=["customer__region"],
     )