Skip to content

Commit 47f63e7

Browse files
authored
docs(workspace): add links to SQL Runner (#6618)
1 parent 2daa102 commit 47f63e7

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/content/Workspace/Developer-Playground.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,15 @@ Security Context</Btn>:
7676
You can paste in an existing JWT if desired; or create a brand-new one by
7777
providing a JSON object that represents the decoded JWT.
7878

79+
## Executing generated SQL
80+
81+
To see the SQL generated by a query, click <Btn>Generated SQL</Btn>:
82+
83+
<Screenshot src="https://ucarecdn.com/43011e86-8a0e-414b-a192-3c07a47c2694/" />
84+
85+
If you're using Cube Cloud, you can copy this SQL and run it in your data source
86+
using the [SQL Runner][ref-workspace-sqlrunner].
87+
7988
## Using the Rollup Designer
8089

8190
The Rollup Designer provides an easy way to create and edit
@@ -118,3 +127,4 @@ model. You can then run the query again to see the results:
118127
[ref-preaggs-ref-partitiongranularity]:
119128
/schema/reference/pre-aggregations#parameters-partition-granularity
120129
[ref-preaggs-ref-indexes]: /schema/reference/pre-aggregations#parameters-indexes
130+
[ref-workspace-sqlrunner]: /cloud/sql-runner

docs/content/Workspace/Inspecting-Queries.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,14 @@ pre-aggregation:
113113

114114
<Screenshot src="https://ucarecdn.com/537f7269-654d-479c-a0cc-abc2941f9b5a/" />
115115

116+
You can also run the SQL query directly against your data source using the [SQL
117+
Runner][ref-workspace-sqlrunner] by clicking <Btn>▶️</Btn>:
118+
119+
<Screenshot
120+
highlight="inset(51.5% 2.5% 44% 94% round 10px)"
121+
src="https://ucarecdn.com/537f7269-654d-479c-a0cc-abc2941f9b5a/"
122+
/>
123+
116124
### <--{"id" : "Inspecting API Queries"}--> Pre-Aggregations
117125

118126
The <Btn>Pre-Aggregations</Btn> tab shows the
@@ -186,3 +194,4 @@ while the query is in the query execution queue:
186194
[ref-conf-db]: /config/databases
187195
[ref-deployment-api-instance]: /deployment/overview#api-instances
188196
[ref-deployment-refresh-worker]: /deployment/overview#refresh-worker
197+
[ref-workspace-sqlrunner]: /cloud/sql-runner

0 commit comments

Comments
 (0)